Skip to main content
Skip table of contents

Get Linked Incidents Of An Incident‎

POST /Command/GetLinkedIncidentsOfAnIncident

This command is specifically designed to recursively retrieve all incidents associated with the current incident, including those linked to subsequent incidents. The maximum recursive depth has been set at a value of 10. The result will include the initial incident.

READER NOTE

This API endpoint is available from version 16.9 onwards. If the API endpoint is unavailable, please contact D3 for assistance.

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 Number

string

Required

The incident number for which the linked incidents will be retrieved.

Body Sample Data

application/json
CODE
{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
  "Incident Number": "20211015-2"
  }
}

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.

CODE
{
    "error": "",
    "returnData": {
        "Status": "Successful",
        "Data": [
            "20211015-2",
            "20211015-3",
            "20211027-4",
            "20211027-8",
            "20211027-9",
            "20230914-3"
        ]
    }
}

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.