Method: projects.locations.workflows.executions.cancel

Cancels an execution of the given name.

HTTP request

POST https://workflowexecutions.googleapis.com/v1beta/{name=projects/*/locations/*/workflows/*/executions/*}:cancel

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. Name of the execution to be cancelled. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}

Authorization requires the following IAM permission on the specified resource name:

  • workflows.executions.cancel

Request body

The request body must be empty.

Response body

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

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.