Publish Live Playbooks across Sites

This command is designed to publish a live playbook to multiple sites within the D3 Application or withdraw live playbooks from multiple sites.

Implementation	System
Command Category	System Utility
Tags	PLAYBOOK

Inputs

Parameter Name	Required/Optional	Description	Sample Data
Playbook Name	Required	The name of Playbook	`test`
Site List	Required	The name of the site list	CODE `[ "Security Operations" ]`
Action	Optional	Action type of publish playbook	`Add`

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

{
    "Status": "Successful", 
    "Data": { "Current Shared Sites":[Site1, Site2]}
}

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

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 Name": <Playbook Name here>,
    "Site List": <Site List here>,
    "Action": <Action here>
  }
}

Body Parameters

Parameter Name	Type	Required/Optional	Description
Username	`Text`	Required	The username of your D3 SOAR account.
Site	`Text`	Required	The D3 SOAR site to run the remote command.
Playbook Name	`Text`	Required	The name of Playbook
Site Lis	`Text`	Required	The name of the site list
Action	`Text`	Optional	Action type of publish playbook

Sample Request

SAMPLE DATA

JSON

{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "Playbook Name": "test",
    "Site List": [
      "Security Operations"
    ],
    "Action": "Add"
  }
}

Response

Response Fields

Field Name	Type	Description
error	`text`	The error message if the API request has failed.
returnData	`text`	The return data from the API request.

Sample Response

JSON

{
    "error": "",
    "returnData": {
        "Status": "Successful", 
        "Data": { "Current Shared Sites":[Site1, Site2]}
    }
}