Method: legacyPlaybooks.legacyTerminateWorkflowInstance

• HTTP request
• Path parameters
• Request body
  • JSON representation
• Response body
• Authorization scopes
• IAM Permissions

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

Immediately stops the execution of an in-progress playbook instance. Use this method to manually halt automation that is no longer required or is performing unexpectedly.

HTTP request

Choose a location:

africa-south1 asia-northeast1 asia-south1 asia-southeast1 asia-southeast2 australia-southeast1 europe-central2 europe-west12 europe-west2 europe-west3 europe-west6 europe-west9 me-central1 me-central2 me-west1 northamerica-northeast2 southamerica-east1 us eu

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

Path parameters

Parameters
instance	string Required. The instance to terminate the workflow for. Format: projects/{project}/locations/{location}/instances/{instance}

Request body

The request body contains data with the following structure:

JSON representation
{ "workflowInstanceId": string }

Fields
workflowInstanceId	string Required. The workflow instance id to terminate. Format: projects/{project}/locations/{location}/instances/{instance}/workflows/{workflow}

Response body

If successful, the response body is empty.

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.