2026-01-29
▼ ▲ compute.zoneVmExtensionPolicies.getVmExtension
Parameters :
zone
Description : Name of the zone for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Required : Yes
Location : path
extensionName
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Location : path
Type : string
project
Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Required : Yes
Type : string
Description : Project ID for this request.
Location : path
Path : projects/{project}/zones/{zone}/vmExtensions/{extensionName}
Scopes :
Description : Retrieves details of a specific VM extension.
Flat Path : projects/{project}/zones/{zone}/vmExtensions/{extensionName}
Parameter Order :
HTTP Method : GET
▼ ▲ compute.zoneVmExtensionPolicies.listVmExtensions
Flat Path : projects/{project}/zones/{zone}/vmExtensions
Path : projects/{project}/zones/{zone}/vmExtensions
Description : Lists all VM extensions within a specific zone for a project. This is a read-only API.
Scopes :
HTTP Method : GET
Parameter Order :
Parameters :
filter
Description : A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based onresource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using GoogleRE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.
Type : string
Location : query
orderBy
Location : query
Type : string
Description : Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.
returnPartialSuccess
Location : query
Description : Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.
Type : boolean
pageToken
Type : string
Location : query
Description : Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
project
Type : string
Required : Yes
Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Description : Required. Project ID for this request.
Location : path
maxResults
Format : uint32
Type : integer
Default : 500
Location : query
Minimum : 0
Description : The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
zone
Description : Name of the zone for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Required : Yes
Type : string
▼ ▲ compute.globalVmExtensionPolicies.getVmExtension
Parameters :
project
Required : Yes
Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Description : Project ID for this request.
Location : path
Type : string
extensionName
Type : string
Location : path
Required : Yes
Flat Path : projects/{project}/global/vmExtensions/{extensionName}
Description : Retrieves details of a specific VM extension.
Parameter Order :
Path : projects/{project}/global/vmExtensions/{extensionName}
Scopes :
HTTP Method : GET
▼ ▲ compute.globalVmExtensionPolicies.listVmExtensions
Parameters :
pageToken
Description : Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
Location : query
Type : string
returnPartialSuccess
Type : boolean
Location : query
Description : Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.
orderBy
Location : query
Description : Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.
Type : string
maxResults
Location : query
Type : integer
Minimum : 0
Description : The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
Default : 500
Format : uint32
project
Description : Required. Project ID for this request.
Required : Yes
Type : string
Location : path
Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
filter
Location : query
Type : string
Description : A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based onresource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using GoogleRE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.
Description : Lists all VM extensions within a specific zone for a project. This is a read-only API.
Flat Path : projects/{project}/global/vmExtensions
Parameter Order : project
Scopes :
HTTP Method : GET
Path : projects/{project}/global/vmExtensions
▼ ▲ compute.snapshotRecycleBinPolicy.get
Flat Path : projects/{project}/global/snapshotRecycleBinPolicy
Scopes :
HTTP Method : GET
Parameter Order : project
Parameters :
project
Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Required : Yes
Type : string
Location : path
Description : Project ID for this request.
Path : projects/{project}/global/snapshotRecycleBinPolicy
Description : Returns the specified SnapshotRecycleBinPolicy.
▼ ▲ compute.snapshotRecycleBinPolicy.patch
Flat Path : projects/{project}/global/snapshotRecycleBinPolicy
Scopes :
HTTP Method : PATCH
Description : Patches the SnapshotRecycleBinPolicy.
Parameter Order : project
Path : projects/{project}/global/snapshotRecycleBinPolicy
Parameters :
updateMask
Location : query
Format : google-fieldmask
Type : string
Description : update_mask indicates fields to be updated as part of this request.
requestId
Description : An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Type : string
Location : query
project
Location : path
Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Type : string
Description : Project ID for this request.
Required : Yes
▼ ▲ compute.snapshots.getEffectiveRecycleBinRule
Scopes :
HTTP Method : GET
Path : projects/{project}/global/snapshots/{snapshot}/getEffectiveRecycleBinRule
Description : Returns the effective recycle bin rule for a snapshot by merging org and project level rules. If no rules are defined at org and project level, the standard default rule is returned.
Parameter Order :
Flat Path : projects/{project}/global/snapshots/{snapshot}/getEffectiveRecycleBinRule
Parameters :
snapshot
Type : string
Description : Name of the Snapshot resource to get the effective recycle bin rule for.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
project
Required : Yes
Location : path
Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Type : string
Description : Project ID for this request.
▼ ▲ compute.instances.listVmExtensionStates
Parameter Order :
Description : Lists all VM extensions states for a specific instance. This is a read-only API.
Path : projects/{project}/zones/{zone}/instances/{instance}/vmExtensionStates
Flat Path : projects/{project}/zones/{zone}/instances/{instance}/vmExtensionStates
Parameters :
maxResults
Location : query
Default : 500
Description : The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
Type : integer
Format : uint32
Minimum : 0
orderBy
Location : query
Type : string
Description : Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.
zone
Description : Required. Name of the zone for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Location : path
Type : string
pageToken
Type : string
Description : Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
Location : query
project
Description : Project ID for this request.
Location : path
Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Required : Yes
Type : string
instance
Description : Name of the target instance scoping this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Location : path
Required : Yes
returnPartialSuccess
Description : Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.
Location : query
Type : boolean
filter
Type : string
Location : query
Description : A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based onresource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using GoogleRE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.
HTTP Method : GET
Scopes :
▼ ▲ compute.instances.getVmExtensionState
Description : Retrieves details of a specific VM extension state. This is a read-only API.
Parameters :
project
Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Location : path
Description : Project ID for this request.
Required : Yes
Type : string
zone
Description : Name of the zone for this request.
Required : Yes
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
instance
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name or id of the instance resource.
Type : string
Required : Yes
extensionName
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Location : path
Description : The name of the extension to get the state for.
Path : projects/{project}/zones/{zone}/instances/{instance}/vmExtensionStates/{extensionName}
Parameter Order :
HTTP Method : GET
Flat Path : projects/{project}/zones/{zone}/instances/{instance}/vmExtensionStates/{extensionName}
Scopes :
▼ ▲ compute.organizationSnapshotRecycleBinPolicy.patch
HTTP Method : PATCH
Parameter Order : organization
Flat Path : organizations/{organizationsId}/global/snapshotRecycleBinPolicy
Description : Patches the SnapshotRecycleBinPolicy.
Parameters :
requestId
Description : An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Type : string
Location : query
organization
Location : path
Pattern : organizations/[0-9]{0,20}
Type : string
Required : Yes
Description : Organization ID for this request.
updateMask
Format : google-fieldmask
Type : string
Location : query
Description : update_mask indicates fields to be updated as part of this request.
Scopes :
Path : {+organization}/global/snapshotRecycleBinPolicy
▼ ▲ compute.organizationSnapshotRecycleBinPolicy.get
Description : Returns the specified SnapshotRecycleBinPolicy.
Flat Path : organizations/{organizationsId}/global/snapshotRecycleBinPolicy
Parameter Order : organization
HTTP Method : GET
Scopes :
Parameters :
organization
Pattern : organizations/[0-9]{0,20}
Type : string
Required : Yes
Description : Organization ID for this request.
Location : path
Path : {+organization}/global/snapshotRecycleBinPolicy
▼ ▲ compute.forwardingRules.get
Parameters :
view
Type : string
Location : query
Enum :
Enum Descriptions :
▼ ▲ compute.instances.update
Parameters :
discardLocalSsd
Location : query
Type : boolean
Description : Whether to discard local SSDs from the instance during restart default value is false.
▼ ▲ compute.globalForwardingRules.get
Parameters :
view
Type : string
Enum :
Enum Descriptions :
Location : query