Method: legacyPlaybooks.legacyGetWorkflowsInvolvingAction

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

Returns all playbooks that include one or more of the specified actions. Use this method to understand the usage of individual automation steps across the playbook repository.

HTTP request


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

Path parameters

Parameters
instance

string

Required. The instance to get the workflows involving action for. Format: projects/{project}/locations/{location}/instances/{instance}

Request body

The request body contains data with the following structure:

JSON representation 
{
  "actionId": string
}
Fields
actionId

string

Required. The action id.

Response body

LegacyPlaybookGetWorkflowsInvolvingActionResponse is a response for getting workflows involving action.

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

JSON representation 
{
  "payload": [
    {
      object (ApiIntegrationPlaybookByEnvironment)
    }
  ]
}
Fields
payload[]

object (ApiIntegrationPlaybookByEnvironment)

Optional. The payload is a list of workflows by environment.

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.

ApiIntegrationPlaybookByEnvironment

ApiIntegrationPlaybookByEnvironment is the object for workflows involving action.

JSON representation 
{
  "environment": string,
  "playbooks": [
    {
      object (ApiIntegrationPlaybook)
    }
  ]
}
Fields
environment

string

Required. The environment.
playbooks[]

object (ApiIntegrationPlaybook)

Optional. The list of playbooks.

ApiIntegrationPlaybook

ApiIntegrationPlaybook represents a playbook.

JSON representation 
{
  "name": string,
  "isEnabled": boolean
}
Fields
name

string

Required. The name of the playbook.
isEnabled

boolean

Optional. Indicates if the playbook is enabled.