Remove Incident Attachment

LAST UPDATED: SEPT 04, 2024

Removes either the the selected files or all files from an incident.

Implementation	System
Command Category	System Utility
Tags	INCIDENT INCIDENT ATTACHMENT

Inputs

Parameter Name	Required/Optional	Description	Sample Data
Incident Numbers	Optional	The array of incident numbers corresponding to the incidents whose files will be removed.	CODE `[ "20220111-1", "20220111-2", "20220111-3" ]`
File Ids	Optional	An array of attachment file IDs specifying which files to remove.	CODE `[ 1153, 1154, 1155 ]`
File Names	Optional	An array of attachment file names specifying which files to remove.	CODE `[ "test01.png", "test02.png", "test03.png" ]`

ALERT

Leaving both the File Ids and File Names fields empty when running this command will result in the removal of all files.

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

Successful

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/RemoveIncidentAttachment

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": {
    "Incident Numbers": "<Incident Numbers here>",
    "File Ids": "<File Ids here>",
    "File Names": "<File Names here>"
  }
}

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.
Incident Numbers	`array<string>`	Required	The array of incident numbers corresponding to the incidents whose files will be removed.
File Ids	`array<integer>`	Optional	An array of attachment file IDs specifying which files to remove.
File Names	`array<string>`	Optional	An array of attachment file names specifying which files to remove.

Sample Request

SAMPLE DATA

JSON

{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "Incident Numbers": [
      "20220111-1",
      "20220111-2",
      "20220111-3"
    ],
    "File Ids": [
      1153,
      1154,
      1155
    ],
    "File Names": [
      "test01.png",
      "test02.png",
      "test03.png"
    ]
  }
}

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": "Successful"
}