Method: projects.locations.deliveryPipelines.automationRuns.cancel

• HTTP request
• Path parameters
• Request body
• Response body
• Authorization scopes
• IAM Permissions
• Try it!

Cancels an AutomationRun. The state of the AutomationRun after cancelling is CANCELLED. automationRuns.cancel can be called on AutomationRun in the state IN_PROGRESS and PENDING; AutomationRun in a different state returns an FAILED_PRECONDITION error.

HTTP request

POST https://clouddeploy.googleapis.com/v1/{name=projects/*/locations/*/deliveryPipelines/*/automationRuns/*}:cancel

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name	string Required. Name of the AutomationRun. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/automationRuns/{automationRun}.

Request body

The request body must be empty.

Response body

If successful, the response body is empty.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

• clouddeploy.automationRuns.cancel

For more information, see the IAM documentation.