Add Playbook to Incidents

Add a playbook to multiple incidents.

Implementation	System
Command Category	System Utility
Tags	INCIDENT

Inputs

Parameter Name	Required/Optional	Description	Sample Data
Incident Numbers	Required	The array of incident numbers of incidents to which the playbook will be added.	`[20210202-26,20210202-25]`
Playbook	Optional	The name of playbook that to be added to the incidents.	`SearchCloseIncident`
Additional Playbooks	Optional	The name of additional playbooks that to be added to the incidents (Input is optional).	CODE `[ "Simple Playbook Sample" ]`
Username	Optional	The username of user who adds the playbook to incidents. This username will be used only when the task is run automatically.	`admin user`

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

Successful

Context Data

The response data from the utility command.

SAMPLE DATA

JSON

[
    {
        "Incident Number": "20210202-26",
        "Playbook List": [
            {
                "Playbook": "Simple Playbook Sample",
                "User": "admin user"
            },
            {
                "Playbook": "SearchCloseIncident",
                "User": "admin user"
            }
        ],
        "Result": "Successful"
    },
    {
        "Incident Number": "20210202-25",
        "Playbook List": [
            {
                "Playbook": "UpdateOwner",
                "User": "admin user"
            },
            {
                "Playbook": "Simple Playbook Sample",
                "User": "admin user"
            },
            {
                "Playbook": "SearchCloseIncident",
                "User": "admin user"
            }
        ],
        "Result": "Successful"
    }
]

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

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 Numbers": "<Incident Numbers here>",
    "Playbook": "<Playbook here>",
    "Additional Playbooks": "<Additional Playbooks here>",
    "Username": "<Username 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	The array of incident numbers of incidents to which the playbook will be added.
Playbook	`Text`	Optional	The name of playbook that to be added to the incidents.
Additional Playbooks	`Text Array`	Optional	The name of additional playbooks that to be added to the incidents (Input is optional).
Username	`Text`	Optional	The username of user who adds the playbook to incidents. This username will be used only when the task is run automatically.

Sample Request

SAMPLE DATA

JSON

{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "Incident Numbers": "[20210202-26,20210202-25]",
    "Playbook": "SearchCloseIncident",
    "Additional Playbooks": [
      "Simple Playbook Sample"
    ],
    "Username": "admin user"
  }
}

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 Array`	The context data from the API request.

Sample Response

JSON

{
    "error": "",
    "returnData": "Successful",
    "contextData": "[
    {
        "Incident Number": "20210202-26",
        "Playbook List": [
            {
                "Playbook": "Simple Playbook Sample",
                "User": "admin user"
            },
            {
                "Playbook": "SearchCloseIncident",
                "User": "admin user"
            }
        ],
        "Result": "Successful"
    },
    {
        "Incident Number": "20210202-25",
        "Playbook List": [
            {
                "Playbook": "UpdateOwner",
                "User": "admin user"
            },
            {
                "Playbook": "Simple Playbook Sample",
                "User": "admin user"
            },
            {
                "Playbook": "SearchCloseIncident",
                "User": "admin user"
            }
        ],
        "Result": "Successful"
    }
  ]"
}