Close Incident

Adds a note under an incident and closes it.

Reader Note

Please note that this command is only applicable within an incident Playbook.

Implementation	System
Command Category	System Utility
Tags	N/A

Inputs

Parameter Name	Required/Optional	Description	Sample Data
Incident Note	Optional	The Note for an incident when it is closing.	`This incident is finished and closed by Tom`

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

JSON

Succeed

Context Data

The response data from the utility command.

SAMPLE DATA

JSON

{
    "incidentNumber": "20200526-23",
    "closeType": "Closed",
    "closeNote": "This incident is finished and closed by Tom",
    "closeDate": "May 26, 2020 17:07 China Standard Time",
    "result": "Succeed",
    "closedBy": "admin user"
}

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

Headers

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

Request Body

JSON

{
  "Username": "<Username here>",
  "Site": "<Site here>",
  "CommandParams": {
    "Incident Note": "<Incident Note 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 Note	`Text`	Optional	The Note for an incident when it is closing.

Sample Request

SAMPLE DATA

JSON

{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "Incident Note": "This incident is finished and closed by Tom"
  }
}

Response

Response Fields

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

Sample Response

JSON

{
    "error": "",
    "returnData": "Succeed",
    "contextData": "{
    "incidentNumber": "20200526-23",
    "closeType": "Closed",
    "closeNote": "This incident is finished and closed by Tom",
    "closeDate": "May 26, 2020 17:07 China Standard Time",
    "result": "Succeed",
    "closedBy": "admin user"
  }"
}