Delete Incident

This command allows users to remove specific closed incident records from the system. After deleting incidents, users can utilize the ''Get D3 Log'' utility command to view the deleted incident information.

Reader Note

Please note that this command is not publicly available. To request access, please contact D3 support.

Implementation	System
Command Category	System Utility
Tags	INCIDENT

Inputs

Parameter Name	Required/Optional	Description	Sample Data
IncidentNumbers	Required	Contains the List of incident numbers to be deleted.	["Inv-4-20240113","Inv-5-20240113"]
Notes	Required	Notes for deleting the incidents.	Delete for test

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

CODE

{
    "Status": "Partially Successful",

    "Data": [

        "Inv-4-20240113"
    ],

    "ErrorData": [
        {
            "incidentnumber": "Inv-5-20240113",
            "error": "The Incident Number does not exit!"
        }
    ]
}

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

Headers

Please refer to the page Webhook Configuration Guide - Authentication Method: API Keys for more details.

Request Body

CODE

{

  "Username": <Username here>,

  "Site": <Site here>,

 

"CommandParams": {

    "Incident Numbers": [

     <Incident Numbers here>

    ],

    "Notes": <Notes 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	`Text Array`	Required	Incident Numbers to be deleted
Notes	`String`	Required	Notes for deleting the incidents.

Sample Request

SAMPLE DATA

CODE

{

  "Username": "Admin",

  "Site": "Security Operations",

  "CommandParams": {

    "Incident Numbers": [

      "Inv-4-20240113",

      "Inv-5-20240113"

    ],

    "Notes": "Delete for test"

  }

  }

}

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

CODE

{

    "error": "",

    "returnData": {

        "Status": "Successful",

        "Data": [

            "Inv-4-20240113"

        ]

    }

}