Publish Live Playbooks across Sites

Last updated: Aug 13, 2024

Publishes the playbook to the specified sites, unpublishes it from them, or replaces the previous site associations with the new ones.

Implementation	System
Command Category	System Utility
Tags	Playbook

Inputs

Parameter Name	Required/Optional	Description	Sample Data
Playbook Name	Required	The name of playbook.	demoPlaybook
Site List	Required	The site(s) to which the playbook will be published, from which it will be removed, or with which its previous associations will be replaced.	[ "demoSite1", "demoSite2" ]
Action	Optional	The action to be performed in regards to playbook’s relation to sites. Options include: Add: Publish the playbook to the specified sites. If already published, no action is taken. Remove: Remove the playbook from the specified sites. If already unpublished, no action is taken. Overwrite: Unpublish the playbook from the current sites, then publish it to the specified sites.	Add

Parameter Name

Required/Optional

Description

Sample Data

Playbook Name

Required

The name of playbook.

demoPlaybook

Site List

Required

The site(s) to which the playbook will be published, from which it will be removed, or with which its previous associations will be replaced.

[

"demoSite1",

"demoSite2"

]

Action

Optional

The action to be performed in regards to playbook’s relation to sites. Options include:

Add: Publish the playbook to the specified sites. If already published, no action is taken.
Remove: Remove the playbook from the specified sites. If already unpublished, no action is taken.
Overwrite: Unpublish the playbook from the current sites, then publish it to the specified sites.

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": [
            "Security Operations",
            "demoSite1",
            "demoSite2"
        ]
    }
}

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

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	`string`	Required	The username of your D3 SOAR account.
Site	`string`	Required	The D3 SOAR site to run the remote command.
Playbook Name	`string`	Required	The name of playbook.
Site List	`array<string>`	Required	The site(s) to which the playbook will be published, from which it will be removed, or with which its previous associations will be replaced.
Action	`string`	Required	The action to be performed in regards to playbook’s relation to sites. Options include: Add: Publish the playbook to the specified sites. If already published, no action is taken. Remove: Remove the playbook from the specified sites. If already unpublished, no action is taken. Overwrite: Unpublish the playbook from the current sites, then publish it to the specified sites.

Sample Request

Sample Data

JSON

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

Response

Response Fields

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

Sample Response

JSON

{
    "error": "",
    "returnData": {
        "Status": "Successful",
        "Data": {
            "Current Shared Sites": [
                "Security Operations",
                "demoSite1",
                "demoSite2"
            ]
        }
    }
}