Method: legacyPlaybooks.legacyCheckWorkflowNameInDifferentEnvironments

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

Checks if the specified playbook name is already in use within any environment. Use this method to prevent naming conflicts before creating or updating a response workflow.

HTTP request


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

Path parameters

Parameters
instance

string

Required. The instance to check the workflow name in different environments for. Format: projects/{project}/locations/{location}/instances/{instance}

Request body

The request body contains data with the following structure:

JSON representation 
{
  "wfName": string
}
Fields
wfName

string

Required. The workflow name to check in different environments for.

Response body

LegacyPlaybookCheckWorkflowNameInDifferentEnvironmentsResponse is a response for checking if the workflow name already exists in different environment. if it exists, the response will contain the identifier of the workflow in the different environment.

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

JSON representation 
{
  "payload": string
}
Fields
payload

string

Optional. The result of the check.

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.