Get Linked Incidents Of An Incident
LAST UPDATED: SEPT 09, 2024
Retrieves incidents that are linked to the specified incident, including those connected through a chain of linked incidents, and excluding duplicates. The command follows a maximum recursion depth of 10. If the chain of linked incidents exceeds this depth, only incidents up to the maximum depth will be returned.
For example, if the chain is A → B → C → ... → L, where A → B is at depth 1 and L exceeds the maximum depth, the command will include only incidents A through K in the results.
READER NOTE
If you are not currently using version 16.9, you may encounter limitations in accessing this command. Kindly reach out to D3 for assistance in obtaining access if such a situation arises.
Implementation | Python |
Command Category | System Utility |
Tags | INCIDENT INCIDENT LINKING |
Inputs
Parameter Name | Required/Optional | Description | Sample Data |
---|---|---|---|
Incident Number | Required | The incident number corresponding to an incident for which linked incidents will be retrieved. | 20211015-2 |
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/GetLinkedIncidentsOfAnIncident
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": {
"Incident Number": <Incident Number here>
}
}
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. |
Incident Number |
| Required | The incident number corresponding to an incident for which linked incidents will be retrieved. |
Sample Request
SAMPLE DATA
{
"Username": "Admin",
"Site": "Security Operations",
"CommandParams": {
"Incident Number": "20211015-2"
}
}
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": {
"Status": "Successful",
"Data": [
"20211015-2",
"20211015-3",
"20211027-4",
"20211027-8",
"20211027-9",
"20230914-3"
]
}
}