Method: projects.guestPolicies.patch

Update an OS Config guest policy.

HTTP request

PATCH https://osconfig.googleapis.com/v1beta/{guestPolicy.name=projects/*/guestPolicies/*}

The URL usesgRPC Transcoding syntax.

Path parameters

Parameters
guestPolicy.name

string

Required. Unique name of the resource in this project using one of the following forms:projects/{project_number}/guestPolicies/{guestPolicyId}.

Query parameters

Parameters
updateMask

string (FieldMask format)

Field mask that controls which fields of the guest policy should be updated.

This is a comma-separated list of fully qualified names of fields. Example:"user.displayName,photo".

Request body

The request body contains an instance ofGuestPolicy.

Response body

If successful, the response body contains an instance ofGuestPolicy.

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.guestPolicies.update

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.