Method: legacyPlaybooks.legacyGetDebugStepCaseData

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

Returns the simulated case data context for a specific playbook step. Use this method during debugging to inspect the inputs and environment state used to evaluate a particular automation segment.

HTTP request


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

Path parameters

Parameters
instance

string

Required. The instance to get the debug step case data for. Format: projects/{project}/locations/{location}/instances/{instance}

Request body

The request body contains data with the following structure:

JSON representation 
{
  "stepOriginalIdentifier": string,
  "alertIdentifier": string
}
Fields
stepOriginalIdentifier

string

Required. The original identifier of the step.
alertIdentifier

string

Required. The alert identifier.

Response body

LegacyPlaybookGetDebugStepCaseDataResponse is a response for getting the debug step case data.

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

JSON representation 
{
  "payload": {
    object
  }
}
Fields
payload

object (Struct format)

Optional. The debug step case data.

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.get

For more information, see the IAM documentation.