Skip to main content
Skip table of contents

Remove Incident Attachment‎

POST /Command/RemoveIncidentAttachment

Remove File Attachments From Incidents.

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.

Incident Numbers

array<string>

Required

The string array of incident number.

File Ids

array<integer>

Optional

The integer array of Attachment file id.

File Names

array<string>

Optional

The string array of Attachment file name.

Body Sample Data

application/json
CODE
{
  "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

200 OK

application/json

Field Name

Type

Description

error

string

The error message if the API request has failed.

returnData

string

The return data from the API request.

CODE
{
    "error": "",
    "returnData": "Successful"
}

401 Unauthorized

application/json

Response Fields

Field Name

Type

Description

Error

string

A error message when the API request fails.

Sample Data

CODE
{"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

CODE
{"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

CODE
{"Error": "Unexpected Error."}
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.