Method: projects.patchDeployments.pause

Change state of patch deployment to "PAUSED". Patch deployment in paused state doesn't generate patch jobs.

HTTP request

POST https://osconfig.googleapis.com/v1/{name=projects/*/patchDeployments/*}:pause

The URL usesgRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The resource name of the patch deployment in the formprojects/*/patchDeployments/*.

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance ofPatchDeployment.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see theAuthentication Overview.

IAM Permissions

Requires the followingIAM permission on thename resource:

  • osconfig.patchDeployments.pause

For more information, see theIAM documentation.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-07-28 UTC.