Method: legacyPlaybooks.legacyRestoreWorkflowDefinition

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

Reverts a playbook's active configuration to a previously saved version. Use this method to quickly roll back changes or recover a known good logic state.

HTTP request


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

Path parameters

Parameters
instance

string

Required. The instance to restore the workflow definition for. Format: projects/{project}/locations/{location}/instances/{instance}

Request body

The request body contains data with the following structure:

JSON representation 
{
  "restoreWorkflowIdentifier": string,
  "restoreComment": string,
  "isOverride": boolean
}
Fields
restoreWorkflowIdentifier

string

Required. The identifier of the workflow to restore the workflow definition for.
restoreComment

string

Required. The comment to restore the workflow with.
isOverride

boolean

Optional. Indicates if the restore should override the current workflow.

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.update

For more information, see the IAM documentation.