Method: projects.patchJobs.cancel

Cancel a patch job. The patch job must be active. Canceled patch jobs cannot be restarted.

HTTP request

POST https://osconfig.googleapis.com/v1/{name=projects/*/patchJobs/*}:cancel

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. Name of the patch in the form projects/*/patchJobs/*

Request body

The request body must be empty.

Response body

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

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:

  • osconfig.patchJobs.exec

For more information, see the IAM documentation.