Get File Content‎ | docs.d3security

POST /Command/getFileContent

Get file content based on file id and source. The command support files with .html, .txt, .csv, .xls, .xlsx, .msg, .eml, .json extensions.

Request

Authentication: API keys or JSON web tokens (JWT)

Body Parameters

Parameter Name	Type	Required/Optional	Description
Username	`string`	Required	The username of your D3 SOAR account.
Site	`string`	Required	The D3 SOAR site to run the remote command.
File Id	`integer`	Optional	Id of the file to get content
File Source	`string`	Optional	Source of the file {“Playbook File“, “Artifact File“, “Incident Attachment File“}

Body Sample Data

application/json

JSON

{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "File Id": 1,
    "File Source": "Playbook File"
  }
}

Response

200 OK

application/json

Response Fields

Field Name	Type	Description
error	`string`	The error message if the API request has failed.
returnData	`string`	The return data from the API request.

Sample Data

JSON

{
    "error": "Only files with extenstion CSV, HTML, EML, TXT, MSG, XLSX, XLS or JSON are allowed",
    "returnData": "Failed",
    "rawData": "",
    "contextData": "",
    "outputData": ""
}

400 BadRequest

application/json

Response Fields

Field Name	Type	Description
Error	`string`	A error message when the API request fails.

Sample Data

JSON

{"Error": "The body of the request must be a valid JSON object"}

401 Unauthorized

application/json

Response Fields

Field Name	Type	Description
Error	`string`	A error message when the API request fails.

Sample Data

JSON

{"Error": "Invalid authentication key."}

429 TooManyRequests

application/json

Response Fields

Field Name	Type	Description
Error	`string`	A error message when the API request fails.

Sample Data

JSON

{"Error": "The request exceeds rate limits or is otherwise blocked by rate limiting policies."}

500 InternalServerError

application/json

Response Fields

Field Name	Type	Description
Error	`string`	A error message when the API request fails.

Sample Data

JSON

{"Error": "Unexpected Error."}