Run Playbooks

LAST UPDATED: SEPT 04, 2024

Adds playbooks to incidents.

Implementation	System
Command Category	System Utility
Tags	INCIDENT RUN PLAYBOOK

Inputs

Parameter Name	Required/Optional	Description	Sample Data
Playbook Names	Optional	The playbook names.	CODE `[ "runPlaybookComand1" ]`
Incident Numbers	Optional	The incident numbers used to run playbooks.	CODE `[ "20220725-12" ]`

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": "20220725-12",
        "Playbook List": [
            "runPlaybookComand1"
        ],
        "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/RunPlaybooks

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": {
    "Playbook Names": "<Playbook Names here>",
    "Incident Numbers": "<Incident Numbers 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.
Playbook Names	`array<string>`	Optional	The playbook names.
Incident Numbers	`array<string>`	Optional	The incident numbers used to run playbooks.

Sample Request

SAMPLE DATA

JSON

{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "Playbook Names": [
      "runPlaybookComand1"
    ],
    "Incident Numbers": [
      "20220725-12"
    ]
  }
}

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.
contextData	`array<JSON Object>`	The context data from the API request.

Sample Response

JSON

{
    "error": "",
    "returnData": "Successful",
    "contextData": [
      {
          "Incident Number": "20220725-12",
          "Playbook List": [
              "runPlaybookComand1"
          ],
          "Result": "Successful"
      }
    ]
}