Remove Linked Incidents‎ | docs.d3security

POST /Command/RemoveLinkedIncidents

Remove Linked Incident(s) from the Source Incident.

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.
Linked Incident Numbers to be Removed	`array<string>`	Required	A list of incident numbers of existing incidents that will be removed from the source incident.
Source Incident Number	`string`	Required	Source Incident Number which the incident link is deleted. Default to the current incident of the playbook if left blank.

Body Sample Data

application/json

{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "Linked Incident Numbers to be Removed": [
      "20210127-198",
      "20210127-197"
    ],
    "Source Incident Number": "20231025-130"
  }
}

Response

200 OK

application/json

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

{
    "error": "",
    "returnData": {
      "Status": "Partially Successful",
      "Data": {
          "Current linked Incident(s) of Incident 20231025-130 ": [
              "20231025-131"
          ]
      },
      "ErrorData": [
          {
              "Incident Number": "20210127-198",
              "Error message": "The source incident is not linked to this incident."
          }
      ]
    }
}

401 Unauthorized

application/json

Response Fields

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

Sample Data

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

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

{"Error": "Unexpected Error."}