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
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
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
{
"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 |
| Required | The username of your D3 SOAR account. |
Site |
| Required | The D3 SOAR site to run the remote command. |
File Id |
| Required | Id of the file to get content |
File Source |
| Required | Source of the file |
Sample Request
SAMPLE DATA
{
"Username": "Admin",
"Site": "Security Operations",
"CommandParams": {
"File Id": 1,
"File Source": "Playbook File"
}
}
Response
Response Fields
Field Name | Type | Description |
---|---|---|
error |
| The error message if the API request has failed. |
returnData |
| The return data from the API request. |
Sample Response
{
"error": "",
"returnData": ""test\r\ntest1,\r\n""
}