PublishPlaybook

LAST UPDATED: AUG 13, 2024

Publishes the available playbooks in the master instance to all sites within a tenant.

READER NOTE

This command can only publish incident playbooks.

Implementation	System
Command Category	System Utility
Tags	PLAYBOOK MULTITENANCY

Inputs

Parameter Name	Required/Optional	Description	Sample Data
Tenant Region	Required	The region of the tenant.	AMER
Tenant Name	Required	The name of the tenant.	TestTenant

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

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": {
    "Tenant Region": <Tenant Region here>,
    "Tenant Name": <Tenant Name 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.
Tenant Region	`string`	Required	The region of the tenant.
Tenant Name	`string`	Required	The name of the tenant.

Sample Request

SAMPLE DATA

JSON

{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "Tenant Region": "AMER",
    "Tenant Name": "TestTenant"
  }
}

Response

Response Fields

Field Name	Type	Description
error	`string`	The error message if the API request has failed.

Sample Response

JSON

{
    "error": ""
}