Skip to main content
Skip table of contents

Get Playbook Tasks Metadata‎

READER NOTE

This API endpoint is available for version 16.8+. If the API endpoint is unavailable for you, please kindly reach out to D3 for assistance.

POST /Command/GetPlaybookTasksMetadata

Retrieve metadata of all the playbook tasks presented in a live version playbook.

Request

Authentication: API keys or JSON web tokens (JWT)

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 Type

string

Required

Identify the playbook type, which can be event, incident and codeless playbook. (Options: “Event Playbook”, “Incident Playbook”, “Integration Codeless Playbook”, or “Utility Codeless Playbook“)

Playbook Name

string

Required

The name of the playbook from which the task metadata will be retrieved.

Integration Name

string

Optional

The name of integration. Require if the codeless playbook is an integration codeless playbook.

Body Sample Data

application/json
JSON
{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "Playbook Type": "Event Playbook",
    "Playbook Name": "PlaybookName",
    "Integration Name": "Crowdstrike"
  }
}

Response

200 OK

application/json

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 Data

JSON
{
    "error": "",
    "returnData": {
        "Status": "Successful",
        "Data": [
            {
                "TaskName": "CommandTask",
                "TaskId": "*****",
                "TaskType": "Command Task",
                "TaskConfig": {
                    "IntegrationName": "IntegrationName",
                    "CommandName": "CommandName",
                    "Connection": "C",
                    "Input settings": {}
                },
                "BasicConfig": {
                    "Active": true,
                    "AutoRun": true,
                    "LongRun": true,
                    "Required": true,
                    "AssignedTo": "abc",
                    "DueTime": "",
                    "RunMode": "",
                    "Description": "",
                    "ErrorTrigger": true,
                    "StopOnError": false,
                    "RerunBy": "name",
                    "Auto-RetryOnError": true,
                    "Auto-RetryOnErrorSetting": {
                        "Retries": 4,
                        "RetriesSetting": [
                            "10s",
                            "3m",
                            "1h"
                        ]
                    }
                }
            }
        ]
    }
}

400 BadRequest

application/json

Response Fields

Field Name

Type

Description

Error

string

A error message when the API request fails.

Sample Data

JSON
{"Error": "The body of the request must be a valid JSON object"}

401 Unauthorized

application/json

Response Fields

Field Name

Type

Description

Error

string

A error message when the API request fails.

Sample Data

JSON
{"Error": "Invalid authentication key."}

429 TooManyRequests

application/json

Response Fields

Field Name

Type

Description

Error

string

A error message when the API request fails.

Sample Data

JSON
{"Error": "The request exceeds rate limits or is otherwise blocked by rate limiting policies."}

500 InternalServerError

application/json

Response Fields

Field Name

Type

Description

Error

string

A error message when the API request fails.

Sample Data

JSON
{"Error": "Unexpected Error."}
JavaScript errors detected

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

If this problem persists, please contact our support.