Method: legacyPlaybooks.legacyGetWorkflowFullInfoByIdentifier

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

Returns the full configuration of a playbook, including its steps and connectivity logic, for a specific playbook identifier.

HTTP request


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

Path parameters

Parameters
instance

string

Required. The instance to get the workflow full info by identifier for. Format: projects/{project}/locations/{location}/instances/{instance}

Query parameters

Parameters
workflowIdentifier

string

Required. Workflow identifier to get the workflow full info by identifier for.

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of ApiWorkflowDefinitionDataModel.

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.