Method: legacyPlaybooks.legacyRunPlaybookInDebug

Full name: projects.locations.instances.legacyPlaybooks.legacyRunPlaybookInDebug

Executes a playbook in a simulation environment using provided test data. Use this method to verify automation logic and identify potential issues before deploying a playbook to production.

HTTP request


POST https://chronicle.africa-south1.rep.googleapis.com/v1alpha/{instance}/legacyPlaybooks:legacyRunPlaybookInDebug

Path parameters

Parameters
instance

string

Required. The instance to run the playbook in debug for. Format: projects/{project}/locations/{location}/instances/{instance}

Request body

The request body contains data with the following structure:

JSON representation 
{
  "workflow": {
    object (ApiWorkflowDefinitionDataModel)
  },
  "testCaseId": string
}
Fields
workflow

object (ApiWorkflowDefinitionDataModel)

Required. The workflow to run the playbook in debug for.
testCaseId

string (int64 format)

Required. The test case id to run the playbook in debug for.

Response body

Response object that holds identifiers of a playbook simulation / debug mode run. Those identifiers are used to fetch results for this specific run

If successful, the response body contains data with the following structure:

JSON representation 
{
  "workflowInstanceId": string,
  "newTestCaseId": string,
  "alertGroupIdentifier": string,
  "alertIdentifier": string,
  "newWorkflowIdentifier": string,
  "parsedNestedInputParameters": {
    string: string,
    ...
  },
  "triggerMatches": boolean
}
Fields
workflowInstanceId

string (int64 format)

Required. Workflow instance id
newTestCaseId

string (int64 format)

Required. The new case id that this playbook will run on
alertGroupIdentifier

string

Required. The group id for the alert
alertIdentifier

string

Required. The alert identifier
newWorkflowIdentifier

string

Required. The new workflow identifier
parsedNestedInputParameters

map (key: string, value: string)

Optional. Dictionary of inner input parameters

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
triggerMatches

boolean

Required. Whether the trigger actually matched when we ran the simulation

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/chronicle
  • https://www.googleapis.com/auth/chronicle.readonly

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the instance resource:

  • chronicle.legacyPlaybooks.update

For more information, see the IAM documentation.