Get File Content

LAST UPDATED: AUG 07, 2024

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

Implementation	System
Command Category	System Utility
Tags	ARTIFACT FILE

Inputs

Parameter Name	Required/Optional	Description	Sample Data
File Id	Required	Id of the file to get content	1
File Source	Required	Source of the file	Playbook File

Output

Return Data

The returned result of this command. If some required parameters are not defined, this returned data could be empty. The returned result can be passed down directly to a subsequent command in playbooks.

SAMPLE DATA

JSON

"test\r\ntest1,\r\n"

Remote Command API

The D3 command API allows you to send requests to D3 SOAR to execute this utility command via REST API.

Request

POST

CODE

https:/{base_url}/{api_namespace}/api/Command/getFileContent

Headers

Please refer to the page Webhook Configuration Guide - Authentication Method: API Keys for more details.

Request Body

JSON

{
  "Username": <Username here>,
  "Site": <Site here>,
  "CommandParams": {
    "File Id": <Id of the file to get content>,
    "File Source": <Source of the file>
  }
}

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`	Required	Id of the file to get content
File Source	`string`	Required	Source of the file

Sample Request

SAMPLE DATA

JSON

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

Response

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 Response

JSON

{
    "error": "",
    "returnData": ""test\r\ntest1,\r\n""
}