Skip to main content
Skip table of contents

PublishPlaybook

This command is designed to establish a connection with a specific tenant and publish the Master playbook to all sites within that tenant.

Implementation

System

Command Category

System Utility

Tags

PLAYBOOK MULTITENANCY

Inputs

Parameter Name

Required/Optional

Description

Sample Data

Tenant Region

Required

Region of the tenant

AMER

Tenant Name

Required

Name of the tenant

TestTenant

Output

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

Text

Required

The username of your D3 SOAR account.

Site

Text

Required

The D3 SOAR site to run the remote command.

Tenant Region

Text

Required

Region of the tenant

Tenant Name

Text

Required

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

text

The error message if the API request has failed.

Sample Response

JSON
{
    "error": ""
}
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.