2026-03-17
▼ ▲ compute.instances.list
Parameters :
view
Description : View of the instance.
Location : query
Type : string
Enum :
Enum Descriptions :
▼ ▲ compute.instances.get
Parameters :
view
Enum :
Location : query
Type : string
Description : View of the instance.
Enum Descriptions :
▼ ▲ compute.instanceTemplates.list
Parameters :
view
Enum Descriptions :
Description : View of the instance template.
Location : query
Type : string
Enum :
▼ ▲ compute.instanceTemplates.get
Parameters :
view
Enum Descriptions :
Location : query
Type : string
Description : View of the instance template.
Enum :
▼ ▲ compute.regionInstanceTemplates.list
Parameters :
view
Enum Descriptions :
Description : View of the instance template.
Location : query
Type : string
Enum :
▼ ▲ compute.regionInstanceTemplates.get
Parameters :
view
Description : View of the instance template.
Location : query
Type : string
Enum :
Enum Descriptions :
▼ ▲ compute.instances.patchPartnerMetadata
Scopes :
Flat Path : projects/{project}/zones/{zone}/instances/{instance}/patchPartnerMetadata
HTTP Method : POST
Path : projects/{project}/zones/{zone}/instances/{instance}/patchPartnerMetadata
Description : Patches partner metadata of the specified instance.
Parameter Order :
Parameters :
instance
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Required : Yes
Type : string
Description : Name of the instance scoping this request.
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])?))
Description : Project ID for this request.
Location : path
Required : Yes
Type : string
requestId
Location : query
Type : string
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).
zone
Description : The name of the zone for this request.
Location : path
Required : Yes
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
▼ ▲ compute.instances.getPartnerMetadata
Parameters :
instance
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the instance scoping this request.
Location : path
Required : Yes
Type : string
project
Description : Project ID for this request.
Location : path
Required : Yes
Type : string
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])?))
namespaces
Location : query
Type : string
Description : Comma separated partner metadata namespaces.
zone
Description : The name of the zone for this request.
Location : path
Required : Yes
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Parameter Order :
Path : projects/{project}/zones/{zone}/instances/{instance}/getPartnerMetadata
Description : Gets partner metadata of the specified instance and namespaces.
Scopes :
Flat Path : projects/{project}/zones/{zone}/instances/{instance}/getPartnerMetadata
HTTP Method : GET
▼ ▲ compute.regionInstanceGroupManagerResizeRequests.cancel
Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}/cancel
Description : Cancels the specified resize request. Cancelled resize request no longer waits for the resources to be provisioned. Cancel is only possible for requests that are in accepted state.
Scopes :
HTTP Method : POST
Flat Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}/cancel
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
Required : Yes
Type : string
Description : Project ID for this request.
region
Location : path
Required : Yes
Type : string
Description : The name of the region scoping this request. Name should conform to RFC1035.
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).
Location : query
Type : string
instanceGroupManager
Location : path
Required : Yes
Type : string
Description : The name of the managed instance group. Name should conform to RFC1035 or be a resource ID.
resizeRequest
Description : The name of the resize request to cancel. Name should conform to RFC1035 or be a resource ID.
Location : path
Required : Yes
Type : string
Parameter Order :
▼ ▲ compute.regionInstanceGroupManagerResizeRequests.get
Parameter Order :
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
Required : Yes
Type : string
Description : Project ID for this request.
region
Location : path
Required : Yes
Type : string
Description : The name of the region scoping this request. Name should conform to RFC1035.
instanceGroupManager
Location : path
Required : Yes
Type : string
Description : The name of the managed instance group. Name should conform to RFC1035 or be a resource ID.
resizeRequest
Location : path
Required : Yes
Type : string
Description : The name of the resize request. Name should conform to RFC1035 or be a resource ID.
Scopes :
Flat Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}
HTTP Method : GET
Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}
Description : Returns all of the details about the specified resize request.
▼ ▲ compute.regionInstanceGroupManagerResizeRequests.insert
HTTP Method : POST
Flat Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests
Scopes :
Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests
Description : Creates a new Resize Request that starts provisioning VMs immediately or queues VM creation.
Parameter Order :
Parameters :
instanceGroupManager
Location : path
Required : Yes
Type : string
Description : Name of the managed instance group to which the resize request is scoped. Name should conform to RFC1035 or be a resource ID.
region
Location : path
Required : Yes
Type : string
Description : Name of the region scoping this request. Name should conform to RFC1035.
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).
Location : query
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])?))
Description : Project ID for this request.
Location : path
Required : Yes
Type : string
▼ ▲ compute.regionInstanceGroupManagerResizeRequests.list
Parameters :
region
Location : path
Required : Yes
Type : string
Description : Name of the region scoping this request. Name should conform to RFC1035.
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])?))
Description : Project ID for this request.
Location : path
Required : Yes
Type : string
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.
instanceGroupManager
Description : The name of the managed instance group. The name should conform to RFC1035.
Location : path
Required : Yes
Type : string
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
maxResults
Minimum : 0
Default : 500
Location : query
Type : integer
Format : uint32
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`)
orderBy
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.
Location : query
Type : string
pageToken
Location : query
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.
Parameter Order :
Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests
Description : Retrieves a list of Resize Requests that are contained in the managed instance group.
Flat Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests
HTTP Method : GET
Scopes :
▼ ▲ compute.regionInstanceGroupManagerResizeRequests.delete
Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}
Description : Deletes the specified, inactive resize request. Requests that are still active cannot be deleted. Deleting request does not delete instances that were provisioned previously.
Flat Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}
HTTP Method : DELETE
Scopes :
Parameters :
region
Description : The name of the region scoping this request. Name should conform to RFC1035.
Location : path
Required : Yes
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])?))
Location : path
Required : Yes
Type : string
Description : Project ID for this request.
instanceGroupManager
Description : The name of the managed instance group. Name should conform to RFC1035 or be a resource ID.
Location : path
Required : Yes
Type : string
resizeRequest
Location : path
Required : Yes
Type : string
Description : The name of the resize request to delete. Name should conform to RFC1035 or be a resource ID.
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).
Location : query
Type : string
Parameter Order :
▼ ▲ compute.zoneVmExtensionPolicies.insert
Parameter Order :
Parameters :
zone
Location : path
Required : Yes
Type : string
Description : Name of the zone for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
project
Description : Project ID for this request.
Location : path
Required : Yes
Type : string
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])?))
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).
Location : query
Type : string
Flat Path : projects/{project}/zones/{zone}/vmExtensionPolicies
HTTP Method : POST
Scopes :
Path : projects/{project}/zones/{zone}/vmExtensionPolicies
Description : Creates a new zone-level VM extension policy within a project.
▼ ▲ compute.zoneVmExtensionPolicies.get
Parameters :
zone
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Required : Yes
Type : string
Description : Name of the zone for this request.
vmExtensionPolicy
Description : Name of the VM extension policy resource to return.
Location : path
Required : Yes
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
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
Required : Yes
Type : string
Description : Project ID for this request.
Parameter Order :
Path : projects/{project}/zones/{zone}/vmExtensionPolicies/{vmExtensionPolicy}
Description : Retrieves details of a specific zone VM extension policy.
Scopes :
HTTP Method : GET
Flat Path : projects/{project}/zones/{zone}/vmExtensionPolicies/{vmExtensionPolicy}
▼ ▲ compute.zoneVmExtensionPolicies.update
Scopes :
HTTP Method : PATCH
Flat Path : projects/{project}/zones/{zone}/vmExtensionPolicies/{vmExtensionPolicy}
Path : projects/{project}/zones/{zone}/vmExtensionPolicies/{vmExtensionPolicy}
Description : Modifies an existing zone VM extension policy.
Parameter Order :
Parameters :
vmExtensionPolicy
Location : path
Required : Yes
Type : string
Description : Name of the zone VM extension policy to update.
zone
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Name of the zone for this request.
Location : path
Required : Yes
Type : string
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).
Location : query
Type : string
project
Description : Project ID for this request.
Location : path
Required : Yes
Type : string
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])?))
▼ ▲ compute.zoneVmExtensionPolicies.list
Path : projects/{project}/zones/{zone}/vmExtensionPolicies
Description : Lists all VM extension policies within a specific zone for a project.
Scopes :
HTTP Method : GET
Flat Path : projects/{project}/zones/{zone}/vmExtensionPolicies
Parameters :
maxResults
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
Location : query
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.
pageToken
Location : query
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.
returnPartialSuccess
Location : query
Type : boolean
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.
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.
project
Location : path
Required : Yes
Type : string
Description : Project ID for this request.
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])?))
zone
Description : Name of the zone for this request.
Location : path
Required : Yes
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Parameter Order :
▼ ▲ compute.zoneVmExtensionPolicies.delete
Path : projects/{project}/zones/{zone}/vmExtensionPolicies/{vmExtensionPolicy}
Description : Deletes a specified zone VM extension policy.
Scopes :
HTTP Method : DELETE
Flat Path : projects/{project}/zones/{zone}/vmExtensionPolicies/{vmExtensionPolicy}
Parameters :
zone
Location : path
Required : Yes
Type : string
Description : Name of the zone for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
vmExtensionPolicy
Location : path
Required : Yes
Type : string
Description : Name of the zone VM extension policy to delete.
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
Required : Yes
Type : string
Description : Project ID for this request.
requestId
Location : query
Type : string
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).
Parameter Order :