Method: projects.guestPolicies.list

Get a page of OS Config guest policies.

HTTP request

GET https://osconfig.googleapis.com/v1beta/{parent=projects/*}/guestPolicies

The URL usesgRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The resource name of the parent using one of the following forms:projects/{project_number}.

Query parameters

Parameters
pageSize

integer

The maximum number of guest policies to return.

pageToken

string

A pagination token returned from a previous call toguestPolicies.list that indicates where this listing should continue from.

Request body

The request body must be empty.

Response body

A response message for listing guest policies.

If successful, the response body contains data with the following structure:

JSON representation
{"guestPolicies":[{object (GuestPolicy)}],"nextPageToken":string}
Fields
guestPolicies[]

object (GuestPolicy)

The list of GuestPolicies.

nextPageToken

string

A pagination token that can be used to get the next page of guest policies.

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 theparent resource:

  • osconfig.guestPolicies.list

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.