Method: legacyPlaybooks.legacyGetPlaybooksUsingBlocks

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

Identifies and returns all playbooks that reference the specified block. Use this method to understand the dependencies and usage of modular automation components.

HTTP request


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

Path parameters

Parameters
instance

string

Required. The instance to get the playbooks using blocks for. Format: projects/{project}/locations/{location}/instances/{instance}

Request body

The request body contains data with the following structure:

JSON representation 
{
  "blockIdentifiers": [
    string
  ],
  "originalWorkflowIdentifier": string
}
Fields
blockIdentifiers[]

string

Optional. Block identifiers to filter the playbooks by.
originalWorkflowIdentifier

string

Optional. Original workflow identifier to filter the playbooks by.

Response body

LegacyPlaybookGetPlaybooksUsingBlocksResponse is a response for getting the playbooks using blocks.

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

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

object (Struct format)

Optional. The playbooks using blocks.

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.