- HTTP request
- Path parameters
- Request body
- Response body
- Authorization scopes
- IAM Permissions
- Try it!
Cancels a Rollout in a given project and location.
HTTP request
POST https://clouddeploy.googleapis.com/v1/{name=projects/*/locations/*/deliveryPipelines/*/releases/*/rollouts/*}:cancel
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
name |
Required. Name of the Rollout. Format is |
Request body
The request body contains data with the following structure:
JSON representation |
---|
{ "overrideDeployPolicy": [ string ] } |
Fields | |
---|---|
override |
Optional. Deploy policies to override. Format is |
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.rollouts.cancel
For more information, see the IAM documentation.