- [HTTP request](https://docs.cloud.google.com/deploy/docs/api/reference/rest/v1/projects.locations.operations/cancel#body.HTTP_TEMPLATE)
- [Path parameters](https://docs.cloud.google.com/deploy/docs/api/reference/rest/v1/projects.locations.operations/cancel#body.PATH_PARAMETERS)
- [Request body](https://docs.cloud.google.com/deploy/docs/api/reference/rest/v1/projects.locations.operations/cancel#body.request_body)
- [Response body](https://docs.cloud.google.com/deploy/docs/api/reference/rest/v1/projects.locations.operations/cancel#body.response_body)
- [Authorization scopes](https://docs.cloud.google.com/deploy/docs/api/reference/rest/v1/projects.locations.operations/cancel#body.aspect)
- [Try it!](https://docs.cloud.google.com/deploy/docs/api/reference/rest/v1/projects.locations.operations/cancel#try-it)

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use `https://docs.cloud.google.com/deploy/docs/api/reference/rest/v1/projects.locations.operations/get#google.longrunning.Operations.GetOperation` or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an `https://docs.cloud.google.com/deploy/docs/api/reference/rest/v1/projects.locations.operations#Operation.FIELDS.error` value with a `https://docs.cloud.google.com/deploy/docs/api/reference/rest/v1/projects.locations.operations#Status.FIELDS.code` of `1`, corresponding to `Code.CANCELLED`.

### HTTP request

Choose a location:
<button value="global" default="">global</button> <button value="asia-south1">asia-south1</button> <button value="asia-south2">asia-south2</button> <button value="us-central1">us-central1</button> <button value="us-east1">us-east1</button> <button value="us-east4">us-east4</button> <button value="us-east5">us-east5</button> <button value="us-east7">us-east7</button> <button value="us-south1">us-south1</button> <button value="us-west1">us-west1</button> <button value="us-west2">us-west2</button> <button value="us-west3">us-west3</button> <button value="us-west4">us-west4</button>   
`POST https://clouddeploy.googleapis.com/v1/{name=projects/*/locations/*/operations/*}:cancel`

<br />

The URLs use [gRPC Transcoding](https://google.aip.dev/127) syntax.

### Path parameters

| Parameters ||
|---|---|
| `name` | `string` The name of the operation resource to be cancelled. |

### Request body

The request body must be empty.

### Response body

If successful, the response body is an empty JSON object.

### Authorization scopes

Requires the following OAuth scope:

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

For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp).