Method: legacyPlaybooks.legacyGetWorkflowMenuCard

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

Returns a single playbook definition for the specified identifier. Use this method to retrieve metadata like category and version for a specific playbook.

HTTP request


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

Path parameters

Parameters
instance

string

Required. The instance to get the workflow menu card for. Format: projects/{project}/locations/{location}/instances/{instance}

Query parameters

Parameters
workflowIdentifier

string

Required. Workflow identifier to get the workflow menu card for.

Request body

The request body must be empty.

Response body

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

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.