2026-11-01
▼ ▲ compute.regionInstanceTemplates.insert
Scopes :
HTTP Method : POST
Flat Path : projects/{project}/regions/{region}/instanceTemplates
Parameter Order :
Path : projects/{project}/regions/{region}/instanceTemplates
Parameters :
project
Type : string
Location : path
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.
requestId
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).
Location : query
region
Description : The name of the region for this request.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Type : string
Description : Creates an instance template in the specified project and region using the global instance template whose URL is included in the request.
Apiversion : 2026-12-01-preview
▼ ▲ compute.regionInstanceTemplates.delete
Scopes :
HTTP Method : DELETE
Flat Path : projects/{project}/regions/{region}/instanceTemplates/{instanceTemplate}
Path : projects/{project}/regions/{region}/instanceTemplates/{instanceTemplate}
Apiversion : 2026-12-01-preview
Parameter Order :
Description : Deletes the specified instance template. Deleting an instance template is permanent and cannot be undone.
Parameters :
requestId
Type : string
Location : query
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).
project
Location : path
Type : string
Required : Yes
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])?))
instanceTemplate
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : The name of the instance template to delete.
Type : string
Required : Yes
region
Description : The name of the region for this request.
Location : path
Required : Yes
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
▼ ▲ compute.regionInstanceTemplates.list
Parameter Order :
Parameters :
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
Description : Project ID for this request.
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])?))
Location : path
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
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`)
Format : uint32
Type : integer
Location : query
Minimum : 0
Default : 500
region
Type : string
Location : path
Description : The name of the regions for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
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
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/regions/{region}/instanceTemplates
Description : Retrieves a list of instance templates that are contained within the specified project and region.
HTTP Method : GET
Scopes :
Path : projects/{project}/regions/{region}/instanceTemplates
▼ ▲ compute.regionInstanceTemplates.get
HTTP Method : GET
Description : Returns the specified instance template.
Path : projects/{project}/regions/{region}/instanceTemplates/{instanceTemplate}
Flat Path : projects/{project}/regions/{region}/instanceTemplates/{instanceTemplate}
Scopes :
Apiversion : 2026-12-01-preview
Parameter Order :
Parameters :
region
Required : Yes
Type : string
Description : The name of the region for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
instanceTemplate
Type : string
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Description : The name of the instance template.
project
Required : Yes
Type : string
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])?))
▼ ▲ compute.regionBackendBuckets.delete
Scopes :
Apiversion : 2026-12-01-preview
Path : projects/{project}/regions/{region}/backendBuckets/{backendBucket}
Parameters :
region
Type : string
Location : path
Required : Yes
Description : Name of the region scoping this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
requestId
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). end_interface: MixerMutationRequestBuilder
Location : query
project
Required : Yes
Description : Project ID for this request.
Location : path
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])?))
backendBucket
Required : Yes
Location : path
Description : Name of the BackendBucket resource to delete.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Description : Deletes the specified regional BackendBucket resource.
Flat Path : projects/{project}/regions/{region}/backendBuckets/{backendBucket}
HTTP Method : DELETE
Parameter Order :
▼ ▲ compute.regionBackendBuckets.list
HTTP Method : GET
Flat Path : projects/{project}/regions/{region}/backendBuckets
Path : projects/{project}/regions/{region}/backendBuckets
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
project
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])?))
Required : Yes
Description : Project ID for this request.
Location : path
region
Required : Yes
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Description : Name of the region of this request.
orderBy
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.
Location : query
filter
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.
Type : string
maxResults
Format : uint32
Default : 500
Minimum : 0
Type : integer
Location : query
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`)
Apiversion : 2026-12-01-preview
Scopes :
Parameter Order :
Description : Retrieves the list of BackendBucket resources available to the specified project in the given region.
▼ ▲ compute.regionBackendBuckets.getIamPolicy
Flat Path : projects/{project}/regions/{region}/backendBuckets/{resource}/getIamPolicy
Description : Gets the access control policy for a resource. May be empty if no such policy or resource exists.
HTTP Method : GET
Parameters :
resource
Required : Yes
Type : string
Location : path
Description : Name or id of the resource for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
optionsRequestedPolicyVersion
Format : int32
Type : integer
Location : query
Description : Requested IAM Policy version.
region
Description : The name of the region for this request.
Type : string
Location : path
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
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
Type : string
Required : Yes
Description : Project ID for this request.
Scopes :
Apiversion : 2026-12-01-preview
Parameter Order :
Path : projects/{project}/regions/{region}/backendBuckets/{resource}/getIamPolicy
▼ ▲ compute.regionBackendBuckets.insert
Scopes :
HTTP Method : POST
Parameter Order :
Flat Path : projects/{project}/regions/{region}/backendBuckets
Parameters :
region
Required : Yes
Description : Name of the region of this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Location : path
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.
Type : string
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])?))
Description : Creates a RegionBackendBucket in the specified project in the given scope using the parameters that are included in the request.
Path : projects/{project}/regions/{region}/backendBuckets
Apiversion : 2026-12-01-preview
▼ ▲ compute.regionBackendBuckets.patch
Path : projects/{project}/regions/{region}/backendBuckets/{backendBucket}
Scopes :
HTTP Method : PATCH
Description : Updates the specified BackendBucket resource with the data included in the request. This method supportsPATCH semantics and uses theJSON merge patch format and processing rules.
Apiversion : 2026-12-01-preview
Parameter Order :
Flat Path : projects/{project}/regions/{region}/backendBuckets/{backendBucket}
Parameters :
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Description : Name of the region scoping this request.
Type : string
Required : Yes
project
Location : path
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])?))
Required : Yes
Description : Project ID for this request.
requestId
Location : query
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). end_interface: MixerMutationRequestBuilder
Type : string
backendBucket
Type : string
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the BackendBucket resource to patch.
Location : path
▼ ▲ compute.regionBackendBuckets.listUsable
Path : projects/{project}/regions/{region}/backendBuckets/listUsable
Flat Path : projects/{project}/regions/{region}/backendBuckets/listUsable
HTTP Method : GET
Apiversion : 2026-12-01-preview
Parameters :
project
Type : string
Description : Project ID for this request.
Location : path
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])?))
region
Type : string
Location : path
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Name of the region scoping this request. It must be a string that meets the requirements in RFC1035.
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.
Type : string
Location : query
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
filter
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.
Type : string
maxResults
Default : 500
Location : query
Minimum : 0
Type : integer
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`)
Format : uint32
Parameter Order :
Description : Retrieves a list of all usable backend buckets in the specified project in the given region.
Scopes :
▼ ▲ compute.regionBackendBuckets.get
Apiversion : 2026-12-01-preview
Parameter Order :
Path : projects/{project}/regions/{region}/backendBuckets/{backendBucket}
Flat Path : projects/{project}/regions/{region}/backendBuckets/{backendBucket}
Parameters :
project
Description : Project ID for this request.
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])?))
Required : Yes
backendBucket
Description : Name of the BackendBucket resource to return.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Type : string
Location : path
region
Description : Name of the region scoping this request.
Location : path
Required : Yes
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Scopes :
Description : Returns the specified regional BackendBucket resource.
HTTP Method : GET
▼ ▲ compute.regionBackendBuckets.setIamPolicy
Apiversion : 2026-12-01-preview
Scopes :
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])?))
Description : Project ID for this request.
Required : Yes
Location : path
Type : string
resource
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Description : Name or id of the resource for this request.
Type : string
region
Description : The name of the region for this request.
Location : path
Required : Yes
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Sets the access control policy on the specified resource. Replaces any existing policy.
Parameter Order :
Flat Path : projects/{project}/regions/{region}/backendBuckets/{resource}/setIamPolicy
Path : projects/{project}/regions/{region}/backendBuckets/{resource}/setIamPolicy
HTTP Method : POST
▼ ▲ compute.regionBackendBuckets.testIamPermissions
Parameter Order :
Path : projects/{project}/regions/{region}/backendBuckets/{resource}/testIamPermissions
Flat Path : projects/{project}/regions/{region}/backendBuckets/{resource}/testIamPermissions
HTTP Method : POST
Description : Returns permissions that a caller has on the specified resource.
Parameters :
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])?))
Location : path
Description : Project ID for this request.
region
Type : string
Location : path
Description : The name of the region for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
resource
Required : Yes
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name or id of the resource for this request.
Location : path
Apiversion : 2026-12-01-preview
Scopes :
▼ ▲ compute.targetHttpsProxies.delete
HTTP Method : DELETE
Parameter Order :
Scopes :
Apiversion : 2026-12-01-preview
Description : Deletes the specified TargetHttpsProxy resource.
Path : projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}
Parameters :
requestId
Location : query
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
project
Required : Yes
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])?))
Type : string
targetHttpsProxy
Type : string
Description : Name of the TargetHttpsProxy resource to delete.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Location : path
Flat Path : projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}
▼ ▲ compute.targetHttpsProxies.setQuicOverride
Parameters :
targetHttpsProxy
Description : Name of the TargetHttpsProxy resource to set the QUIC override policy for. The name should conform to RFC1035.
Required : Yes
Location : path
Type : string
requestId
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).
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
Required : Yes
Description : Project ID for this request.
Description : Sets the QUIC override policy for TargetHttpsProxy.
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}/setQuicOverride
Parameter Order :
Scopes :
Path : projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}/setQuicOverride
HTTP Method : POST
▼ ▲ compute.targetHttpsProxies.list
Parameters :
pageToken
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.
Type : string
project
Type : string
Location : path
Description : Project ID for this request.
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])?))
filter
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.
Type : string
maxResults
Default : 500
Minimum : 0
Format : uint32
Location : query
Type : integer
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
Type : string
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.
Scopes :
Description : Retrieves the list of TargetHttpsProxy resources available to the specified project.
Apiversion : 2026-12-01-preview
Path : projects/{project}/global/targetHttpsProxies
Flat Path : projects/{project}/global/targetHttpsProxies
Parameter Order : project
HTTP Method : GET
▼ ▲ compute.targetHttpsProxies.setUrlMap
Path : projects/{project}/targetHttpsProxies/{targetHttpsProxy}/setUrlMap
Scopes :
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).
Location : query
Type : string
targetHttpsProxy
Description : Name of the TargetHttpsProxy resource whose URL map is to be set.
Location : path
Type : string
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
project
Description : Project ID for this request.
Location : path
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])?))
Type : string
Apiversion : 2026-12-01-preview
Description : Changes the URL map for TargetHttpsProxy.
Flat Path : projects/{project}/targetHttpsProxies/{targetHttpsProxy}/setUrlMap
HTTP Method : POST
Parameter Order :
▼ ▲ compute.targetHttpsProxies.insert
Flat Path : projects/{project}/global/targetHttpsProxies
HTTP Method : POST
Apiversion : 2026-12-01-preview
Path : projects/{project}/global/targetHttpsProxies
Scopes :
Parameters :
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])?))
Description : Project ID for this request.
Type : string
Required : Yes
requestId
Type : string
Location : query
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).
Description : Creates a TargetHttpsProxy resource in the specified project using the data included in the request.
Parameter Order : project
▼ ▲ compute.targetHttpsProxies.patch
Description : Patches the specified TargetHttpsProxy resource with the data included in the request. This method supports PATCH semantics and usesJSON merge patch format and processing rules.
HTTP Method : PATCH
Flat Path : projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}
Parameter Order :
Scopes :
Path : projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}
Apiversion : 2026-12-01-preview
Parameters :
targetHttpsProxy
Location : path
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the TargetHttpsProxy resource to patch.
Type : string
requestId
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).
Location : query
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])?))
Location : path
Description : Project ID for this request.
Type : string
▼ ▲ compute.targetHttpsProxies.aggregatedList
Parameters :
serviceProjectNumber
Format : int64
Location : query
Type : string
Description : The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.
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.
includeAllScopes
Description : Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
Location : query
Type : boolean
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.
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.
Type : string
Location : query
project
Description : Name of the project scoping this request.
Location : path
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])?))
maxResults
Default : 500
Minimum : 0
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`)
Location : query
Type : integer
Path : projects/{project}/aggregated/targetHttpsProxies
Apiversion : 2026-12-01-preview
Description : Retrieves the list of all TargetHttpsProxy resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.
Flat Path : projects/{project}/aggregated/targetHttpsProxies
HTTP Method : GET
Scopes :
Parameter Order : project
▼ ▲ compute.targetHttpsProxies.setSslPolicy
Apiversion : 2026-12-01-preview
Parameters :
project
Type : string
Location : path
Required : Yes
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])?))
targetHttpsProxy
Location : path
Description : Name of the TargetHttpsProxy resource whose SSL policy is to be set. The name must be 1-63 characters long, and comply with RFC1035.
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).
Type : string
Location : query
Path : projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}/setSslPolicy
Parameter Order :
Scopes :
HTTP Method : POST
Flat Path : projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}/setSslPolicy
Description : Sets the SSL policy for TargetHttpsProxy. The SSL policy specifies the server-side support for SSL features. This affects connections between clients and the HTTPS proxy load balancer. They do not affect the connection between the load balancer and the backends.
▼ ▲ compute.targetHttpsProxies.setCertificateMap
Description : Changes the Certificate Map for TargetHttpsProxy.
Parameters :
project
Type : string
Location : path
Required : Yes
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])?))
targetHttpsProxy
Required : Yes
Type : string
Location : path
Description : Name of the TargetHttpsProxy resource whose CertificateMap is to be set. The name must be 1-63 characters long, and comply with RFC1035.
requestId
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).
Location : query
Apiversion : 2026-12-01-preview
Path : projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}/setCertificateMap
HTTP Method : POST
Parameter Order :
Scopes :
Flat Path : projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}/setCertificateMap
▼ ▲ compute.targetHttpsProxies.setSslCertificates
Apiversion : 2026-12-01-preview
Path : projects/{project}/targetHttpsProxies/{targetHttpsProxy}/setSslCertificates
Description : Replaces SslCertificates for TargetHttpsProxy.
Parameters :
targetHttpsProxy
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Description : Name of the TargetHttpsProxy resource to set an SslCertificates resource for.
Type : string
Required : Yes
requestId
Location : query
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
project
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])?))
Required : Yes
Description : Project ID for this request.
Parameter Order :
Scopes :
HTTP Method : POST
Flat Path : projects/{project}/targetHttpsProxies/{targetHttpsProxy}/setSslCertificates
▼ ▲ compute.targetHttpsProxies.get
Parameters :
targetHttpsProxy
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the TargetHttpsProxy resource to return.
Location : path
Type : string
project
Required : Yes
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])?))
Type : string
Location : path
Apiversion : 2026-12-01-preview
Parameter Order :
Scopes :
Description : Returns the specified TargetHttpsProxy resource.
Flat Path : projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}
HTTP Method : GET
Path : projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}
▼ ▲ compute.managedRulesets.get
Scopes :
Parameter Order :
Apiversion : 2026-12-01-preview
Description : Gets the details for the specified managed ruleset name.
Parameters :
managedRuleset
Location : path
Description : Name of the managed ruleset to return.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Required : Yes
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])?))
Description : Project ID for this request.
Type : string
Required : Yes
Flat Path : projects/{project}/global/managedRulesets/{managedRuleset}
HTTP Method : GET
Path : projects/{project}/global/managedRulesets/{managedRuleset}
▼ ▲ compute.managedRulesets.list
Path : projects/{project}/global/managedRulesets
HTTP Method : GET
Flat Path : projects/{project}/global/managedRulesets
Description : Retrieves the list of all the managed rulesets available.
Apiversion : 2026-12-01-preview
Scopes :
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
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
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.
Required : Yes
Location : path
Type : string
maxResults
Type : integer
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`)
Minimum : 0
Location : query
Format : uint32
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.
Parameter Order : project
▼ ▲ compute.targetTcpProxies.get
Description : Returns the specified TargetTcpProxy resource.
HTTP Method : GET
Flat Path : projects/{project}/global/targetTcpProxies/{targetTcpProxy}
Apiversion : 2026-12-01-preview
Parameter Order :
Scopes :
Parameters :
project
Description : Project ID for this request.
Type : string
Location : path
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])?))
targetTcpProxy
Required : Yes
Type : string
Description : Name of the TargetTcpProxy resource to return.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Path : projects/{project}/global/targetTcpProxies/{targetTcpProxy}
▼ ▲ compute.targetTcpProxies.setBackendService
Path : projects/{project}/global/targetTcpProxies/{targetTcpProxy}/setBackendService
Parameters :
project
Description : Project ID for this request.
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])?))
Type : string
Location : path
targetTcpProxy
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the TargetTcpProxy resource whose BackendService resource is to be set.
Required : Yes
Type : string
Location : path
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).
Apiversion : 2026-12-01-preview
Description : Changes the BackendService for TargetTcpProxy.
Parameter Order :
Scopes :
HTTP Method : POST
Flat Path : projects/{project}/global/targetTcpProxies/{targetTcpProxy}/setBackendService
▼ ▲ compute.targetTcpProxies.insert
Path : projects/{project}/global/targetTcpProxies
Scopes :
Flat Path : projects/{project}/global/targetTcpProxies
Description : Creates a TargetTcpProxy resource in the specified project using the data included in the request.
HTTP Method : POST
Parameter Order : project
Parameters :
project
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])?))
Description : Project ID for this request.
Required : Yes
Location : path
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).
Apiversion : 2026-12-01-preview
▼ ▲ compute.targetTcpProxies.setProxyHeader
HTTP Method : POST
Scopes :
Description : Changes the ProxyHeaderType for TargetTcpProxy.
Parameters :
targetTcpProxy
Description : Name of the TargetTcpProxy resource whose ProxyHeader is to be set.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
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])?))
Location : path
Type : string
Description : Project ID for this request.
Required : Yes
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 :
Path : projects/{project}/global/targetTcpProxies/{targetTcpProxy}/setProxyHeader
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/global/targetTcpProxies/{targetTcpProxy}/setProxyHeader
▼ ▲ compute.targetTcpProxies.testIamPermissions
Parameters :
resource
Description : Name or id of the resource for this request.
Type : string
Location : path
Required : Yes
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
Type : string
Description : Project ID for this request.
Required : Yes
Flat Path : projects/{project}/global/targetTcpProxies/{resource}/testIamPermissions
Apiversion : 2026-12-01-preview
Scopes :
Path : projects/{project}/global/targetTcpProxies/{resource}/testIamPermissions
Parameter Order :
HTTP Method : POST
Description : Returns permissions that a caller has on the specified resource.
▼ ▲ compute.targetTcpProxies.aggregatedList
Path : projects/{project}/aggregated/targetTcpProxies
HTTP Method : GET
Parameter Order : project
Scopes :
Description : Retrieves the list of all TargetTcpProxy resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.
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
includeAllScopes
Location : query
Description : Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
Type : boolean
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.
Type : string
Location : query
maxResults
Type : integer
Location : query
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
Minimum : 0
Format : uint32
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
serviceProjectNumber
Format : int64
Location : query
Type : string
Description : The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.
project
Description : Name of the project scoping 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])?))
Type : string
Required : Yes
Flat Path : projects/{project}/aggregated/targetTcpProxies
Apiversion : 2026-12-01-preview
▼ ▲ compute.targetTcpProxies.list
Parameter Order : project
Apiversion : 2026-12-01-preview
Parameters :
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.
maxResults
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
Location : query
Format : uint32
Type : integer
filter
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.
Type : string
project
Description : Project ID for this request.
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])?))
Required : Yes
Location : path
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
Path : projects/{project}/global/targetTcpProxies
HTTP Method : GET
Description : Retrieves the list of TargetTcpProxy resources available to the specified project.
Flat Path : projects/{project}/global/targetTcpProxies
Scopes :
▼ ▲ compute.targetTcpProxies.delete
Flat Path : projects/{project}/global/targetTcpProxies/{targetTcpProxy}
Scopes :
HTTP Method : DELETE
Path : projects/{project}/global/targetTcpProxies/{targetTcpProxy}
Parameter Order :
Apiversion : 2026-12-01-preview
Parameters :
project
Location : path
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])?))
Type : string
Required : Yes
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
targetTcpProxy
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the TargetTcpProxy resource to delete.
Type : string
Required : Yes
Location : path
Description : Deletes the specified TargetTcpProxy resource.
▼ ▲ compute.urlMaps.aggregatedList
Scopes :
Apiversion : 2026-12-01-preview
Path : projects/{project}/aggregated/urlMaps
Flat Path : projects/{project}/aggregated/urlMaps
Parameters :
project
Description : Name of the project scoping 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])?))
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
serviceProjectNumber
Format : int64
Description : The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.
Location : query
Type : string
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.
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`)
Location : query
Minimum : 0
Type : integer
Format : uint32
Default : 500
includeAllScopes
Type : boolean
Description : Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
Location : query
filter
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.
Location : query
HTTP Method : GET
Parameter Order : project
Description : Retrieves the list of all UrlMap resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.
▼ ▲ compute.urlMaps.list
Scopes :
Parameter Order : project
HTTP Method : GET
Description : Retrieves the list of UrlMap resources available to the specified project.
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.
Type : string
Location : query
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.
Location : query
Type : string
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])?))
Description : Project ID for this request.
Type : string
Required : Yes
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.
Type : string
Location : query
maxResults
Default : 500
Minimum : 0
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`)
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/global/urlMaps
Path : projects/{project}/global/urlMaps
▼ ▲ compute.urlMaps.validate
Scopes :
Parameter Order :
HTTP Method : POST
Path : projects/{project}/global/urlMaps/{urlMap}/validate
Parameters :
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])?))
Description : Project ID for this request.
Type : string
Required : Yes
urlMap
Required : Yes
Description : Name of the UrlMap resource to be validated as.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Type : string
Description : Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap.
Flat Path : projects/{project}/global/urlMaps/{urlMap}/validate
Apiversion : 2026-12-01-preview
▼ ▲ compute.urlMaps.invalidateCache
Parameters :
requestId
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).
Location : query
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
Location : path
Type : string
Description : Project ID for this request.
urlMap
Description : Name of the UrlMap scoping this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Type : string
Location : path
Scopes :
Parameter Order :
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/global/urlMaps/{urlMap}/invalidateCache
Description : Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap. For more information, see [Invalidating cached content](/cdn/docs/invalidating-cached-content).
Path : projects/{project}/global/urlMaps/{urlMap}/invalidateCache
HTTP Method : POST
▼ ▲ compute.urlMaps.testIamPermissions
Flat Path : projects/{project}/global/urlMaps/{resource}/testIamPermissions
Description : Returns permissions that a caller has on the specified resource.
Parameters :
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])?))
Description : Project ID for this request.
Required : Yes
Type : string
resource
Location : path
Required : Yes
Pattern : [a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Description : Name or id of the resource for this request.
Apiversion : 2026-12-01-preview
Scopes :
HTTP Method : POST
Path : projects/{project}/global/urlMaps/{resource}/testIamPermissions
Parameter Order :
▼ ▲ compute.urlMaps.patch
Parameter Order :
Description : Patches the specified UrlMap resource with the data included in the request. This method supportsPATCH semantics and uses theJSON merge patch format and processing rules.
Flat Path : projects/{project}/global/urlMaps/{urlMap}
HTTP Method : PATCH
Path : projects/{project}/global/urlMaps/{urlMap}
Parameters :
urlMap
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the UrlMap resource to patch.
Location : path
Type : string
Required : Yes
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.
Required : Yes
Type : string
Location : path
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).
Apiversion : 2026-12-01-preview
Scopes :
▼ ▲ compute.urlMaps.insert
Parameter Order : project
Scopes :
Path : projects/{project}/global/urlMaps
Flat Path : projects/{project}/global/urlMaps
Description : Creates a UrlMap resource in the specified project using the data included in the request.
HTTP Method : POST
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])?))
Type : string
Required : Yes
Location : path
Description : Project ID for 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).
Location : query
Type : string
Apiversion : 2026-12-01-preview
▼ ▲ compute.urlMaps.delete
Apiversion : 2026-12-01-preview
Parameters :
project
Description : Project ID for this request.
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])?))
Location : path
requestId
Location : query
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
urlMap
Required : Yes
Type : string
Location : path
Description : Name of the UrlMap resource to delete.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Deletes the specified UrlMap resource.
Path : projects/{project}/global/urlMaps/{urlMap}
Parameter Order :
Scopes :
Flat Path : projects/{project}/global/urlMaps/{urlMap}
HTTP Method : DELETE
▼ ▲ compute.urlMaps.get
HTTP Method : GET
Scopes :
Parameters :
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
urlMap
Location : path
Description : Name of the UrlMap resource to return.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Required : Yes
Description : Returns the specified UrlMap resource.
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/global/urlMaps/{urlMap}
Path : projects/{project}/global/urlMaps/{urlMap}
Parameter Order :
▼ ▲ compute.urlMaps.update
Apiversion : 2026-12-01-preview
Parameters :
project
Type : string
Description : Project ID for this request.
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])?))
Location : path
urlMap
Type : string
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the UrlMap resource to update.
Location : path
requestId
Location : query
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
Flat Path : projects/{project}/global/urlMaps/{urlMap}
Path : projects/{project}/global/urlMaps/{urlMap}
Description : Updates the specified UrlMap resource with the data included in the request.
Parameter Order :
Scopes :
HTTP Method : PUT
▼ ▲ compute.backendServices.getHealth
Parameter Order :
HTTP Method : POST
Scopes :
Description : Gets the most recent health check results for this BackendService. Example request body: { "group": "/zones/us-east1-b/instanceGroups/lb-backend-example" }
Apiversion : 2026-12-01-preview
Parameters :
project
Location : path
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])?))
Type : string
backendService
Required : Yes
Type : string
Location : path
Description : Name of the BackendService resource to which the queried instance belongs.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Path : projects/{project}/global/backendServices/{backendService}/getHealth
Flat Path : projects/{project}/global/backendServices/{backendService}/getHealth
▼ ▲ compute.backendServices.listUsable
Path : projects/{project}/global/backendServices/listUsable
Description : Retrieves a list of all usable backend services for Application Load Balancers and Proxy Network Load Balancers in the specified project. Backend services for external and internal passthrough Network Load Balancers are not included in the response.
HTTP Method : GET
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/global/backendServices/listUsable
Parameter Order : project
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.
Type : string
Location : query
filter
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.
Type : string
orderBy
Type : string
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.
project
Type : string
Description : Project ID for this request.
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])?))
Location : path
maxResults
Minimum : 0
Format : uint32
Default : 500
Type : integer
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`)
Location : query
Scopes :
▼ ▲ compute.backendServices.getIamPolicy
Description : Gets the access control policy for a resource. May be empty if no such policy or resource exists.
Path : projects/{project}/global/backendServices/{resource}/getIamPolicy
Flat Path : projects/{project}/global/backendServices/{resource}/getIamPolicy
Parameters :
optionsRequestedPolicyVersion
Location : query
Type : integer
Description : Requested IAM Policy version.
Format : int32
resource
Pattern : [a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Type : string
Location : path
Description : Name or id of the resource for this request.
project
Required : Yes
Type : string
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])?))
Parameter Order :
Apiversion : 2026-12-01-preview
Scopes :
HTTP Method : GET
▼ ▲ compute.backendServices.deleteSignedUrlKey
Path : projects/{project}/global/backendServices/{backendService}/deleteSignedUrlKey
HTTP Method : POST
Description : Deletes a key for validating requests with signed URLs for this backend service.
Parameter Order :
Scopes :
Flat Path : projects/{project}/global/backendServices/{backendService}/deleteSignedUrlKey
Parameters :
keyName
Location : query
Description : The name of the Signed URL Key to delete.
Type : string
Required : Yes
project
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])?))
Description : Project ID for this request.
Required : Yes
requestId
Type : string
Location : query
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).
backendService
Location : path
Description : Name of the BackendService resource to which the Signed URL Key should be added. The name should conform to RFC1035.
Required : Yes
Type : string
Apiversion : 2026-12-01-preview
▼ ▲ compute.backendServices.update
HTTP Method : PUT
Parameter Order :
Path : projects/{project}/global/backendServices/{backendService}
Scopes :
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/global/backendServices/{backendService}
Description : Updates the specified BackendService resource with the data included in the request. For more information, seeBackend services overview.
Parameters :
requestId
Location : query
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
backendService
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Type : string
Description : Name of the BackendService resource to update.
Location : path
project
Required : Yes
Description : Project ID for this request.
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])?))
Location : path
▼ ▲ compute.backendServices.get
Apiversion : 2026-12-01-preview
Parameter Order :
Description : Returns the specified BackendService resource.
Parameters :
project
Location : path
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])?))
Required : Yes
Type : string
backendService
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the BackendService resource to return.
Required : Yes
Flat Path : projects/{project}/global/backendServices/{backendService}
Scopes :
HTTP Method : GET
Path : projects/{project}/global/backendServices/{backendService}
▼ ▲ compute.backendServices.list
Apiversion : 2026-12-01-preview
Path : projects/{project}/global/backendServices
Parameters :
orderBy
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.
Location : query
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
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.
Type : string
Location : path
filter
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.
Location : query
maxResults
Format : uint32
Type : integer
Minimum : 0
Default : 500
Location : query
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`)
Parameter Order : project
Description : Retrieves the list of BackendService resources available to the specified project.
Flat Path : projects/{project}/global/backendServices
Scopes :
HTTP Method : GET
▼ ▲ compute.backendServices.getEffectiveSecurityPolicies
Flat Path : projects/{project}/global/backendServices/{backendService}/getEffectiveSecurityPolicies
Apiversion : 2026-12-01-preview
Parameter Order :
Parameters :
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
backendService
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Required : Yes
Location : path
Description : Name of the Backend Service for this request.
HTTP Method : GET
Description : Returns effective security policies applied to this backend service.
Scopes :
Path : projects/{project}/global/backendServices/{backendService}/getEffectiveSecurityPolicies
▼ ▲ compute.backendServices.setIamPolicy
Description : Sets the access control policy on the specified resource. Replaces any existing policy.
Parameter Order :
Parameters :
project
Type : string
Location : path
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])?))
Required : Yes
resource
Pattern : [a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Type : string
Description : Name or id of the resource for this request.
Location : path
Scopes :
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/global/backendServices/{resource}/setIamPolicy
Path : projects/{project}/global/backendServices/{resource}/setIamPolicy
HTTP Method : POST
▼ ▲ compute.backendServices.insert
HTTP Method : POST
Flat Path : projects/{project}/global/backendServices
Description : Creates a BackendService resource in the specified project using the data included in the request. For more information, see Backend services overview.
Path : projects/{project}/global/backendServices
Scopes :
Parameter Order : project
Apiversion : 2026-12-01-preview
Parameters :
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 : Project ID for this request.
Location : path
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).
▼ ▲ compute.backendServices.testIamPermissions
Description : Returns permissions that a caller has on the specified resource.
Apiversion : 2026-12-01-preview
Path : projects/{project}/global/backendServices/{resource}/testIamPermissions
Flat Path : projects/{project}/global/backendServices/{resource}/testIamPermissions
Parameters :
project
Type : string
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
resource
Required : Yes
Description : Name or id of the resource for this request.
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
HTTP Method : POST
Scopes :
Parameter Order :
▼ ▲ compute.backendServices.aggregatedList
Flat Path : projects/{project}/aggregated/backendServices
Parameter Order : project
Path : projects/{project}/aggregated/backendServices
HTTP Method : GET
Scopes :
Description : Retrieves the list of all BackendService resources, regional and global, available to the specified project. To prevent failure, it is recommended that you set the `returnPartialSuccess` parameter to `true`.
Apiversion : 2026-12-01-preview
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.
Type : string
Location : query
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
project
Location : path
Description : Name of the project scoping this request.
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])?))
Type : string
includeAllScopes
Type : boolean
Location : query
Description : Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
maxResults
Type : integer
Default : 500
Minimum : 0
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`)
Location : query
serviceProjectNumber
Format : int64
Description : The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.
Type : string
Location : query
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
▼ ▲ compute.backendServices.delete
Scopes :
Flat Path : projects/{project}/global/backendServices/{backendService}
Parameters :
requestId
Location : query
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
backendService
Type : string
Location : path
Description : Name of the BackendService resource to delete.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
project
Location : path
Description : Project ID for this request.
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])?))
Required : Yes
Parameter Order :
Apiversion : 2026-12-01-preview
Path : projects/{project}/global/backendServices/{backendService}
Description : Deletes the specified BackendService resource.
HTTP Method : DELETE
▼ ▲ compute.backendServices.patch
Scopes :
Apiversion : 2026-12-01-preview
Description : Patches the specified BackendService resource with the data included in the request. For more information, see Backend services overview. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.
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.
Type : string
Required : Yes
requestId
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).
Location : query
backendService
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Description : Name of the BackendService resource to patch.
Location : path
Path : projects/{project}/global/backendServices/{backendService}
Parameter Order :
HTTP Method : PATCH
Flat Path : projects/{project}/global/backendServices/{backendService}
▼ ▲ compute.backendServices.addSignedUrlKey
Apiversion : 2026-12-01-preview
Parameters :
project
Location : path
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])?))
Description : Project ID for this request.
Required : Yes
backendService
Location : path
Description : Name of the BackendService resource to which the Signed URL Key should be added. The name should conform to RFC1035.
Required : Yes
Type : string
requestId
Type : string
Location : query
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).
Description : Adds a key for validating requests with signed URLs for this backend service.
Flat Path : projects/{project}/global/backendServices/{backendService}/addSignedUrlKey
Parameter Order :
Scopes :
HTTP Method : POST
Path : projects/{project}/global/backendServices/{backendService}/addSignedUrlKey
▼ ▲ compute.backendServices.setSecurityPolicy
Path : projects/{project}/global/backendServices/{backendService}/setSecurityPolicy
HTTP Method : POST
Parameters :
backendService
Required : Yes
Type : string
Location : path
Description : Name of the BackendService resource to which the security policy should be set. The name should conform to RFC1035.
project
Description : Project ID for this request.
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])?))
Type : string
Location : path
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).
Scopes :
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/global/backendServices/{backendService}/setSecurityPolicy
Parameter Order :
Description : Sets the Google Cloud Armor security policy for the specified backend service. For more information, seeGoogle Cloud Armor Overview
▼ ▲ compute.backendServices.setEdgeSecurityPolicy
Path : projects/{project}/global/backendServices/{backendService}/setEdgeSecurityPolicy
Apiversion : 2026-12-01-preview
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
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.
Required : Yes
Location : path
Type : string
backendService
Required : Yes
Type : string
Location : path
Description : Name of the BackendService resource to which the edge security policy should be set. The name should conform to RFC1035.
Scopes :
Description : Sets the edge security policy for the specified backend service.
Flat Path : projects/{project}/global/backendServices/{backendService}/setEdgeSecurityPolicy
HTTP Method : POST
Parameter Order :
▼ ▲ compute.machineImages.setIamPolicy
Parameter Order :
HTTP Method : POST
Parameters :
project
Required : Yes
Description : Project ID for this request.
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])?))
resource
Required : Yes
Pattern : [a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Type : string
Description : Name or id of the resource for this request.
Apiversion : 2026-12-01-preview
Scopes :
Path : projects/{project}/global/machineImages/{resource}/setIamPolicy
Description : Sets the access control policy on the specified resource. Replaces any existing policy.
Flat Path : projects/{project}/global/machineImages/{resource}/setIamPolicy
▼ ▲ compute.machineImages.insert
Path : projects/{project}/global/machineImages
Flat Path : projects/{project}/global/machineImages
HTTP Method : POST
Apiversion : 2026-12-01-preview
Parameters :
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])?))
Description : Project ID for this request.
Type : string
Required : Yes
sourceInstance
Location : query
Type : string
Description : Required. Source instance that is used to create the machine image from.
requestId
Location : query
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
Description : Creates a machine image in the specified project using the data that is included in the request. If you are creating a new machine image to update an existing instance, your new machine image should use the same network or, if applicable, the same subnetwork as the original instance.
Scopes :
Parameter Order : project
▼ ▲ compute.machineImages.testIamPermissions
Path : projects/{project}/global/machineImages/{resource}/testIamPermissions
Flat Path : projects/{project}/global/machineImages/{resource}/testIamPermissions
Description : Returns permissions that a caller has on the specified resource.
Apiversion : 2026-12-01-preview
Scopes :
Parameters :
project
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])?))
Description : Project ID for this request.
Required : Yes
resource
Required : Yes
Description : Name or id of the resource for this request.
Location : path
Pattern : [a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Parameter Order :
HTTP Method : POST
▼ ▲ compute.machineImages.delete
Flat Path : projects/{project}/global/machineImages/{machineImage}
Path : projects/{project}/global/machineImages/{machineImage}
HTTP Method : DELETE
Parameters :
machineImage
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Description : The name of the machine image to delete.
Location : path
Type : string
requestId
Type : string
Location : query
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).
project
Description : Project ID for this request.
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])?))
Location : path
Parameter Order :
Apiversion : 2026-12-01-preview
Scopes :
Description : Deletes the specified machine image. Deleting a machine image is permanent and cannot be undone.
▼ ▲ compute.machineImages.get
Parameter Order :
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/global/machineImages/{machineImage}
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.
Type : string
Required : Yes
machineImage
Required : Yes
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : The name of the machine image.
Location : path
Path : projects/{project}/global/machineImages/{machineImage}
HTTP Method : GET
Description : Returns the specified machine image.
Scopes :
▼ ▲ compute.machineImages.getIamPolicy
HTTP Method : GET
Flat Path : projects/{project}/global/machineImages/{resource}/getIamPolicy
Apiversion : 2026-12-01-preview
Parameters :
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])?))
Type : string
Required : Yes
resource
Description : Name or id of the resource for this request.
Type : string
Required : Yes
Pattern : [a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
optionsRequestedPolicyVersion
Format : int32
Location : query
Type : integer
Description : Requested IAM Policy version.
Path : projects/{project}/global/machineImages/{resource}/getIamPolicy
Scopes :
Parameter Order :
Description : Gets the access control policy for a resource. May be empty if no such policy or resource exists.
▼ ▲ compute.machineImages.list
Description : Retrieves a list of machine images that are contained within the specified project.
Parameter Order : project
Flat Path : projects/{project}/global/machineImages
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`)
Type : integer
Default : 500
Minimum : 0
Location : query
Format : uint32
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.
project
Description : Project ID for this request.
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])?))
Location : path
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.
Location : query
Type : string
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
Apiversion : 2026-12-01-preview
Scopes :
HTTP Method : GET
Path : projects/{project}/global/machineImages
▼ ▲ compute.machineImages.setLabels
Flat Path : projects/{project}/global/machineImages/{resource}/setLabels
Apiversion : 2026-12-01-preview
Parameters :
resource
Pattern : [a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Description : Name or id of the resource for this request.
Type : string
Location : path
project
Location : path
Description : Project ID for this request.
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])?))
Type : string
Scopes :
HTTP Method : POST
Path : projects/{project}/global/machineImages/{resource}/setLabels
Description : Sets the labels on a machine image. To learn more about labels, read theLabeling Resources documentation.
Parameter Order :
▼ ▲ compute.interconnectAttachments.aggregatedList
Path : projects/{project}/aggregated/interconnectAttachments
HTTP Method : GET
Flat Path : projects/{project}/aggregated/interconnectAttachments
Scopes :
Apiversion : 2026-12-01-preview
Parameters :
includeAllScopes
Location : query
Description : Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
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.
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
serviceProjectNumber
Type : string
Description : The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.
Format : int64
Location : query
maxResults
Location : query
Type : integer
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
Minimum : 0
project
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])?))
Location : path
Type : string
Required : Yes
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
Description : Retrieves an aggregated list of interconnect attachments. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.
Parameter Order : project
▼ ▲ compute.interconnectAttachments.insert
Description : Creates an InterconnectAttachment in the specified project using the data included in the request.
Flat Path : projects/{project}/regions/{region}/interconnectAttachments
HTTP Method : POST
Parameter Order :
Path : projects/{project}/regions/{region}/interconnectAttachments
Scopes :
Parameters :
validateOnly
Description : If true, the request will not be committed.
Location : query
Type : boolean
project
Description : Project ID for this request.
Location : path
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])?))
region
Location : path
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Name of the region for this request.
Required : Yes
requestId
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).
Location : query
Apiversion : 2026-12-01-preview
▼ ▲ compute.interconnectAttachments.setLabels
Parameter Order :
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
resource
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Type : string
Required : Yes
Description : Name or id of the resource for this request.
project
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])?))
Description : Project ID for this request.
region
Description : The region for this request.
Type : string
Required : Yes
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Path : projects/{project}/regions/{region}/interconnectAttachments/{resource}/setLabels
Description : Sets the labels on an InterconnectAttachment. To learn more about labels, read the Labeling Resources documentation.
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/regions/{region}/interconnectAttachments/{resource}/setLabels
Scopes :
HTTP Method : POST
▼ ▲ compute.interconnectAttachments.get
Apiversion : 2026-12-01-preview
Parameters :
interconnectAttachment
Required : Yes
Type : string
Location : path
Description : Name of the interconnect attachment to return.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
project
Location : path
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])?))
Type : string
Required : Yes
region
Description : Name of the region for this request.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Location : path
Parameter Order :
Flat Path : projects/{project}/regions/{region}/interconnectAttachments/{interconnectAttachment}
Description : Returns the specified interconnect attachment.
Scopes :
HTTP Method : GET
Path : projects/{project}/regions/{region}/interconnectAttachments/{interconnectAttachment}
▼ ▲ compute.interconnectAttachments.patch
Description : Updates the specified interconnect attachment with the data included in the request. This method supportsPATCH semantics and uses theJSON merge patch format and processing rules.
Flat Path : projects/{project}/regions/{region}/interconnectAttachments/{interconnectAttachment}
Parameters :
region
Description : Name of the region scoping this request.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
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
interconnectAttachment
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Location : path
Type : string
Description : Name of the interconnect attachment to patch.
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
Type : string
Description : Project ID for this request.
Required : Yes
Parameter Order :
Apiversion : 2026-12-01-preview
HTTP Method : PATCH
Scopes :
Path : projects/{project}/regions/{region}/interconnectAttachments/{interconnectAttachment}
▼ ▲ compute.interconnectAttachments.delete
Parameter Order :
Path : projects/{project}/regions/{region}/interconnectAttachments/{interconnectAttachment}
HTTP Method : DELETE
Parameters :
interconnectAttachment
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Description : Name of the interconnect attachment to delete.
Required : Yes
requestId
Location : query
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
region
Location : path
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Name of the region for this request.
Required : Yes
project
Description : Project ID for this request.
Type : string
Location : path
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])?))
Scopes :
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/regions/{region}/interconnectAttachments/{interconnectAttachment}
Description : Deletes the specified interconnect attachment.
▼ ▲ compute.interconnectAttachments.list
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/regions/{region}/interconnectAttachments
Path : projects/{project}/regions/{region}/interconnectAttachments
Parameters :
region
Required : Yes
Description : Name of the region for this request.
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
project
Location : path
Required : Yes
Description : Project ID for this request.
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])?))
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`)
Location : query
Type : integer
Format : uint32
Default : 500
Minimum : 0
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.
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.
Type : string
Location : query
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
Scopes :
Description : Retrieves the list of interconnect attachments contained within the specified region.
Parameter Order :
HTTP Method : GET
▼ ▲ compute.reservationSlots.getHealth
Parameter Order :
Flat Path : projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks/{reservationSubBlocksId}/reservationSlots/{reservationSlot}/getHealth
Apiversion : 2026-12-01-preview
Description : Get health info on a reservation slot.
Parameters :
reservationSlot
Required : Yes
Type : string
Description : The name of the reservation slot. Name should conform to RFC1035 or be a resource ID.
Location : path
requestId
Location : query
Type : string
Description : An optional request ID to identify requests.
zone
Description : Name of the zone for this request. Zone name should conform to RFC1035.
Location : path
Type : string
Required : Yes
parentName
Required : Yes
Pattern : reservations/([a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19})/reservationBlocks/([a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19})/reservationSubBlocks/([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 parent reservation, parent block and parent sub-block. In the format of reservations/{reservation_name}/reservationBlocks/{reservation_block_name}/reservationSubBlocks/{reservation_sub_block_name}
project
Description : Project ID for this request.
Location : path
Type : string
Required : Yes
Path : projects/{project}/zones/{zone}/{+parentName}/reservationSlots/{reservationSlot}/getHealth
HTTP Method : POST
Scopes :
▼ ▲ compute.reservationSlots.list
Scopes :
Apiversion : 2026-12-01-preview
Path : projects/{project}/zones/{zone}/{+parentName}/reservationSlots
Parameters :
zone
Description : The name of the zone for this request, formatted as RFC1035.
Location : path
Type : string
Required : Yes
maxResults
Default : 500
Minimum : 0
Type : integer
Location : query
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`)
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.
Location : query
Type : string
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.
parentName
Description : The name of the parent reservation and parent block, formatted as reservations/{reservation_name}/reservationBlocks/{reservation_block_name}/reservationSubBlocks/{reservation_sub_block_name}
Required : Yes
Pattern : reservations/([a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19})/reservationBlocks/([a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19})/reservationSubBlocks/([a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19})
Type : string
Location : path
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
project
Type : string
Location : path
Required : Yes
Description : The project ID for this request.
HTTP Method : GET
Description : Retrieves a list of reservation slots under a single reservation.
Parameter Order :
Flat Path : projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks/{reservationSubBlocksId}/reservationSlots
▼ ▲ compute.reservationSlots.get
Path : projects/{project}/zones/{zone}/{+parentName}/reservationSlots/{reservationSlot}
HTTP Method : GET
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks/{reservationSubBlocksId}/reservationSlots/{reservationSlot}
Description : Retrieves information about the specified reservation slot.
Parameters :
reservationSlot
Location : path
Required : Yes
Type : string
Description : The name of the reservation slot, formatted as RFC1035 or a resource ID number.
project
Type : string
Location : path
Required : Yes
Description : The project ID for this request.
parentName
Location : path
Pattern : reservations/([a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19})/reservationBlocks/([a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19})/reservationSubBlocks/([a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19})
Required : Yes
Description : The name of the parent reservation and parent block, formatted as reservations/{reservation_name}/reservationBlocks/{reservation_block_name}/reservationSubBlocks/{reservation_sub_block_name}
Type : string
zone
Required : Yes
Type : string
Location : path
Description : The name of the zone for this request, formatted as RFC1035.
Scopes :
Parameter Order :
▼ ▲ compute.reservationSlots.getVersion
Parameter Order :
HTTP Method : POST
Description : Allows customers to get SBOM versions of a reservation slot.
Apiversion : 2026-12-01-preview
Scopes :
Parameters :
project
Required : Yes
Description : Project ID for this request.
Location : path
Type : string
requestId
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).
Location : query
reservationSlot
Required : Yes
Type : string
Description : The name of the reservation slot. Name should conform to RFC1035 or be a resource ID.
Location : path
zone
Type : string
Required : Yes
Description : Name of the zone for this request. Zone name should conform to RFC1035.
Location : path
parentName
Description : The name of the parent reservation and parent block. In the format of reservations/{reservation_name}/reservationBlocks/{reservation_block_name}/reservationSubBlocks/{reservation_sub_block_name}
Location : path
Required : Yes
Pattern : reservations/([a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19})/reservationBlocks/([a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19})/reservationSubBlocks/([a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19})
Type : string
Flat Path : projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks/{reservationSubBlocksId}/reservationSlots/{reservationSlot}/getVersion
Path : projects/{project}/zones/{zone}/{+parentName}/reservationSlots/{reservationSlot}/getVersion
▼ ▲ compute.reservationSlots.update
Description : Update a reservation slot in the specified sub-block.
Parameters :
project
Location : path
Type : string
Description : The project ID for this request.
Required : Yes
zone
Location : path
Description : The name of the zone for this request, formatted as RFC1035.
Required : Yes
Type : string
parentName
Location : path
Required : Yes
Pattern : reservations/([a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19})/reservationBlocks/([a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19})/reservationSubBlocks/([a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19})
Description : The name of the sub-block resource.
Type : string
reservationSlot
Type : string
Description : The name of the slot resource.
Required : Yes
Location : path
updateMask
Type : string
Description : The fields to be updated as part of this request.
Format : google-fieldmask
Location : query
Path : projects/{project}/zones/{zone}/{+parentName}/reservationSlots/{reservationSlot}
Apiversion : 2026-12-01-preview
HTTP Method : POST
Parameter Order :
Scopes :
Flat Path : projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks/{reservationSubBlocksId}/reservationSlots/{reservationSlot}
▼ ▲ compute.snapshotSettings.get
Parameters :
project
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])?))
Required : Yes
Location : path
Type : string
Apiversion : 2026-12-01-preview
Description : Get snapshot settings.
Flat Path : projects/{project}/global/snapshotSettings
Parameter Order : project
Scopes :
HTTP Method : GET
Path : projects/{project}/global/snapshotSettings
▼ ▲ compute.snapshotSettings.patch
HTTP Method : PATCH
Flat Path : projects/{project}/global/snapshotSettings
Scopes :
Path : projects/{project}/global/snapshotSettings
Description : Patch snapshot settings.
Parameter Order : project
Apiversion : 2026-12-01-preview
Parameters :
requestId
Type : string
Location : query
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).
updateMask
Format : google-fieldmask
Description : update_mask indicates fields to be updated as part of this request.
Type : string
Location : query
project
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])?))
Required : Yes
Location : path
Description : Project ID for this request.
▼ ▲ compute.sslCertificates.aggregatedList
Flat Path : projects/{project}/aggregated/sslCertificates
Scopes :
HTTP Method : GET
Parameter Order : project
Parameters :
maxResults
Format : uint32
Minimum : 0
Default : 500
Type : integer
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`)
Location : query
serviceProjectNumber
Type : string
Format : int64
Location : query
Description : The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.
project
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])?))
Description : Name of the project scoping this request.
includeAllScopes
Description : Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
Location : query
Type : boolean
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
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
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.
Apiversion : 2026-12-01-preview
Description : Retrieves the list of all SslCertificate resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.
Path : projects/{project}/aggregated/sslCertificates
▼ ▲ compute.sslCertificates.insert
Description : Creates a SslCertificate resource in the specified project using the data included in the request.
HTTP Method : POST
Scopes :
Flat Path : projects/{project}/global/sslCertificates
Path : projects/{project}/global/sslCertificates
Parameter Order : project
Apiversion : 2026-12-01-preview
Parameters :
requestId
Type : string
Location : query
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).
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])?))
Type : string
Location : path
Description : Project ID for this request.
Required : Yes
▼ ▲ compute.sslCertificates.delete
Flat Path : projects/{project}/global/sslCertificates/{sslCertificate}
Apiversion : 2026-12-01-preview
Parameters :
project
Required : Yes
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])?))
Type : string
Location : path
requestId
Location : query
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
sslCertificate
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the SslCertificate resource to delete.
Location : path
Type : string
Parameter Order :
HTTP Method : DELETE
Description : Deletes the specified SslCertificate resource.
Scopes :
Path : projects/{project}/global/sslCertificates/{sslCertificate}
▼ ▲ compute.sslCertificates.list
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/global/sslCertificates
Parameters :
pageToken
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.
Type : string
maxResults
Type : integer
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`)
Location : query
Format : uint32
Default : 500
Minimum : 0
project
Location : path
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])?))
Required : Yes
Type : string
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.
Type : string
Location : query
filter
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.
Location : query
Path : projects/{project}/global/sslCertificates
Description : Retrieves the list of SslCertificate resources available to the specified project.
HTTP Method : GET
Scopes :
Parameter Order : project
▼ ▲ compute.sslCertificates.get
Description : Returns the specified SslCertificate resource.
Scopes :
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/global/sslCertificates/{sslCertificate}
Parameters :
sslCertificate
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the SslCertificate resource to return.
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])?))
Type : string
Required : Yes
Location : path
Description : Project ID for this request.
Parameter Order :
HTTP Method : GET
Path : projects/{project}/global/sslCertificates/{sslCertificate}
▼ ▲ compute.instances.resume
Description : Resumes an instance that was suspended using theinstances().suspend method.
Flat Path : projects/{project}/zones/{zone}/instances/{instance}/resume
Path : projects/{project}/zones/{zone}/instances/{instance}/resume
Scopes :
Parameter Order :
Parameters :
requestId
Location : query
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
instance
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the instance resource to resume.
Required : Yes
project
Location : path
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])?))
Required : Yes
Description : Project ID for this request.
zone
Location : path
Required : Yes
Description : The name of the zone for this request.
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Apiversion : 2026-12-01-preview
HTTP Method : POST
▼ ▲ compute.instances.updateNetworkInterface
Apiversion : 2026-12-01-preview
Parameters :
instance
Type : string
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : The instance name for this request.
Location : path
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
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])?))
Location : path
networkInterface
Required : Yes
Description : The name of the network interface to update.
Location : query
Type : string
zone
Required : Yes
Type : string
Description : The name of the zone for this request.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Flat Path : projects/{project}/zones/{zone}/instances/{instance}/updateNetworkInterface
Parameter Order :
Description : Updates an instance's network interface. This method can only update an interface's alias IP range and attached network. See Modifying alias IP ranges for an existing instance for instructions on changing alias IP ranges. See Migrating a VM between networks for instructions on migrating an interface. This method follows PATCH semantics.
Scopes :
HTTP Method : PATCH
Path : projects/{project}/zones/{zone}/instances/{instance}/updateNetworkInterface
▼ ▲ compute.instances.addResourcePolicies
Description : Adds existing resource policies to an instance. You can only add one policy right now which will be applied to this instance for scheduling live migrations.
Parameter Order :
HTTP Method : POST
Path : projects/{project}/zones/{zone}/instances/{instance}/addResourcePolicies
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
zone
Location : path
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : The name of the zone for this request.
Required : Yes
instance
Description : The instance name for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Required : Yes
Location : path
project
Location : path
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])?))
Description : Project ID for this request.
Required : Yes
Flat Path : projects/{project}/zones/{zone}/instances/{instance}/addResourcePolicies
Apiversion : 2026-12-01-preview
Scopes :
▼ ▲ compute.instances.updateShieldedInstanceConfig
Flat Path : projects/{project}/zones/{zone}/instances/{instance}/updateShieldedInstanceConfig
Path : projects/{project}/zones/{zone}/instances/{instance}/updateShieldedInstanceConfig
Parameters :
instance
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Location : path
Type : string
Description : Name or id of the instance scoping 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).
project
Description : Project ID for this request.
Required : Yes
Location : path
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])?))
zone
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : The name of the zone for this request.
Required : Yes
Type : string
Apiversion : 2026-12-01-preview
Scopes :
Description : Updates the Shielded Instance config for an instance. You can only use this method on a stopped instance. This method supportsPATCH semantics and uses theJSON merge patch format and processing rules.
HTTP Method : PATCH
Parameter Order :
▼ ▲ compute.instances.deleteNetworkInterface
Flat Path : projects/{project}/zones/{zone}/instances/{instance}/deleteNetworkInterface
Scopes :
HTTP Method : POST
Path : projects/{project}/zones/{zone}/instances/{instance}/deleteNetworkInterface
Description : Deletes one dynamic network interface from an active instance. InstancesDeleteNetworkInterfaceRequest indicates: - instance from which to delete, using project+zone+resource_id fields; - dynamic network interface to be deleted, using network_interface_name field;
Parameters :
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 : Project ID for this request.
Location : path
zone
Type : string
Location : path
Description : The name of the zone for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
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
instance
Location : path
Description : The instance name for this request stored as resource_id. Name should conform to RFC1035 or be an unsigned long integer.
Type : string
Required : Yes
networkInterfaceName
Location : query
Description : The name of the dynamic network interface to be deleted from the instance.
Required : Yes
Type : string
Apiversion : 2026-12-01-preview
Parameter Order :
▼ ▲ compute.instances.attachDisk
Flat Path : projects/{project}/zones/{zone}/instances/{instance}/attachDisk
Scopes :
Apiversion : 2026-12-01-preview
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])?))
Type : string
Required : Yes
Location : path
Description : Project ID for this request.
requestId
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).
Location : query
zone
Description : The name of the zone for this request.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Location : path
forceAttach
Description : Whether to force attach the regional disk even if it's currently attached to another instance. If you try to force attach a zonal disk to an instance, you will receive an error.
Location : query
Type : boolean
instance
Location : path
Type : string
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : The instance name for this request.
HTTP Method : POST
Description : Attaches an existing Disk resource to an instance. You must first create the disk before you can attach it. It is not possible to create and attach a disk at the same time. For more information, readAdding a persistent disk to your instance.
Parameter Order :
Path : projects/{project}/zones/{zone}/instances/{instance}/attachDisk
▼ ▲ compute.instances.listReferrers
Scopes :
Parameters :
zone
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Description : The name of the zone for this request.
Type : string
Required : Yes
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.
maxResults
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`)
Minimum : 0
Default : 500
Location : query
Type : integer
orderBy
Type : string
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.
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.
Type : string
Location : query
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])?))
Location : path
Description : Project ID for this request.
Type : string
instance
Required : Yes
Type : string
Location : path
Pattern |[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the target instance scoping this request, or '-' if the request should span over all instances in the container.
Description : Retrieves a list of resources that refer to the VM instance specified in the request. For example, if the VM instance is part of a managed or unmanaged instance group, the referrers list includes the instance group. For more information, readViewing referrers to VM instances.
Apiversion : 2026-12-01-preview
Parameter Order :
HTTP Method : GET
Path : projects/{project}/zones/{zone}/instances/{instance}/referrers
Flat Path : projects/{project}/zones/{zone}/instances/{instance}/referrers
▼ ▲ compute.instances.deleteAccessConfig
Apiversion : 2026-12-01-preview
Description : Deletes an access config from an instance's network interface.
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).
Location : query
Type : string
instance
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Required : Yes
Description : The instance name for this request.
Location : path
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.
Type : string
Location : path
accessConfig
Type : string
Location : query
Required : Yes
Description : The name of the access config to delete.
zone
Type : string
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Description : The name of the zone for this request.
networkInterface
Location : query
Type : string
Description : The name of the network interface.
Required : Yes
Parameter Order :
Scopes :
Flat Path : projects/{project}/zones/{zone}/instances/{instance}/deleteAccessConfig
HTTP Method : POST
Path : projects/{project}/zones/{zone}/instances/{instance}/deleteAccessConfig
▼ ▲ compute.instances.setMetadata
Parameters :
project
Location : path
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])?))
Required : Yes
requestId
Type : string
Location : query
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
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Type : string
Location : path
Description : The name of the zone for this request.
instance
Type : string
Required : Yes
Location : path
Description : Name of the instance scoping this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Sets metadata for the specified instance to the data included in the request.
Parameter Order :
Apiversion : 2026-12-01-preview
Scopes :
Path : projects/{project}/zones/{zone}/instances/{instance}/setMetadata
Flat Path : projects/{project}/zones/{zone}/instances/{instance}/setMetadata
HTTP Method : POST
▼ ▲ compute.instances.setName
Scopes :
HTTP Method : POST
Path : projects/{project}/zones/{zone}/instances/{instance}/setName
Description : Sets name of an instance.
Apiversion : 2026-12-01-preview
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).
Location : query
Type : string
instance
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Required : Yes
Location : path
Description : The instance name for this request.
zone
Required : Yes
Description : The name of the zone for this request.
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
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.
Required : Yes
Location : path
Type : string
Flat Path : projects/{project}/zones/{zone}/instances/{instance}/setName
Parameter Order :
▼ ▲ compute.instances.setDiskAutoDelete
Scopes :
Parameter Order :
Description : Sets the auto-delete flag for a disk attached to an instance.
HTTP Method : POST
Parameters :
autoDelete
Required : Yes
Description : Whether to auto-delete the disk when the instance is deleted.
Type : boolean
Location : query
deviceName
Location : query
Type : string
Description : The device name of the disk to modify. Make a get() request on the instance to view currently attached disks and device names.
Pattern : \w[\w.-]{0,254}
Required : Yes
zone
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : The name of the zone for this request.
Location : path
Type : string
Required : Yes
project
Type : string
Location : path
Description : Project ID for this request.
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])?))
instance
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Description : The instance name for this request.
Location : path
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).
Path : projects/{project}/zones/{zone}/instances/{instance}/setDiskAutoDelete
Flat Path : projects/{project}/zones/{zone}/instances/{instance}/setDiskAutoDelete
Apiversion : 2026-12-01-preview
▼ ▲ compute.instances.getIamPolicy
Parameter Order :
HTTP Method : GET
Description : Gets the access control policy for a resource. May be empty if no such policy or resource exists.
Apiversion : 2026-12-01-preview
Parameters :
zone
Type : string
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Description : The name of the zone for this request.
resource
Type : string
Location : path
Description : Name or id of the resource for this request.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
project
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])?))
Description : Project ID for this request.
Required : Yes
optionsRequestedPolicyVersion
Type : integer
Description : Requested IAM Policy version.
Format : int32
Location : query
Scopes :
Path : projects/{project}/zones/{zone}/instances/{resource}/getIamPolicy
Flat Path : projects/{project}/zones/{zone}/instances/{resource}/getIamPolicy
▼ ▲ compute.instances.list
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])?))
Description : Project ID for this request.
Location : path
Required : Yes
Type : string
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.
Type : string
Location : query
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.
Location : query
Type : string
pageToken
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.
Type : string
maxResults
Location : query
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
Default : 500
zone
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Type : string
Description : The name of the zone for this request.
Parameter Order :
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/zones/{zone}/instances
Path : projects/{project}/zones/{zone}/instances
Scopes :
Description : Retrieves the list of instances contained within the specified zone.
HTTP Method : GET
▼ ▲ compute.instances.getScreenshot
HTTP Method : GET
Parameter Order :
Scopes :
Description : Returns the screenshot from the specified instance.
Path : projects/{project}/zones/{zone}/instances/{instance}/screenshot
Flat Path : projects/{project}/zones/{zone}/instances/{instance}/screenshot
Parameters :
instance
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Type : string
Location : path
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])?))
Location : path
Description : Project ID for this request.
Type : string
Required : Yes
zone
Location : path
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Description : The name of the zone for this request.
Apiversion : 2026-12-01-preview
▼ ▲ compute.instances.get
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/zones/{zone}/instances/{instance}
Parameters :
zone
Required : Yes
Description : The name of the zone for this request.
Location : path
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
instance
Type : string
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Description : Name of the instance resource to return.
project
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])?))
Required : Yes
Location : path
Type : string
Description : Returns the specified Instance resource.
Path : projects/{project}/zones/{zone}/instances/{instance}
HTTP Method : GET
Scopes :
Parameter Order :
▼ ▲ compute.instances.update
Parameter Order :
Parameters :
discardLocalSsd
Location : query
Type : boolean
Description : Whether to discard local SSDs from the instance during restart default value is false.
mostDisruptiveAllowedAction
Enum Descriptions :
Enum :
Description : Specifies the most disruptive action that can be taken on the instance as part of the update. Compute Engine returns an error if the instance properties require a more disruptive action as part of the instance update. Valid options from lowest to highest are NO_EFFECT, REFRESH, and RESTART.
Type : string
Location : query
instance
Description : Name of the instance resource to update.
Type : string
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
zone
Required : Yes
Description : The name of the zone for this request.
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
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
minimalAction
Type : string
Enum Descriptions :
Enum :
Location : query
Description : Specifies the action to take when updating an instance even if the updated properties do not require it. If not specified, then Compute Engine acts based on the minimum action that the updated properties require.
project
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])?))
Required : Yes
Location : path
Description : Project ID for this request.
Flat Path : projects/{project}/zones/{zone}/instances/{instance}
Path : projects/{project}/zones/{zone}/instances/{instance}
Apiversion : 2026-12-01-preview
Description : Updates an instance only if the necessary resources are available. This method can update only a specific set of instance properties. See Updating a running instance for a list of updatable instance properties.
HTTP Method : PUT
Scopes :
▼ ▲ compute.instances.setServiceAccount
Parameters :
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
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : The name of the zone for this request.
Required : Yes
Location : path
Type : string
instance
Description : Name of the instance resource to start.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Type : string
requestId
Type : string
Location : query
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).
Apiversion : 2026-12-01-preview
Description : Sets the service account on the instance. For more information, readChanging the service account and access scopes for an instance.
Path : projects/{project}/zones/{zone}/instances/{instance}/setServiceAccount
Parameter Order :
Scopes :
Flat Path : projects/{project}/zones/{zone}/instances/{instance}/setServiceAccount
HTTP Method : POST
▼ ▲ compute.instances.bulkInsert
HTTP Method : POST
Scopes :
Path : projects/{project}/zones/{zone}/instances/bulkInsert
Parameter Order :
Flat Path : projects/{project}/zones/{zone}/instances/bulkInsert
Parameters :
project
Required : Yes
Description : Project ID for this request.
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])?))
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
zone
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : The name of the zone for this request.
Location : path
Required : Yes
Type : string
Description : Creates multiple instances. Count specifies the number of instances to create. For more information, seeAbout bulk creation of VMs.
Apiversion : 2026-12-01-preview
▼ ▲ compute.instances.testIamPermissions
Scopes :
Flat Path : projects/{project}/zones/{zone}/instances/{resource}/testIamPermissions
Parameter Order :
Parameters :
project
Type : string
Location : path
Description : Project ID for this request.
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])?))
zone
Required : Yes
Description : The name of the zone for this request.
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
resource
Required : Yes
Description : Name or id of the resource for this request.
Location : path
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Apiversion : 2026-12-01-preview
Description : Returns permissions that a caller has on the specified resource.
Path : projects/{project}/zones/{zone}/instances/{resource}/testIamPermissions
HTTP Method : POST
▼ ▲ compute.instances.setSecurityPolicy
Path : projects/{project}/zones/{zone}/instances/{instance}/setSecurityPolicy
HTTP Method : POST
Description : Sets the Google Cloud Armor security policy for the specified instance. For more information, seeGoogle Cloud Armor Overview
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/zones/{zone}/instances/{instance}/setSecurityPolicy
Parameters :
zone
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Name of the zone scoping this request.
Location : path
Type : string
instance
Location : path
Description : Name of the Instance resource to which the security policy should be set. The name should conform to RFC1035.
Required : Yes
Type : string
project
Description : Project ID for this request.
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
requestId
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).
Location : query
Parameter Order :
Scopes :
▼ ▲ compute.instances.setShieldedInstanceIntegrityPolicy
Apiversion : 2026-12-01-preview
Parameter Order :
Parameters :
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 scoping this request.
Type : string
Required : Yes
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
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
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Location : path
Description : The name of the zone for this request.
Description : Sets the Shielded Instance integrity policy for an instance. You can only use this method on a running instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.
Scopes :
Flat Path : projects/{project}/zones/{zone}/instances/{instance}/setShieldedInstanceIntegrityPolicy
HTTP Method : PATCH
Path : projects/{project}/zones/{zone}/instances/{instance}/setShieldedInstanceIntegrityPolicy
▼ ▲ compute.instances.setMachineResources
Scopes :
Apiversion : 2026-12-01-preview
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
project
Type : string
Required : Yes
Location : path
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])?))
instance
Location : path
Description : Name of the instance scoping this request.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
zone
Description : The name of the zone for this request.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Location : path
HTTP Method : POST
Path : projects/{project}/zones/{zone}/instances/{instance}/setMachineResources
Flat Path : projects/{project}/zones/{zone}/instances/{instance}/setMachineResources
Description : Changes the number and/or type of accelerator for a stopped instance to the values specified in the request.
Parameter Order :
▼ ▲ compute.instances.setLabels
Parameters :
zone
Location : path
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Description : The name of the zone for this request.
project
Description : Project ID for this request.
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])?))
Type : string
Location : path
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
instance
Type : string
Location : path
Description : Name of the instance scoping this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/zones/{zone}/instances/{instance}/setLabels
Path : projects/{project}/zones/{zone}/instances/{instance}/setLabels
Description : Sets labels on an instance. To learn more about labels, read theLabeling Resources documentation.
Scopes :
Parameter Order :
HTTP Method : POST
▼ ▲ compute.instances.setMinCpuPlatform
Description : Changes the minimum CPU platform that this instance should use. This method can only be called on a stopped instance. For more information, readSpecifying a Minimum CPU Platform.
Path : projects/{project}/zones/{zone}/instances/{instance}/setMinCpuPlatform
Parameter Order :
HTTP Method : POST
Apiversion : 2026-12-01-preview
Parameters :
instance
Location : path
Required : Yes
Type : string
Description : Name of the instance scoping this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
zone
Description : The name of the zone for this request.
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
requestId
Type : string
Location : query
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).
project
Location : path
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])?))
Type : string
Required : Yes
Flat Path : projects/{project}/zones/{zone}/instances/{instance}/setMinCpuPlatform
Scopes :
▼ ▲ compute.instances.reportHostAsFaulty
HTTP Method : POST
Flat Path : projects/{project}/zones/{zone}/instances/{instance}/reportHostAsFaulty
Description : Mark the host as faulty and try to restart the instance on a new host.
Parameter Order :
Apiversion : 2026-12-01-preview
Path : projects/{project}/zones/{zone}/instances/{instance}/reportHostAsFaulty
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).
Location : query
Type : string
zone
Location : path
Type : string
Description : The name of the zone for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
project
Description : Project ID for this request.
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])?))
Location : path
Type : string
instance
Required : Yes
Description : Name of the instance scoping this request.
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Scopes :
▼ ▲ compute.instances.getShieldedInstanceIdentity
HTTP Method : GET
Description : Returns the Shielded Instance Identity of an instance
Path : projects/{project}/zones/{zone}/instances/{instance}/getShieldedInstanceIdentity
Parameter Order :
Scopes :
Flat Path : projects/{project}/zones/{zone}/instances/{instance}/getShieldedInstanceIdentity
Parameters :
zone
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Required : Yes
Description : The name of the zone for this request.
instance
Description : Name or id of the instance scoping this request.
Type : string
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
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 : Project ID for this request.
Location : path
Apiversion : 2026-12-01-preview
▼ ▲ compute.instances.stop
Parameters :
instance
Required : Yes
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Description : Name of the instance resource to stop.
discardLocalSsd
Location : query
Description : This property is required if the instance has any attached Local SSD disks. If false, Local SSD data will be preserved when the instance is suspended. If true, the contents of any attached Local SSD disks will be discarded.
Type : boolean
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])?))
Location : path
Description : Project ID for this request.
zone
Location : path
Description : The name of the zone for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Required : Yes
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
noGracefulShutdown
Type : boolean
Description : If set to true, Graceful Shutdown is skipped.
Location : query
Scopes :
Apiversion : 2026-12-01-preview
Description : Stops a running instance, shutting it down cleanly, and allows you to restart the instance at a later time. Stopped instances do not incur VM usage charges while they are stopped. However, resources that the VM is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted. For more information, seeStopping an instance.
Parameter Order :
Path : projects/{project}/zones/{zone}/instances/{instance}/stop
Flat Path : projects/{project}/zones/{zone}/instances/{instance}/stop
HTTP Method : POST
▼ ▲ compute.instances.updateDisplayDevice
Scopes :
Apiversion : 2026-12-01-preview
Description : Updates the Display config for a VM instance. You can only use this method on a stopped VM instance. This method supportsPATCH semantics and uses theJSON merge patch format and processing rules.
Parameters :
instance
Description : Name of the instance scoping this request.
Required : Yes
Location : path
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
requestId
Location : query
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
zone
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : The name of the zone for this request.
Required : Yes
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.
Type : string
Required : Yes
Location : path
HTTP Method : PATCH
Path : projects/{project}/zones/{zone}/instances/{instance}/updateDisplayDevice
Parameter Order :
Flat Path : projects/{project}/zones/{zone}/instances/{instance}/updateDisplayDevice
▼ ▲ compute.instances.removeResourcePolicies
Flat Path : projects/{project}/zones/{zone}/instances/{instance}/removeResourcePolicies
HTTP Method : POST
Path : projects/{project}/zones/{zone}/instances/{instance}/removeResourcePolicies
Scopes :
Description : Removes resource policies from an instance.
Parameters :
instance
Location : path
Type : string
Required : Yes
Description : The instance name for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
zone
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : The name of the zone for this request.
Type : string
Location : path
requestId
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).
Location : query
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])?))
Apiversion : 2026-12-01-preview
Parameter Order :
▼ ▲ compute.instances.updateAccessConfig
Scopes :
Flat Path : projects/{project}/zones/{zone}/instances/{instance}/updateAccessConfig
Apiversion : 2026-12-01-preview
Description : Updates the specified access config from an instance's network interface with the data included in the request. This method supportsPATCH semantics and uses theJSON merge patch format and processing rules.
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
instance
Type : string
Location : path
Description : The instance name for this request.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
networkInterface
Required : Yes
Type : string
Description : The name of the network interface where the access config is attached.
Location : query
zone
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Description : The name of the zone for this request.
Type : string
project
Location : path
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])?))
Required : Yes
Description : Project ID for this request.
Path : projects/{project}/zones/{zone}/instances/{instance}/updateAccessConfig
HTTP Method : POST
Parameter Order :
▼ ▲ compute.instances.start
Parameter Order :
Parameters :
zone
Description : The name of the zone for this request.
Required : Yes
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
instance
Required : Yes
Description : Name of the instance resource to start.
Location : path
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
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.
Required : Yes
Location : path
Type : string
Apiversion : 2026-12-01-preview
Scopes :
Description : Starts an instance that was stopped using theinstances().stop method. For more information, seeRestart an instance.
HTTP Method : POST
Flat Path : projects/{project}/zones/{zone}/instances/{instance}/start
Path : projects/{project}/zones/{zone}/instances/{instance}/start
▼ ▲ compute.instances.reset
HTTP Method : POST
Flat Path : projects/{project}/zones/{zone}/instances/{instance}/reset
Scopes :
Description : Performs a reset on the instance. This is a hard reset. The VM does not do a graceful shutdown. For more information, seeResetting an instance.
Path : projects/{project}/zones/{zone}/instances/{instance}/reset
Parameters :
requestId
Location : query
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
zone
Type : string
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : The name of the zone for this request.
Location : path
project
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])?))
Description : Project ID for this request.
Location : path
instance
Location : path
Description : Name of the instance scoping this request.
Type : string
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Apiversion : 2026-12-01-preview
Parameter Order :
▼ ▲ compute.instances.sendDiagnosticInterrupt
Apiversion : 2026-12-01-preview
Parameters :
instance
Required : Yes
Description : Name of the instance scoping this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Type : string
project
Required : Yes
Location : path
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])?))
Description : Project ID for this request.
zone
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Required : Yes
Description : The name of the zone for this request.
Location : path
Flat Path : projects/{project}/zones/{zone}/instances/{instance}/sendDiagnosticInterrupt
Scopes :
Description : Sends diagnostic interrupt to the instance.
Parameter Order :
HTTP Method : POST
Path : projects/{project}/zones/{zone}/instances/{instance}/sendDiagnosticInterrupt
▼ ▲ compute.instances.delete
Scopes :
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/zones/{zone}/instances/{instance}
Parameters :
instance
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Description : Name of the instance resource to delete.
Type : string
Required : Yes
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
Required : Yes
Description : Project ID for this request.
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])?))
zone
Location : path
Description : The name of the zone for this request.
Type : string
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
noGracefulShutdown
Description : If set to true, Graceful Shutdown is skipped.
Type : boolean
Location : query
Path : projects/{project}/zones/{zone}/instances/{instance}
Parameter Order :
Description : Deletes the specified Instance resource. For more information, seeDeleting an instance.
HTTP Method : DELETE
▼ ▲ compute.instances.aggregatedList
Parameters :
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.
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
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.
includeAllScopes
Type : boolean
Location : query
Description : Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
project
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])?))
Required : Yes
Description : Project ID for this request.
serviceProjectNumber
Format : int64
Type : string
Description : The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.
Location : query
maxResults
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`)
Minimum : 0
Default : 500
Apiversion : 2026-12-01-preview
Scopes :
Path : projects/{project}/aggregated/instances
Description : Retrieves an aggregated list of all of the instances in your project across all regions and zones. The performance of this method degrades when a filter is specified on a project that has a very large number of instances. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.
Flat Path : projects/{project}/aggregated/instances
Parameter Order : project
HTTP Method : GET
▼ ▲ compute.instances.addNetworkInterface
HTTP Method : POST
Scopes :
Description : Adds one dynamic network interface to an active instance.
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/zones/{zone}/instances/{instance}/addNetworkInterface
Parameters :
instance
Location : path
Description : The instance name for this request stored as resource_id. Name should conform to RFC1035 or be an unsigned long integer.
Type : string
Required : Yes
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
Description : Project ID for this request.
Type : string
Location : path
requestId
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).
Location : query
zone
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : The name of the zone for this request.
Type : string
Required : Yes
Path : projects/{project}/zones/{zone}/instances/{instance}/addNetworkInterface
Parameter Order :
▼ ▲ compute.instances.setScheduling
Parameter Order :
HTTP Method : POST
Path : projects/{project}/zones/{zone}/instances/{instance}/setScheduling
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
project
Location : path
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])?))
Required : Yes
instance
Description : Instance name for this request.
Location : path
Type : string
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
zone
Type : string
Required : Yes
Description : The name of the zone for this request.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Flat Path : projects/{project}/zones/{zone}/instances/{instance}/setScheduling
Description : Sets an instance's scheduling options. You can only call this method on astopped instance, that is, a VM instance that is in a `TERMINATED` state. SeeInstance Life Cycle for more information on the possible instance states. For more information about setting scheduling options for a VM, seeSet VM host maintenance policy.
Apiversion : 2026-12-01-preview
Scopes :
▼ ▲ compute.instances.startWithEncryptionKey
Path : projects/{project}/zones/{zone}/instances/{instance}/startWithEncryptionKey
HTTP Method : POST
Parameter Order :
Flat Path : projects/{project}/zones/{zone}/instances/{instance}/startWithEncryptionKey
Apiversion : 2026-12-01-preview
Scopes :
Description : Starts an instance that was stopped using theinstances().stop method. For more information, seeRestart an instance.
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])?))
Description : Project ID for this request.
Location : path
Type : string
Required : Yes
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).
instance
Location : path
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Description : Name of the instance resource to start.
zone
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Description : The name of the zone for this request.
Type : string
▼ ▲ compute.instances.detachDisk
Path : projects/{project}/zones/{zone}/instances/{instance}/detachDisk
HTTP Method : POST
Description : Detaches a disk from an instance.
Scopes :
Parameters :
deviceName
Required : Yes
Type : string
Description : The device name of the disk to detach. Make a get() request on the instance to view currently attached disks and device names.
Location : query
instance
Description : Instance name for this request.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Location : path
zone
Location : path
Description : The name of the zone for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Type : string
requestId
Location : query
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
project
Description : Project ID for this request.
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])?))
Location : path
Flat Path : projects/{project}/zones/{zone}/instances/{instance}/detachDisk
Parameter Order :
Apiversion : 2026-12-01-preview
▼ ▲ compute.instances.simulateMaintenanceEvent
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/zones/{zone}/instances/{instance}/simulateMaintenanceEvent
Parameters :
instance
Required : Yes
Description : Name of the instance scoping this request.
Location : path
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
zone
Type : string
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Description : The name of the zone for this request.
project
Description : 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])?))
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
withExtendedNotifications
Type : boolean
Location : query
Description : Determines whether the customers receive notifications before migration. Only applicable to SF vms.
Path : projects/{project}/zones/{zone}/instances/{instance}/simulateMaintenanceEvent
Parameter Order :
Scopes :
HTTP Method : POST
Description : Simulates a host maintenance event on a VM. For more information, see Simulate a host maintenance event.
▼ ▲ compute.instances.setDeletionProtection
Apiversion : 2026-12-01-preview
Parameters :
resource
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Location : path
Description : Name or id of the resource for this request.
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
Description : Project ID for this request.
Type : string
Required : Yes
zone
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Type : string
Description : The name of the zone for this request.
Location : path
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
deletionProtection
Default : true
Type : boolean
Description : Whether the resource should be protected against deletion.
Location : query
Parameter Order :
Flat Path : projects/{project}/zones/{zone}/instances/{resource}/setDeletionProtection
Scopes :
Path : projects/{project}/zones/{zone}/instances/{resource}/setDeletionProtection
Description : Sets deletion protection on the instance.
HTTP Method : POST
▼ ▲ compute.instances.getGuestAttributes
HTTP Method : GET
Scopes :
Description : Returns the specified guest attributes entry.
Parameter Order :
Path : projects/{project}/zones/{zone}/instances/{instance}/getGuestAttributes
Flat Path : projects/{project}/zones/{zone}/instances/{instance}/getGuestAttributes
Parameters :
queryPath
Type : string
Location : query
Description : Specifies the guest attributes path to be queried.
variableKey
Location : query
Description : Specifies the key for the guest attributes entry.
Type : string
zone
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Required : Yes
Description : The name of the zone for 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])?))
Required : Yes
Location : path
Description : Project ID for this request.
Type : string
instance
Description : Name of the instance scoping this request.
Type : string
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Apiversion : 2026-12-01-preview
▼ ▲ compute.instances.getEffectiveFirewalls
Parameter Order :
Path : projects/{project}/zones/{zone}/instances/{instance}/getEffectiveFirewalls
HTTP Method : GET
Scopes :
Description : Returns effective firewalls applied to an interface of the instance.
Flat Path : projects/{project}/zones/{zone}/instances/{instance}/getEffectiveFirewalls
Apiversion : 2026-12-01-preview
Parameters :
instance
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Type : string
Description : Name of the instance scoping this request.
Required : Yes
networkInterface
Location : query
Description : The name of the network interface to get the effective firewalls.
Type : string
Required : Yes
zone
Type : string
Required : Yes
Description : The name of the zone for this request.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
project
Location : path
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])?))
Required : Yes
▼ ▲ compute.instances.setIamPolicy
Parameter Order :
HTTP Method : POST
Flat Path : projects/{project}/zones/{zone}/instances/{resource}/setIamPolicy
Scopes :
Apiversion : 2026-12-01-preview
Description : Sets the access control policy on the specified resource. Replaces any existing policy.
Parameters :
project
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])?))
Description : Project ID for this request.
Location : path
zone
Type : string
Description : The name of the zone for this request.
Location : path
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
resource
Type : string
Location : path
Description : Name or id of the resource for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Path : projects/{project}/zones/{zone}/instances/{resource}/setIamPolicy
▼ ▲ compute.instances.addAccessConfig
Parameter Order :
Apiversion : 2026-12-01-preview
Parameters :
zone
Type : string
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Description : The name of the zone for this request.
networkInterface
Description : The name of the network interface to add to this instance.
Required : Yes
Type : string
Location : query
project
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])?))
Required : Yes
Location : path
Description : Project ID for this request.
instance
Location : path
Required : Yes
Type : string
Description : The instance name for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
requestId
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).
Location : query
Path : projects/{project}/zones/{zone}/instances/{instance}/addAccessConfig
HTTP Method : POST
Flat Path : projects/{project}/zones/{zone}/instances/{instance}/addAccessConfig
Description : Adds an access config to an instance's network interface.
Scopes :
▼ ▲ compute.instances.getSerialPortOutput
HTTP Method : GET
Scopes :
Path : projects/{project}/zones/{zone}/instances/{instance}/serialPort
Flat Path : projects/{project}/zones/{zone}/instances/{instance}/serialPort
Parameters :
zone
Type : string
Location : path
Required : Yes
Description : The name of the zone for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
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
Location : path
Type : string
Description : Project ID for this request.
port
Format : int32
Location : query
Default : 1
Minimum : 1
Maximum : 4
Type : integer
Description : Specifies which COM or serial port to retrieve data from.
start
Type : string
Format : int64
Location : query
Description : Specifies the starting byte position of the output to return. To start with the first byte of output to the specified port, omit this field or set it to `0`. If the output for that byte position is available, this field matches the `start` parameter sent with the request. If the amount of serial console output exceeds the size of the buffer (1 MB), the oldest output is discarded and is no longer available. If the requested start position refers to discarded output, the start position is adjusted to the oldest output still available, and the adjusted start position is returned as the `start` property value. You can also provide a negative start position, which translates to the most recent number of bytes written to the serial port. For example, -3 is interpreted as the most recent 3 bytes written to the serial console. Note that the negative start is bounded by the retained buffer size, and the returned serial console output will not exceed the max buffer size.
instance
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Description : Name of the instance for this request.
Type : string
Location : path
Description : Returns the last 1 MB of serial port output from the specified instance.
Parameter Order :
Apiversion : 2026-12-01-preview
▼ ▲ compute.instances.insert
Parameters :
zone
Required : Yes
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : The name of the zone for this request.
Location : path
sourceMachineImage
Description : Specifies the machine image to use to create the instance. This field is optional. It can be a full or partial URL. For example, the following are all valid URLs to a machine image: - https://www.googleapis.com/compute/v1/projects/project/global/global/machineImages/machineImage - projects/project/global/global/machineImages/machineImage - global/machineImages/machineImage
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])?))
Description : Project ID for this request.
Type : string
Required : Yes
requestId
Location : query
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
sourceInstanceTemplate
Description : Specifies instance template to create the instance. This field is optional. It can be a full or partial URL. For example, the following are all valid URLs to an instance template: - https://www.googleapis.com/compute/v1/projects/project/global/instanceTemplates/instanceTemplate - projects/project/global/instanceTemplates/instanceTemplate - global/instanceTemplates/instanceTemplate
Type : string
Location : query
Scopes :
Apiversion : 2026-12-01-preview
Path : projects/{project}/zones/{zone}/instances
Description : Creates an instance resource in the specified project using the data included in the request.
Flat Path : projects/{project}/zones/{zone}/instances
Parameter Order :
HTTP Method : POST
▼ ▲ compute.instances.setMachineType
Parameter Order :
Apiversion : 2026-12-01-preview
Parameters :
instance
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Required : Yes
Description : Name of the instance scoping this request.
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
requestId
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).
Location : query
zone
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Required : Yes
Type : string
Description : The name of the zone for this request.
Scopes :
Description : Changes the machine type for a stopped instance to the machine type specified in the request.
HTTP Method : POST
Path : projects/{project}/zones/{zone}/instances/{instance}/setMachineType
Flat Path : projects/{project}/zones/{zone}/instances/{instance}/setMachineType
▼ ▲ compute.instances.suspend
Description : This method suspends a running instance, saving its state to persistent storage, and allows you to resume the instance at a later time. Suspended instances have no compute costs (cores or RAM), and incur only storage charges for the saved VM memory and localSSD data. Any charged resources the virtual machine was using, such as persistent disks and static IP addresses, will continue to be charged while the instance is suspended. For more information, see Suspending and resuming an instance.
HTTP Method : POST
Parameter Order :
Path : projects/{project}/zones/{zone}/instances/{instance}/suspend
Scopes :
Parameters :
zone
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Type : string
Required : Yes
Description : The name of the zone for this request.
discardLocalSsd
Description : This property is required if the instance has any attached Local SSD disks. If false, Local SSD data will be preserved when the instance is suspended. If true, the contents of any attached Local SSD disks will be discarded.
Location : query
Type : boolean
project
Location : path
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 : Project ID for this request.
instance
Required : Yes
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the instance resource to suspend.
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).
Flat Path : projects/{project}/zones/{zone}/instances/{instance}/suspend
Apiversion : 2026-12-01-preview
▼ ▲ compute.instances.performMaintenance
Description : Perform a manual maintenance on the instance.
Path : projects/{project}/zones/{zone}/instances/{instance}/performMaintenance
Scopes :
Parameter Order :
Parameters :
zone
Required : Yes
Type : string
Description : The name of the zone for this request.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
instance
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Description : Name of the instance scoping this request.
Required : Yes
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])?))
Description : Project ID for this request.
Required : Yes
Type : string
requestId
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).
Location : query
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/zones/{zone}/instances/{instance}/performMaintenance
HTTP Method : POST
▼ ▲ compute.instances.setTags
HTTP Method : POST
Flat Path : projects/{project}/zones/{zone}/instances/{instance}/setTags
Parameter Order :
Scopes :
Path : projects/{project}/zones/{zone}/instances/{instance}/setTags
Parameters :
zone
Description : The name of the zone for this request.
Required : Yes
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
instance
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Description : Name of the instance scoping this request.
requestId
Location : query
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
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
Description : Sets network tags for the specified instance to the data included in the request.
Apiversion : 2026-12-01-preview
▼ ▲ compute.regionTargetHttpsProxies.setUrlMap
Parameter Order :
HTTP Method : POST
Flat Path : projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}/setUrlMap
Description : Changes the URL map for TargetHttpsProxy.
Path : projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}/setUrlMap
Scopes :
Parameters :
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Description : Name of the region scoping this request.
Type : string
Required : Yes
targetHttpsProxy
Required : Yes
Type : string
Description : Name of the TargetHttpsProxy to set a URL map for.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
project
Location : path
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])?))
Required : Yes
Description : Project ID for this request.
requestId
Location : query
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
Apiversion : 2026-12-01-preview
▼ ▲ compute.regionTargetHttpsProxies.insert
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/regions/{region}/targetHttpsProxies
Parameters :
requestId
Location : query
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
project
Type : string
Description : Project ID for this request.
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])?))
Location : path
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Type : string
Description : Name of the region scoping this request.
Required : Yes
Scopes :
Path : projects/{project}/regions/{region}/targetHttpsProxies
Parameter Order :
Description : Creates a TargetHttpsProxy resource in the specified project and region using the data included in the request.
HTTP Method : POST
▼ ▲ compute.regionTargetHttpsProxies.list
Parameters :
project
Required : Yes
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])?))
Location : path
Type : string
region
Required : Yes
Description : Name of the region scoping this request.
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
maxResults
Location : query
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
Default : 500
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
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.
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.
Apiversion : 2026-12-01-preview
Description : Retrieves the list of TargetHttpsProxy resources available to the specified project in the specified region.
Path : projects/{project}/regions/{region}/targetHttpsProxies
Scopes :
Parameter Order :
Flat Path : projects/{project}/regions/{region}/targetHttpsProxies
HTTP Method : GET
▼ ▲ compute.regionTargetHttpsProxies.patch
HTTP Method : PATCH
Path : projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}
Flat Path : projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}
Description : Patches the specified regional TargetHttpsProxy resource with the data included in the request. This method supports PATCH semantics and usesJSON merge patch format and processing rules.
Parameter Order :
Parameters :
project
Required : Yes
Description : Project ID for this request.
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])?))
targetHttpsProxy
Required : Yes
Description : Name of the TargetHttpsProxy resource to patch.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Location : path
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).
region
Description : Name of the region for this request.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Type : string
Scopes :
Apiversion : 2026-12-01-preview
▼ ▲ compute.regionTargetHttpsProxies.get
Flat Path : projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}
HTTP Method : GET
Path : projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}
Description : Returns the specified TargetHttpsProxy resource in the specified region.
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
region
Required : Yes
Type : string
Description : Name of the region scoping this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
targetHttpsProxy
Required : Yes
Description : Name of the TargetHttpsProxy resource to return.
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Scopes :
Parameter Order :
Apiversion : 2026-12-01-preview
▼ ▲ compute.regionTargetHttpsProxies.setSslCertificates
Path : projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}/setSslCertificates
Parameter Order :
Description : Replaces SslCertificates for TargetHttpsProxy.
Scopes :
Parameters :
region
Required : Yes
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Name of the region scoping 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).
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.
Required : Yes
Type : string
Location : path
targetHttpsProxy
Description : Name of the TargetHttpsProxy resource to set an SslCertificates resource for.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Location : path
Apiversion : 2026-12-01-preview
HTTP Method : POST
Flat Path : projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}/setSslCertificates
▼ ▲ compute.regionTargetHttpsProxies.delete
Description : Deletes the specified TargetHttpsProxy resource.
Parameters :
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
Required : Yes
Description : Project ID for this request.
region
Required : Yes
Type : string
Description : Name of the region scoping this request.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
requestId
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).
Location : query
targetHttpsProxy
Location : path
Description : Name of the TargetHttpsProxy resource to delete.
Required : Yes
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Apiversion : 2026-12-01-preview
Scopes :
HTTP Method : DELETE
Path : projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}
Parameter Order :
Flat Path : projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}
▼ ▲ compute.regionZones.list
Scopes :
HTTP Method : GET
Flat Path : projects/{project}/regions/{region}/zones
Description : Retrieves the list of Zone resources under the specific region available to the specified project.
Path : projects/{project}/regions/{region}/zones
Parameters :
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.
project
Description : Project ID for this request.
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])?))
Location : path
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.
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
region
Required : Yes
Type : string
Location : path
Description : Region for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
maxResults
Location : query
Type : integer
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
Minimum : 0
Parameter Order :
Apiversion : 2026-12-01-preview
▼ ▲ compute.interconnectRemoteLocations.list
HTTP Method : GET
Flat Path : projects/{project}/global/interconnectRemoteLocations
Scopes :
Path : projects/{project}/global/interconnectRemoteLocations
Description : Retrieves the list of interconnect remote locations available to the specified project.
Parameters :
maxResults
Type : integer
Location : query
Default : 500
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`)
Format : uint32
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])?))
Location : path
Description : Project ID for this request.
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.
Type : string
Location : query
filter
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.
Location : query
Parameter Order : project
Apiversion : 2026-12-01-preview
▼ ▲ compute.interconnectRemoteLocations.get
Scopes :
Description : Returns the details for the specified interconnect remote location. Gets a list of available interconnect remote locations by making alist() request.
Path : projects/{project}/global/interconnectRemoteLocations/{interconnectRemoteLocation}
Apiversion : 2026-12-01-preview
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])?))
Location : path
Description : Project ID for this request.
Type : string
interconnectRemoteLocation
Description : Name of the interconnect remote location to return.
Location : path
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
HTTP Method : GET
Flat Path : projects/{project}/global/interconnectRemoteLocations/{interconnectRemoteLocation}
Parameter Order :
▼ ▲ compute.reservationSubBlocks.getVersion
Apiversion : 2026-12-01-preview
Description : Allows customers to get SBOM versions of a reservation subBlock.
Parameters :
parentName
Required : Yes
Type : string
Description : The name of the parent reservation and parent block. In the format of reservations/{reservation_name}/reservationBlocks/{reservation_block_name}
Location : path
Pattern : ^reservations/[^/]+/reservationBlocks/[^/]+$
zone
Type : string
Location : path
Description : Name of the zone for this request. Zone name should conform to RFC1035.
Required : Yes
reservationSubBlock
Location : path
Description : The name of the reservation subBlock. Name should conform to RFC1035 or be a resource ID.
Type : string
Required : Yes
project
Location : path
Description : Project ID for this request.
Required : Yes
Type : string
requestId
Type : string
Location : query
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).
Scopes :
Parameter Order :
HTTP Method : POST
Flat Path : projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks/{reservationSubBlock}/getVersion
Path : projects/{project}/zones/{zone}/{+parentName}/reservationSubBlocks/{reservationSubBlock}/getVersion
▼ ▲ compute.reservationSubBlocks.list
Apiversion : 2026-12-01-preview
Path : projects/{project}/zones/{zone}/{+parentName}/reservationSubBlocks
Parameters :
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.
maxResults
Location : query
Type : integer
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`)
Format : uint32
Minimum : 0
Default : 500
zone
Description : Name of the zone for this request. Zone name should conform to RFC1035.
Required : Yes
Location : path
Type : string
project
Description : Project ID for this request.
Location : path
Type : string
Required : Yes
parentName
Pattern : ^reservations/[^/]+/reservationBlocks/[^/]+$
Required : Yes
Description : The name of the parent reservation and parent block. In the format of reservations/{reservation_name}/reservationBlocks/{reservation_block_name}
Location : path
Type : string
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
filter
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.
Type : string
Scopes :
Parameter Order :
Description : Retrieves a list of reservation subBlocks under a single reservation.
HTTP Method : GET
Flat Path : projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks
▼ ▲ compute.reservationSubBlocks.getIamPolicy
Parameters :
resource
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Description : Name or id of the resource for this request.
Type : string
project
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])?))
Location : path
Description : Project ID for this request.
parentResource
Description : Name or id of parent resource of the resource for this request.
Pattern : [a-z](?:[-a-zA-Z0-9/]{0,255}[a-zA-Z0-9])?
Required : Yes
Type : string
Location : path
optionsRequestedPolicyVersion
Format : int32
Location : query
Description : Requested IAM Policy version.
Type : integer
zone
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : The name of the zone for this request.
Type : string
Location : path
Scopes :
Apiversion : 2026-12-01-preview
Parameter Order :
Path : projects/{project}/zones/{zone}/{+parentResource}/reservationSubBlocks/{resource}/getIamPolicy
Description : Gets the access control policy for a resource. May be empty if no such policy or resource exists.
Flat Path : projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks/{resource}/getIamPolicy
HTTP Method : GET
▼ ▲ compute.reservationSubBlocks.get
Description : Retrieves information about the specified reservation subBlock.
Parameter Order :
Path : projects/{project}/zones/{zone}/{+parentName}/reservationSubBlocks/{reservationSubBlock}
Parameters :
zone
Location : path
Description : Name of the zone for this request. Zone name should conform to RFC1035.
Type : string
Required : Yes
project
Required : Yes
Type : string
Description : Project ID for this request.
Location : path
view
Location : query
Description : View of the subBlock.
Enum Descriptions :
Type : string
Enum :
parentName
Description : The name of the parent reservation and parent block. In the format of reservations/{reservation_name}/reservationBlocks/{reservation_block_name}
Type : string
Required : Yes
Pattern : ^reservations/[^/]+/reservationBlocks/[^/]+$
Location : path
reservationSubBlock
Description : The name of the reservation subBlock. Name should conform to RFC1035 or be a resource ID.
Required : Yes
Location : path
Type : string
Flat Path : projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks/{reservationSubBlock}
Apiversion : 2026-12-01-preview
Scopes :
HTTP Method : GET
▼ ▲ compute.reservationSubBlocks.setIamPolicy
Flat Path : projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks/{resource}/setIamPolicy
HTTP Method : POST
Parameter Order :
Parameters :
resource
Description : Name or id of the resource for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Location : path
Type : string
parentResource
Required : Yes
Description : Name or id of parent resource of the resource for this request.
Type : string
Location : path
Pattern : [a-z](?:[-a-zA-Z0-9/]{0,255}[a-zA-Z0-9])?
project
Location : path
Type : string
Description : Project ID for this request.
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])?))
zone
Type : string
Description : The name of the zone for this request.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Scopes :
Apiversion : 2026-12-01-preview
Path : projects/{project}/zones/{zone}/{+parentResource}/reservationSubBlocks/{resource}/setIamPolicy
Description : Sets the access control policy on the specified resource. Replaces any existing policy.
▼ ▲ compute.reservationSubBlocks.testIamPermissions
Description : Returns permissions that a caller has on the specified resource.
Parameters :
parentResource
Location : path
Type : string
Pattern : [a-z](?:[-a-zA-Z0-9/]{0,255}[a-zA-Z0-9])?
Description : Name or id of parent resource of the resource for this request.
Required : Yes
project
Location : path
Description : Project ID for this request.
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])?))
zone
Type : string
Location : path
Description : The name of the zone for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
resource
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Required : Yes
Description : Name or id of the resource for this request.
Location : path
Apiversion : 2026-12-01-preview
Parameter Order :
Path : projects/{project}/zones/{zone}/{+parentResource}/reservationSubBlocks/{resource}/testIamPermissions
Scopes :
HTTP Method : POST
Flat Path : projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks/{resource}/testIamPermissions
▼ ▲ compute.reservationSubBlocks.reportFaulty
Flat Path : projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks/{reservationSubBlock}/reportFaulty
HTTP Method : POST
Parameters :
zone
Location : path
Type : string
Required : Yes
Description : Name of the zone for this request. Zone name should conform to RFC1035.
project
Location : path
Type : string
Required : Yes
Description : Project ID for this request.
reservationSubBlock
Description : The name of the reservation subBlock. Name should conform to RFC1035 or be a resource ID.
Required : Yes
Location : path
Type : string
parentName
Location : path
Required : Yes
Type : string
Description : The name of the parent reservation and parent block. In the format of reservations/{reservation_name}/reservationBlocks/{reservation_block_name}
Pattern : ^reservations/[^/]+/reservationBlocks/[^/]+$
requestId
Type : string
Location : query
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).
Apiversion : 2026-12-01-preview
Parameter Order :
Path : projects/{project}/zones/{zone}/{+parentName}/reservationSubBlocks/{reservationSubBlock}/reportFaulty
Scopes :
Description : Allows customers to report a faulty subBlock.
▼ ▲ compute.reservationSubBlocks.performMaintenance
Scopes :
Apiversion : 2026-12-01-preview
Path : projects/{project}/zones/{zone}/{+parentName}/reservationSubBlocks/{reservationSubBlock}/performMaintenance
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).
Location : query
Type : string
reservationSubBlock
Type : string
Location : path
Required : Yes
Description : The name of the reservation subBlock. Name should conform to RFC1035 or be a resource ID.
project
Required : Yes
Description : Project ID for this request.
Type : string
Location : path
parentName
Required : Yes
Type : string
Description : The name of the parent reservation and parent block. In the format of reservations/{reservation_name}/reservationBlocks/{reservation_block_name}
Pattern : ^reservations/[^/]+/reservationBlocks/[^/]+$
Location : path
zone
Location : path
Type : string
Description : Name of the zone for this request. Zone name should conform to RFC1035.
Required : Yes
Description : Allows customers to perform maintenance on a reservation subBlock
Parameter Order :
HTTP Method : POST
Flat Path : projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks/{reservationSubBlock}/performMaintenance
▼ ▲ compute.instanceGroups.aggregatedList
Flat Path : projects/{project}/aggregated/instanceGroups
Scopes :
Apiversion : 2026-12-01-preview
Description : Retrieves the list of instance groups and sorts them by zone. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.
Parameters :
maxResults
Minimum : 0
Location : query
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
Type : integer
Format : uint32
includeAllScopes
Location : query
Type : boolean
Description : Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
serviceProjectNumber
Location : query
Format : int64
Description : The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.
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.
project
Required : Yes
Description : Project ID for this request.
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])?))
Location : path
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.
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
Path : projects/{project}/aggregated/instanceGroups
HTTP Method : GET
Parameter Order : project
▼ ▲ compute.instanceGroups.removeInstances
Flat Path : projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/removeInstances
Parameter Order :
HTTP Method : POST
Path : projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/removeInstances
Description : Removes one or more instances from the specified instance group, but does not delete those instances. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration before the VM instance is removed or deleted.
Scopes :
Parameters :
zone
Required : Yes
Location : path
Type : string
Description : The name of the zone where the instance group is located.
project
Type : string
Description : Project ID for this request.
Location : path
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])?))
requestId
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).
Location : query
instanceGroup
Type : string
Required : Yes
Description : The name of the instance group where the specified instances will be removed.
Location : path
Apiversion : 2026-12-01-preview
▼ ▲ compute.instanceGroups.listInstances
Parameters :
zone
Required : Yes
Description : The name of the zone where the instance group is located.
Location : path
Type : string
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`)
Format : uint32
Minimum : 0
Location : query
Default : 500
Type : integer
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.
Type : string
Location : query
instanceGroup
Location : path
Required : Yes
Type : string
Description : The name of the instance group from which you want to generate a list of included instances.
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
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.
Type : string
Location : query
project
Location : path
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])?))
Description : Project ID for this request.
Required : Yes
Path : projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/listInstances
Apiversion : 2026-12-01-preview
Description : Lists the instances in the specified instance group. The orderBy query parameter is not supported. The filter query parameter is supported, but only for expressions that use `eq` (equal) or `ne` (not equal) operators.
Parameter Order :
HTTP Method : POST
Flat Path : projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/listInstances
Scopes :
▼ ▲ compute.instanceGroups.insert
Path : projects/{project}/zones/{zone}/instanceGroups
Flat Path : projects/{project}/zones/{zone}/instanceGroups
Apiversion : 2026-12-01-preview
Parameter Order :
Parameters :
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
Type : string
Description : The name of the zone where you want to create the instance group.
Location : path
Required : Yes
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
Description : Project ID for this request.
Type : string
Location : path
HTTP Method : POST
Scopes :
Description : Creates an instance group in the specified project using the parameters that are included in the request.
▼ ▲ compute.instanceGroups.testIamPermissions
Path : projects/{project}/zones/{zone}/instanceGroups/{resource}/testIamPermissions
HTTP Method : POST
Description : Returns permissions that a caller has on the specified resource.
Scopes :
Apiversion : 2026-12-01-preview
Parameters :
zone
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : The name of the zone for this request.
Type : string
Required : Yes
resource
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name or id of the resource for this request.
Location : path
Type : string
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 : Project ID for this request.
Location : path
Flat Path : projects/{project}/zones/{zone}/instanceGroups/{resource}/testIamPermissions
Parameter Order :
▼ ▲ compute.instanceGroups.delete
Scopes :
Path : projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}
Description : Deletes the specified instance group. The instances in the group are not deleted. Note that instance group must not belong to a backend service. Read Deleting an instance group for more information.
HTTP Method : DELETE
Flat Path : projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}
Parameters :
requestId
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).
Location : query
instanceGroup
Location : path
Type : string
Description : The name of the instance group to delete.
Required : Yes
project
Type : string
Description : Project ID for this request.
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])?))
Location : path
zone
Required : Yes
Description : The name of the zone where the instance group is located.
Location : path
Type : string
Parameter Order :
Apiversion : 2026-12-01-preview
▼ ▲ compute.instanceGroups.get
Parameter Order :
HTTP Method : GET
Description : Returns the specified zonal instance group. Get a list of available zonal instance groups by making a list() request. For managed instance groups, use theinstanceGroupManagers or regionInstanceGroupManagers methods instead.
Apiversion : 2026-12-01-preview
Parameters :
zone
Description : The name of the zone where the instance group is located.
Location : path
Type : string
Required : Yes
project
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])?))
Location : path
Required : Yes
Description : Project ID for this request.
instanceGroup
Type : string
Required : Yes
Location : path
Description : The name of the instance group.
Scopes :
Path : projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}
Flat Path : projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}
▼ ▲ compute.instanceGroups.addInstances
Parameters :
requestId
Location : query
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
project
Type : string
Description : Project ID for this request.
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])?))
Location : path
instanceGroup
Required : Yes
Location : path
Description : The name of the instance group where you are adding instances.
Type : string
zone
Location : path
Required : Yes
Description : The name of the zone where the instance group is located.
Type : string
Flat Path : projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/addInstances
Parameter Order :
Description : Adds a list of instances to the specified instance group. All of the instances in the instance group must be in the same network/subnetwork. Read Adding instances for more information.
Path : projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/addInstances
Apiversion : 2026-12-01-preview
Scopes :
HTTP Method : POST
▼ ▲ compute.instanceGroups.list
Path : projects/{project}/zones/{zone}/instanceGroups
HTTP Method : GET
Description : Retrieves the list of zonal instance group resources contained within the specified zone. For managed instance groups, use theinstanceGroupManagers or regionInstanceGroupManagers methods instead.
Parameter Order :
Scopes :
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.
Location : query
Type : string
maxResults
Default : 500
Minimum : 0
Location : query
Format : uint32
Type : integer
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
Type : string
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.
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.
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])?))
Type : string
Location : path
Description : Project ID for this request.
Required : Yes
zone
Description : The name of thezone where the instance group is located.
Required : Yes
Type : string
Location : path
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/zones/{zone}/instanceGroups
▼ ▲ compute.instanceGroups.setNamedPorts
Parameters :
zone
Required : Yes
Type : string
Location : path
Description : The name of the zone where the instance group is located.
instanceGroup
Description : The name of the instance group where the named ports are updated.
Location : path
Type : string
Required : Yes
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])?))
Type : string
Required : Yes
requestId
Type : string
Location : query
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).
Scopes :
Flat Path : projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/setNamedPorts
Apiversion : 2026-12-01-preview
Path : projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/setNamedPorts
Parameter Order :
Description : Sets the named ports for the specified instance group.
HTTP Method : POST
▼ ▲ compute.nodeTypes.get
Parameters :
project
Location : path
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])?))
Required : Yes
Description : Project ID for this request.
nodeType
Description : Name of the node type to return.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Required : Yes
zone
Location : path
Description : The name of the zone for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Required : Yes
Scopes :
Apiversion : 2026-12-01-preview
Path : projects/{project}/zones/{zone}/nodeTypes/{nodeType}
Parameter Order :
Description : Returns the specified node type.
Flat Path : projects/{project}/zones/{zone}/nodeTypes/{nodeType}
HTTP Method : GET
▼ ▲ compute.nodeTypes.list
HTTP Method : GET
Scopes :
Description : Retrieves a list of node types available to the specified project.
Path : projects/{project}/zones/{zone}/nodeTypes
Parameter Order :
Flat Path : projects/{project}/zones/{zone}/nodeTypes
Parameters :
filter
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.
Type : string
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.
maxResults
Location : query
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`)
Format : uint32
Type : integer
Default : 500
Minimum : 0
zone
Description : The name of the zone for this request.
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
project
Description : Project ID for this request.
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])?))
Location : path
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.
Apiversion : 2026-12-01-preview
▼ ▲ compute.nodeTypes.aggregatedList
Path : projects/{project}/aggregated/nodeTypes
Parameter Order : project
HTTP Method : GET
Flat Path : projects/{project}/aggregated/nodeTypes
Parameters :
includeAllScopes
Location : query
Type : boolean
Description : Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
filter
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.
Type : string
maxResults
Default : 500
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`)
Format : uint32
Location : query
Type : integer
serviceProjectNumber
Type : string
Format : int64
Description : The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.
Location : query
project
Required : Yes
Location : path
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])?))
Type : string
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.
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
Description : Retrieves an aggregated list of node types. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.
Apiversion : 2026-12-01-preview
Scopes :
▼ ▲ compute.targetSslProxies.testIamPermissions
Parameters :
resource
Pattern : [a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Location : path
Description : Name or id of the resource for this request.
Type : string
project
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])?))
Required : Yes
Type : string
Location : path
Apiversion : 2026-12-01-preview
Parameter Order :
Path : projects/{project}/global/targetSslProxies/{resource}/testIamPermissions
Description : Returns permissions that a caller has on the specified resource.
Scopes :
HTTP Method : POST
Flat Path : projects/{project}/global/targetSslProxies/{resource}/testIamPermissions
▼ ▲ compute.targetSslProxies.setBackendService
Apiversion : 2026-12-01-preview
Path : projects/{project}/global/targetSslProxies/{targetSslProxy}/setBackendService
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).
Location : query
Type : string
targetSslProxy
Location : path
Type : string
Required : Yes
Description : Name of the TargetSslProxy resource whose BackendService resource is to be set.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
project
Description : Project ID for this request.
Location : path
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])?))
Type : string
Parameter Order :
Scopes :
Flat Path : projects/{project}/global/targetSslProxies/{targetSslProxy}/setBackendService
Description : Changes the BackendService for TargetSslProxy.
HTTP Method : POST
▼ ▲ compute.targetSslProxies.setCertificateMap
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/global/targetSslProxies/{targetSslProxy}/setCertificateMap
Parameters :
targetSslProxy
Required : Yes
Type : string
Description : Name of the TargetSslProxy resource whose CertificateMap is to be set. The name must be 1-63 characters long, and comply with RFC1035.
Location : path
requestId
Location : query
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
project
Required : Yes
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])?))
Type : string
Description : Changes the Certificate Map for TargetSslProxy.
Parameter Order :
Path : projects/{project}/global/targetSslProxies/{targetSslProxy}/setCertificateMap
Scopes :
HTTP Method : POST
▼ ▲ compute.targetSslProxies.get
Flat Path : projects/{project}/global/targetSslProxies/{targetSslProxy}
Scopes :
Apiversion : 2026-12-01-preview
Path : projects/{project}/global/targetSslProxies/{targetSslProxy}
Description : Returns the specified TargetSslProxy resource.
Parameters :
project
Type : string
Location : path
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])?))
Required : Yes
targetSslProxy
Required : Yes
Type : string
Description : Name of the TargetSslProxy resource to return.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
HTTP Method : GET
Parameter Order :
▼ ▲ compute.targetSslProxies.setSslCertificates
Description : Changes SslCertificates for TargetSslProxy.
HTTP Method : POST
Parameter Order :
Path : projects/{project}/global/targetSslProxies/{targetSslProxy}/setSslCertificates
Parameters :
targetSslProxy
Description : Name of the TargetSslProxy resource whose SslCertificate resource is to be set.
Type : string
Location : path
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
requestId
Location : query
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
project
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])?))
Description : Project ID for this request.
Flat Path : projects/{project}/global/targetSslProxies/{targetSslProxy}/setSslCertificates
Scopes :
Apiversion : 2026-12-01-preview
▼ ▲ compute.targetSslProxies.insert
Flat Path : projects/{project}/global/targetSslProxies
HTTP Method : POST
Scopes :
Parameter Order : project
Parameters :
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).
project
Type : string
Location : path
Description : Project ID for this request.
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 : Creates a TargetSslProxy resource in the specified project using the data included in the request.
Path : projects/{project}/global/targetSslProxies
Apiversion : 2026-12-01-preview
▼ ▲ compute.targetSslProxies.setSslPolicy
Parameters :
targetSslProxy
Location : path
Required : Yes
Description : Name of the TargetSslProxy resource whose SSL policy is to be set. The name must be 1-63 characters long, and comply with RFC1035.
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
Description : Project ID for this request.
Location : path
Type : string
requestId
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).
Location : query
Description : Sets the SSL policy for TargetSslProxy. The SSL policy specifies the server-side support for SSL features. This affects connections between clients and the load balancer. They do not affect the connection between the load balancer and the backends.
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/global/targetSslProxies/{targetSslProxy}/setSslPolicy
Scopes :
Parameter Order :
Path : projects/{project}/global/targetSslProxies/{targetSslProxy}/setSslPolicy
HTTP Method : POST
▼ ▲ compute.targetSslProxies.delete
Scopes :
HTTP Method : DELETE
Parameter Order :
Path : projects/{project}/global/targetSslProxies/{targetSslProxy}
Apiversion : 2026-12-01-preview
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
targetSslProxy
Location : path
Description : Name of the TargetSslProxy resource to delete.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
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
Location : path
Description : Project ID for this request.
Type : string
Flat Path : projects/{project}/global/targetSslProxies/{targetSslProxy}
Description : Deletes the specified TargetSslProxy resource.
▼ ▲ compute.targetSslProxies.setProxyHeader
Parameter Order :
HTTP Method : POST
Description : Changes the ProxyHeaderType for TargetSslProxy.
Flat Path : projects/{project}/global/targetSslProxies/{targetSslProxy}/setProxyHeader
Path : projects/{project}/global/targetSslProxies/{targetSslProxy}/setProxyHeader
Apiversion : 2026-12-01-preview
Scopes :
Parameters :
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).
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])?))
Required : Yes
Type : string
Description : Project ID for this request.
targetSslProxy
Required : Yes
Description : Name of the TargetSslProxy resource whose ProxyHeader is to be set.
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
▼ ▲ compute.targetSslProxies.list
Path : projects/{project}/global/targetSslProxies
Parameter Order : project
Description : Retrieves the list of TargetSslProxy resources available to the specified project.
HTTP Method : GET
Parameters :
filter
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.
Type : string
maxResults
Format : uint32
Location : query
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`)
Minimum : 0
Default : 500
Type : integer
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
orderBy
Type : string
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.
project
Description : Project ID for this request.
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])?))
Location : path
Scopes :
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/global/targetSslProxies
▼ ▲ compute.globalFrontendSettings.get
HTTP Method : GET
Description : Gets the Global Frontend Billing Bundle Settings for a project.
Scopes :
Flat Path : projects/{project}/global/globalFrontendSettings
Parameter Order : project
Path : projects/{project}/global/globalFrontendSettings
Parameters :
project
Location : path
Description : Required. Project ID for this request.
Type : string
Required : Yes
Apiversion : 2026-12-01-preview
▼ ▲ compute.globalFrontendSettings.patch
Flat Path : projects/{project}/global/globalFrontendSettings
Apiversion : 2026-12-01-preview
Parameters :
project
Description : Required. Project ID for this request.
Location : path
Type : string
Required : Yes
updateMask
Type : string
Format : google-fieldmask
Description : Field mask to support patch. E.g., "type".
Location : query
requestId
Location : query
Description : An optional request ID to identify requests.
Type : string
HTTP Method : PATCH
Parameter Order : project
Description : Updates the Global Frontend Billing Bundle Settings for a project.
Scopes :
Path : projects/{project}/global/globalFrontendSettings
▼ ▲ compute.sslPolicies.delete
Path : projects/{project}/global/sslPolicies/{sslPolicy}
Scopes :
HTTP Method : DELETE
Parameter Order :
Description : Deletes the specified SSL policy. The SSL policy resource can be deleted only if it is not in use by any TargetHttpsProxy or TargetSslProxy resources.
Parameters :
sslPolicy
Type : string
Required : Yes
Location : path
Description : Name of the SSL policy to delete. The name must be 1-63 characters long, and comply with RFC1035.
requestId
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).
Location : query
project
Location : path
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])?))
Required : Yes
Flat Path : projects/{project}/global/sslPolicies/{sslPolicy}
Apiversion : 2026-12-01-preview
▼ ▲ compute.sslPolicies.testIamPermissions
Description : Returns permissions that a caller has on the specified resource.
Parameter Order :
Flat Path : projects/{project}/global/sslPolicies/{resource}/testIamPermissions
HTTP Method : POST
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])?))
Type : string
Description : Project ID for this request.
Location : path
resource
Location : path
Description : Name or id of the resource for this request.
Pattern : [a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Required : Yes
Apiversion : 2026-12-01-preview
Scopes :
Path : projects/{project}/global/sslPolicies/{resource}/testIamPermissions
▼ ▲ compute.sslPolicies.getIamPolicy
Apiversion : 2026-12-01-preview
Parameter Order :
Parameters :
optionsRequestedPolicyVersion
Location : query
Description : Requested IAM Policy version.
Type : integer
Format : int32
resource
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 resource for this request.
Type : string
Required : Yes
project
Required : Yes
Description : Project ID for this request.
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])?))
Location : path
Description : Gets the access control policy for a resource. May be empty if no such policy or resource exists.
Path : projects/{project}/global/sslPolicies/{resource}/getIamPolicy
Flat Path : projects/{project}/global/sslPolicies/{resource}/getIamPolicy
Scopes :
HTTP Method : GET
▼ ▲ compute.sslPolicies.insert
HTTP Method : POST
Description : Returns the specified SSL policy resource.
Flat Path : projects/{project}/global/sslPolicies
Apiversion : 2026-12-01-preview
Parameter Order : project
Path : projects/{project}/global/sslPolicies
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).
Location : query
Type : string
project
Required : Yes
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])?))
Type : string
Location : path
Scopes :
▼ ▲ compute.sslPolicies.list
Description : Lists all the SSL policies that have been configured for the specified project.
Apiversion : 2026-12-01-preview
Scopes :
Parameters :
orderBy
Type : string
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.
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
Type : string
Location : path
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])?))
Required : Yes
maxResults
Type : integer
Location : query
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`)
Format : uint32
Default : 500
Minimum : 0
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.
Parameter Order : project
HTTP Method : GET
Path : projects/{project}/global/sslPolicies
Flat Path : projects/{project}/global/sslPolicies
▼ ▲ compute.sslPolicies.get
Scopes :
HTTP Method : GET
Parameter Order :
Parameters :
project
Description : Project ID for this request.
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])?))
Location : path
sslPolicy
Description : Name of the SSL policy to update. The name must be 1-63 characters long, and comply with RFC1035.
Location : path
Type : string
Required : Yes
Path : projects/{project}/global/sslPolicies/{sslPolicy}
Description : Lists all of the ordered rules present in a single specified policy.
Flat Path : projects/{project}/global/sslPolicies/{sslPolicy}
Apiversion : 2026-12-01-preview
▼ ▲ compute.sslPolicies.aggregatedList
Parameters :
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.
serviceProjectNumber
Format : int64
Description : The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.
Type : string
Location : query
project
Description : Name of the project scoping this request.
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])?))
Type : string
Location : path
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
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
maxResults
Minimum : 0
Location : query
Default : 500
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`)
includeAllScopes
Type : boolean
Description : Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
Location : query
Apiversion : 2026-12-01-preview
Parameter Order : project
Path : projects/{project}/aggregated/sslPolicies
Scopes :
Flat Path : projects/{project}/aggregated/sslPolicies
Description : Retrieves the list of all SslPolicy resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.
HTTP Method : GET
▼ ▲ compute.sslPolicies.patch
HTTP Method : PATCH
Description : Patches the specified SSL policy with the data included in the request.
Scopes :
Path : projects/{project}/global/sslPolicies/{sslPolicy}
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])?))
Required : Yes
Description : Project ID for this request.
Location : path
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).
Type : string
Location : query
sslPolicy
Required : Yes
Description : Name of the SSL policy to update. The name must be 1-63 characters long, and comply with RFC1035.
Location : path
Type : string
Flat Path : projects/{project}/global/sslPolicies/{sslPolicy}
Apiversion : 2026-12-01-preview
▼ ▲ compute.sslPolicies.listAvailableFeatures
Flat Path : projects/{project}/global/sslPolicies/listAvailableFeatures
HTTP Method : GET
Path : projects/{project}/global/sslPolicies/listAvailableFeatures
Apiversion : 2026-12-01-preview
Parameters :
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.
Type : string
Location : query
pageToken
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.
Type : string
filter
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.
Type : string
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])?))
Required : Yes
Type : string
Description : Project ID for this request.
maxResults
Location : query
Format : uint32
Type : integer
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`)
Minimum : 0
Default : 500
Parameter Order : project
Description : Lists all features that can be specified in the SSL policy when using custom profile.
Scopes :
▼ ▲ compute.sslPolicies.setIamPolicy
Scopes :
HTTP Method : POST
Parameters :
project
Type : string
Location : path
Required : Yes
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])?))
resource
Description : Name or id of the resource for this request.
Required : Yes
Type : string
Pattern : [a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Description : Sets the access control policy on the specified resource. Replaces any existing policy.
Flat Path : projects/{project}/global/sslPolicies/{resource}/setIamPolicy
Path : projects/{project}/global/sslPolicies/{resource}/setIamPolicy
Apiversion : 2026-12-01-preview
Parameter Order :
▼ ▲ compute.targetGrpcProxies.list
Scopes :
Path : projects/{project}/global/targetGrpcProxies
Apiversion : 2026-12-01-preview
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`)
Location : query
Minimum : 0
Type : integer
Default : 500
Format : uint32
filter
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.
Type : string
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
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.
project
Description : 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])?))
Parameter Order : project
Description : Lists the TargetGrpcProxies for a project in the given scope.
HTTP Method : GET
Flat Path : projects/{project}/global/targetGrpcProxies
▼ ▲ compute.targetGrpcProxies.patch
Parameter Order :
Flat Path : projects/{project}/global/targetGrpcProxies/{targetGrpcProxy}
Scopes :
Path : projects/{project}/global/targetGrpcProxies/{targetGrpcProxy}
Description : Patches the specified TargetGrpcProxy resource with the data included in the request. This method supports PATCH semantics and usesJSON merge patch format and processing rules.
HTTP Method : PATCH
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.
Type : string
Required : Yes
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).
targetGrpcProxy
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Required : Yes
Description : Name of the TargetGrpcProxy resource to patch.
Apiversion : 2026-12-01-preview
▼ ▲ compute.targetGrpcProxies.insert
Flat Path : projects/{project}/global/targetGrpcProxies
Path : projects/{project}/global/targetGrpcProxies
HTTP Method : POST
Parameter Order : project
Parameters :
project
Location : path
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])?))
Type : string
Required : Yes
requestId
Type : string
Location : query
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).
Scopes :
Apiversion : 2026-12-01-preview
Description : Creates a TargetGrpcProxy in the specified project in the given scope using the parameters that are included in the request.
▼ ▲ compute.targetGrpcProxies.get
HTTP Method : GET
Parameter Order :
Flat Path : projects/{project}/global/targetGrpcProxies/{targetGrpcProxy}
Scopes :
Path : projects/{project}/global/targetGrpcProxies/{targetGrpcProxy}
Description : Returns the specified TargetGrpcProxy resource in the given scope.
Apiversion : 2026-12-01-preview
Parameters :
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])?))
Description : Project ID for this request.
Required : Yes
Type : string
targetGrpcProxy
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Type : string
Description : Name of the TargetGrpcProxy resource to return.
Required : Yes
▼ ▲ compute.targetGrpcProxies.delete
Scopes :
Flat Path : projects/{project}/global/targetGrpcProxies/{targetGrpcProxy}
Apiversion : 2026-12-01-preview
Parameters :
project
Required : Yes
Description : Project ID for this request.
Location : path
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])?))
targetGrpcProxy
Required : Yes
Description : Name of the TargetGrpcProxy resource to delete.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
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).
Parameter Order :
Path : projects/{project}/global/targetGrpcProxies/{targetGrpcProxy}
HTTP Method : DELETE
Description : Deletes the specified TargetGrpcProxy in the given scope
▼ ▲ compute.regionOperations.get
Description : Retrieves the specified region-specific Operations resource.
Flat Path : projects/{project}/regions/{region}/operations/{operation}
Parameter Order :
Apiversion : 2026-12-01-preview
Parameters :
operation
Description : Name of the Operations resource to return, or its unique numeric identifier.
Required : Yes
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
project
Required : Yes
Description : Project ID for this request.
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])?))
Location : path
region
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Description : Name of the region for this request.
Required : Yes
HTTP Method : GET
Path : projects/{project}/regions/{region}/operations/{operation}
Scopes :
▼ ▲ compute.regionOperations.list
HTTP Method : GET
Description : Retrieves a list of Operation resources contained within the specified region.
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/regions/{region}/operations
Parameters :
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
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Description : Name of the region for this request.
Type : string
Required : Yes
maxResults
Default : 500
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`)
Format : uint32
Location : query
Type : integer
orderBy
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.
Location : query
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
filter
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.
Type : string
Parameter Order :
Path : projects/{project}/regions/{region}/operations
Scopes :
▼ ▲ compute.regionOperations.delete
Path : projects/{project}/regions/{region}/operations/{operation}
Parameter Order :
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/regions/{region}/operations/{operation}
Scopes :
Parameters :
project
Description : Project ID for this request.
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])?))
Location : path
operation
Description : Name of the Operations resource to delete, or its unique numeric identifier.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Required : Yes
Location : path
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Type : string
Description : Name of the region for this request.
Required : Yes
HTTP Method : DELETE
Description : Deletes the specified region-specific Operations resource.
▼ ▲ compute.regionOperations.wait
Parameter Order :
Description : Waits for the specified Operation resource to return as `DONE` or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource. This method differs from the `GET` method in that it waits for no more than the default deadline (2 minutes) and then returns the current state of the operation, which might be `DONE` or still in progress. This method is called on a best-effort basis. Specifically: - In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. - If the default deadline is reached, there is no guarantee that the operation is actually done when the method returns. Be prepared to retry if the operation is not `DONE`.
Apiversion : 2026-12-01-preview
Scopes :
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
Location : path
Description : Project ID for this request.
Type : string
region
Location : path
Type : string
Required : Yes
Description : Name of the region for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
operation
Description : Name of the Operations resource to return, or its unique numeric identifier.
Required : Yes
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
HTTP Method : POST
Flat Path : projects/{project}/regions/{region}/operations/{operation}/wait
Path : projects/{project}/regions/{region}/operations/{operation}/wait
▼ ▲ compute.regionInstanceGroupManagers.setTargetPools
Parameters :
instanceGroupManager
Location : path
Description : Name of the managed instance group.
Type : string
Required : Yes
region
Required : Yes
Type : string
Description : Name of the region scoping this request.
Location : path
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.
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
Flat Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setTargetPools
Apiversion : 2026-12-01-preview
Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setTargetPools
Description : Modifies the target pools to which all new instances in this group are assigned. Existing instances in the group are not affected.
Scopes :
HTTP Method : POST
Parameter Order :
▼ ▲ compute.regionInstanceGroupManagers.recreateInstances
Apiversion : 2026-12-01-preview
Parameter Order :
Flat Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/recreateInstances
Parameters :
requestId
Type : string
Location : query
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).
project
Required : Yes
Description : Project ID for this request.
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])?))
noGracefulShutdown
Location : query
Type : boolean
Default : false
Description : When set, graceful shutdown is skipped for instance recreation even if it's configured for the instances.
instanceGroupManager
Location : path
Type : string
Description : Name of the managed instance group.
Required : Yes
region
Required : Yes
Type : string
Location : path
Description : Name of the region scoping this request.
Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/recreateInstances
Scopes :
HTTP Method : POST
Description : Flags the specified VM instances in the managed instance group to be immediately recreated. Each instance is recreated using the group's current configuration. This operation is marked as DONE when the flag is set even if the instances have not yet been recreated. You must separately verify the status of each instance by checking itscurrentAction field; for more information, see Checking the status of managed instances. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request.
▼ ▲ compute.regionInstanceGroupManagers.get
Scopes :
HTTP Method : GET
Parameter Order :
Flat Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}
Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}
Apiversion : 2026-12-01-preview
Description : Returns all of the details about the specified managed instance group.
Parameters :
region
Location : path
Description : Name of the region scoping this request.
Required : Yes
Type : string
instanceGroupManager
Type : string
Required : Yes
Description : Name of the managed instance group to return.
Location : path
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])?))
Type : string
Required : Yes
▼ ▲ compute.regionInstanceGroupManagers.deleteInstances
Parameter Order :
Apiversion : 2026-12-01-preview
Parameters :
instanceGroupManager
Type : string
Required : Yes
Description : Name of the managed instance group.
Location : path
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
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])?))
Description : Project ID for this request.
Location : path
region
Description : Name of the region scoping this request.
Location : path
Required : Yes
Type : string
noGracefulShutdown
Location : query
Description : When set, graceful shutdown is skipped for instance deletion even if it's configured for the instances.
Type : boolean
Default : false
Scopes :
Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/deleteInstances
Flat Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/deleteInstances
HTTP Method : POST
Description : Flags the specified instances in the managed instance group to be immediately deleted. The instances are also removed from any target pools of which they were a member. This method reduces thetargetSize of the managed instance group by the number of instances that you delete. The deleteInstances operation is marked DONE if the deleteInstances request is successful. The underlying actions take additional time. You must separately verify the status of thedeleting action with thelistmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request.
▼ ▲ compute.regionInstanceGroupManagers.resize
Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resize
Parameters :
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).
region
Description : Name of the region scoping this request.
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])?))
Description : Project ID for this request.
Location : path
Type : string
Required : Yes
instanceGroupManager
Location : path
Type : string
Required : Yes
Description : Name of the managed instance group.
size
Required : Yes
Description : Number of instances that should exist in this instance group manager.
Location : query
Type : integer
Format : int32
Minimum : 0
Apiversion : 2026-12-01-preview
Scopes :
HTTP Method : POST
Parameter Order :
Description : Changes the intended size of the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes one or more instances. The resize operation is marked DONE if theresize request is successful. The underlying actions take additional time. You must separately verify the status of thecreating or deleting actions with thelistmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.
Flat Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resize
▼ ▲ compute.regionInstanceGroupManagers.createInstances
Scopes :
Flat Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/createInstances
Description : Creates instances with per-instance configurations in this regional managed instance group. Instances are created using the current instance template. The create instances operation is marked DONE if the createInstances request is successful. The underlying actions take additional time. You must separately verify the status of thecreating or actions with the listmanagedinstances method.
HTTP Method : POST
Parameters :
instanceGroupManager
Description : The name of the managed instance group. It should conform to RFC1035.
Required : Yes
Type : string
Location : path
requestId
Location : query
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. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
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.
Type : string
Required : Yes
Location : path
region
Description : The name of theregion where the managed instance group is located. It should conform to RFC1035.
Required : Yes
Location : path
Type : string
Apiversion : 2026-12-01-preview
Parameter Order :
Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/createInstances
▼ ▲ compute.regionInstanceGroupManagers.suspendInstances
Apiversion : 2026-12-01-preview
Scopes :
Parameter Order :
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).
Location : query
Type : string
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 : Project ID for this request.
Location : path
instanceGroupManager
Description : Name of the managed instance group.
Type : string
Required : Yes
Location : path
region
Description : Name of the region scoping this request.
Required : Yes
Type : string
Location : path
Description : Flags the specified instances in the managed instance group to be immediately suspended. You can only specify instances that are running in this request. This method reduces thetargetSize and increases the targetSuspendedSize of the managed instance group by the number of instances that you suspend. The suspendInstances operation is marked DONE if the suspendInstances request is successful. The underlying actions take additional time. You must separately verify the status of theSUSPENDING action with thelistmanagedinstances method. If the standbyPolicy.initialDelaySec field is set, the group delays suspension of the instances until initialDelaySec have passed from instance.creationTimestamp (that is, when the instance was created). This delay gives your application time to set itself up and initialize on the instance. If more thaninitialDelaySec seconds have passed sinceinstance.creationTimestamp when this method is called, there will be zero delay. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is suspended. Suspended instances can be resumed using the resumeInstances method. You can specify a maximum of 1000 instances with this method per request.
Flat Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/suspendInstances
Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/suspendInstances
HTTP Method : POST
▼ ▲ compute.regionInstanceGroupManagers.deletePerInstanceConfigs
Parameter Order :
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/deletePerInstanceConfigs
Parameters :
instanceGroupManager
Description : The name of the managed instance group. It should conform to RFC1035.
Required : Yes
Location : path
Type : string
region
Type : string
Description : Name of the region scoping this request, should conform to RFC1035.
Required : Yes
Location : path
project
Required : Yes
Location : path
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])?))
Type : string
HTTP Method : POST
Scopes :
Description : Deletes selected per-instance configurations for the managed instance group.
Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/deletePerInstanceConfigs
▼ ▲ compute.regionInstanceGroupManagers.delete
Parameter Order :
Flat Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}
Apiversion : 2026-12-01-preview
Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}
Parameters :
project
Description : Project ID for this request.
Location : path
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])?))
region
Type : string
Location : path
Description : Name of the region scoping this request.
Required : Yes
noGracefulShutdown
Type : boolean
Location : query
Description : When set, graceful shutdown is skipped for instance deletion even if it's configured for the instances.
Default : false
requestId
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).
Location : query
instanceGroupManager
Location : path
Type : string
Description : Name of the managed instance group to delete.
Required : Yes
Scopes :
HTTP Method : DELETE
Description : Deletes the specified managed instance group and all of the instances in that group.
▼ ▲ compute.regionInstanceGroupManagers.list
Flat Path : projects/{project}/regions/{region}/instanceGroupManagers
HTTP Method : GET
Parameter Order :
Apiversion : 2026-12-01-preview
Scopes :
Path : projects/{project}/regions/{region}/instanceGroupManagers
Parameters :
filter
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.
Location : query
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
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.
Type : string
Required : Yes
region
Required : Yes
Type : string
Description : Name of the region scoping this request.
Location : path
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
maxResults
Location : query
Format : uint32
Default : 500
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`)
Type : integer
Description : Retrieves the list of managed instance groups that are contained within the specified region.
▼ ▲ compute.regionInstanceGroupManagers.listPerInstanceConfigs
Parameters :
instanceGroupManager
Type : string
Description : The name of the managed instance group. It should conform to RFC1035.
Location : path
Required : Yes
region
Required : Yes
Location : path
Type : string
Description : Name of the region scoping this request, should conform to RFC1035.
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.
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
Minimum : 0
Type : integer
Location : query
Format : uint32
project
Location : path
Description : Project ID for this request.
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])?))
Type : string
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
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.
Apiversion : 2026-12-01-preview
Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listPerInstanceConfigs
Parameter Order :
Description : Lists all of the per-instance configurations defined for the managed instance group. The orderBy query parameter is not supported.
Scopes :
Flat Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listPerInstanceConfigs
HTTP Method : POST
▼ ▲ compute.regionInstanceGroupManagers.startInstances
Description : Flags the specified instances in the managed instance group to be started. This method increases thetargetSize and decreases the targetStoppedSize of the managed instance group by the number of instances that you start. The startInstances operation is marked DONE if the startInstances request is successful. The underlying actions take additional time. You must separately verify the status of theSTARTING action with thelistmanagedinstances method. In this request, you can only specify instances that are stopped. For example, if an instance was previously stopped using the stopInstances method, it can be started using the startInstances method. If a health check is attached to the managed instance group, the specified instances will be verified as healthy after they are started. You can specify a maximum of 1000 instances with this method per request.
Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/startInstances
Scopes :
HTTP Method : POST
Flat Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/startInstances
Parameter Order :
Parameters :
project
Required : Yes
Description : Project ID for this request.
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])?))
instanceGroupManager
Required : Yes
Type : string
Location : path
Description : Name of the managed instance group.
region
Description : Name of the region scoping this request.
Type : string
Required : Yes
Location : path
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).
Apiversion : 2026-12-01-preview
▼ ▲ compute.regionInstanceGroupManagers.patchPerInstanceConfigs
Description : Inserts or patches per-instance configurations for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch.
Flat Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/patchPerInstanceConfigs
Parameters :
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])?))
Description : Project ID for this request.
Type : string
Required : Yes
region
Type : string
Location : path
Description : Name of the region scoping this request, should conform to RFC1035.
Required : Yes
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).
instanceGroupManager
Required : Yes
Description : The name of the managed instance group. It should conform to RFC1035.
Type : string
Location : path
Parameter Order :
Apiversion : 2026-12-01-preview
HTTP Method : POST
Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/patchPerInstanceConfigs
Scopes :
▼ ▲ compute.regionInstanceGroupManagers.insert
Parameters :
region
Type : string
Location : path
Required : Yes
Description : Name of the region scoping this request.
project
Description : Project ID for this request.
Location : path
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])?))
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
Path : projects/{project}/regions/{region}/instanceGroupManagers
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/regions/{region}/instanceGroupManagers
Parameter Order :
Description : Creates a managed instance group using the information that you specify in the request. After the group is created, instances in the group are created using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with thelistmanagedinstances method. A regional managed instance group can contain up to 2000 instances.
Scopes :
HTTP Method : POST
▼ ▲ compute.regionInstanceGroupManagers.patch
Description : Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is patched even if the instances in the group are still in the process of being patched. You must separately verify the status of the individual instances with the listmanagedinstances method. This method supportsPATCH semantics and uses theJSON merge patch format and processing rules. If you update your group to specify a new template or instance configuration, it's possible that your intended specification for each VM in the group is different from the current state of that VM. To learn how to apply an updated configuration to the VMs in a MIG, seeUpdating instances in a MIG.
Scopes :
Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}
Apiversion : 2026-12-01-preview
Parameter Order :
Parameters :
project
Required : Yes
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])?))
Type : string
Location : path
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
region
Required : Yes
Description : Name of the region scoping this request.
Type : string
Location : path
instanceGroupManager
Required : Yes
Description : The name of the instance group manager.
Location : path
Type : string
HTTP Method : PATCH
Flat Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}
▼ ▲ compute.regionInstanceGroupManagers.updatePerInstanceConfigs
HTTP Method : POST
Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/updatePerInstanceConfigs
Flat Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/updatePerInstanceConfigs
Scopes :
Apiversion : 2026-12-01-preview
Parameter Order :
Description : Inserts or updates per-instance configurations for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch.
Parameters :
instanceGroupManager
Location : path
Description : The name of the managed instance group. It should conform to RFC1035.
Type : string
Required : Yes
requestId
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).
Location : query
region
Required : Yes
Description : Name of the region scoping this request, should conform to RFC1035.
Location : path
Type : string
project
Type : string
Description : Project ID for this request.
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])?))
▼ ▲ compute.regionInstanceGroupManagers.stopInstances
Apiversion : 2026-12-01-preview
Parameters :
noGracefulShutdown
Location : query
Default : false
Type : boolean
Description : When set, graceful shutdown is skipped for instance stopping even if it's configured for the instances.
instanceGroupManager
Description : The name of the managed instance group.
Required : Yes
Type : string
Location : path
requestId
Type : string
Location : query
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).
region
Location : path
Type : string
Required : Yes
Description : Name of the region 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])?))
Type : string
Location : path
Description : Project ID for this request.
Required : Yes
Description : Flags the specified instances in the managed instance group to be immediately stopped. You can only specify instances that are running in this request. This method reduces thetargetSize and increases the targetStoppedSize of the managed instance group by the number of instances that you stop. The stopInstances operation is marked DONE if the stopInstances request is successful. The underlying actions take additional time. You must separately verify the status of theSTOPPING action with thelistmanagedinstances method. If the standbyPolicy.initialDelaySec field is set, the group delays stopping the instances until initialDelaySec have passed from instance.creationTimestamp (that is, when the instance was created). This delay gives your application time to set itself up and initialize on the instance. If more thaninitialDelaySec seconds have passed sinceinstance.creationTimestamp when this method is called, there will be zero delay. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is stopped. Stopped instances can be started using the startInstances method. You can specify a maximum of 1000 instances with this method per request.
Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/stopInstances
Parameter Order :
HTTP Method : POST
Scopes :
Flat Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/stopInstances
▼ ▲ compute.regionInstanceGroupManagers.listErrors
HTTP Method : GET
Scopes :
Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listErrors
Flat Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listErrors
Description : Lists all errors thrown by actions on instances for a given regional managed instance group. The filter andorderBy query parameters are not supported.
Parameter Order :
Apiversion : 2026-12-01-preview
Parameters :
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
region
Location : path
Description : Name of the region scoping this request. This should conform to RFC1035.
Type : string
Required : Yes
maxResults
Default : 500
Format : uint32
Minimum : 0
Location : query
Type : integer
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`)
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])?))
Type : string
Description : Project ID for this request.
Required : Yes
Location : path
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.
Location : query
Type : string
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.
Type : string
Location : query
instanceGroupManager
Required : Yes
Description : The name of the managed instance group. It must be a string that meets the requirements in RFC1035, or an unsigned long integer: must match regexp pattern: (?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?)|1-9{0,19}.
Type : string
Location : path
▼ ▲ compute.regionInstanceGroupManagers.resumeInstances
Parameter Order :
Apiversion : 2026-12-01-preview
Description : Flags the specified instances in the managed instance group to be resumed. This method increases thetargetSize and decreases the targetSuspendedSize of the managed instance group by the number of instances that you resume. The resumeInstances operation is marked DONE if the resumeInstances request is successful. The underlying actions take additional time. You must separately verify the status of theRESUMING action with thelistmanagedinstances method. In this request, you can only specify instances that are suspended. For example, if an instance was previously suspended using the suspendInstances method, it can be resumed using the resumeInstances method. If a health check is attached to the managed instance group, the specified instances will be verified as healthy after they are resumed. You can specify a maximum of 1000 instances with this method per request.
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).
Location : query
Type : string
instanceGroupManager
Location : path
Required : Yes
Type : string
Description : Name of the managed instance group.
region
Type : string
Required : Yes
Location : path
Description : Name of the region 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])?))
Required : Yes
Location : path
Description : Project ID for this request.
Type : string
HTTP Method : POST
Flat Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resumeInstances
Scopes :
Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resumeInstances
▼ ▲ compute.regionInstanceGroupManagers.listManagedInstances
Scopes :
Parameter Order :
Flat Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listManagedInstances
HTTP Method : POST
Description : Lists the instances in the managed instance group and instances that are scheduled to be created. The list includes any current actions that the group has scheduled for its instances. The orderBy query parameter is not supported. The `pageToken` query parameter is supported only if the group's `listManagedInstancesResults` field is set to `PAGINATED`.
Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listManagedInstances
Apiversion : 2026-12-01-preview
Parameters :
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
Location : path
Description : The name of the managed instance group.
Required : Yes
Type : string
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.
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`)
Format : uint32
Type : integer
Default : 500
Location : query
Minimum : 0
region
Location : path
Type : string
Description : Name of the region scoping this request.
Required : Yes
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
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])?))
Type : string
Location : path
Description : Project ID for this request.
▼ ▲ compute.regionInstanceGroupManagers.applyUpdatesToInstances
Scopes :
Apiversion : 2026-12-01-preview
Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/applyUpdatesToInstances
Parameters :
project
Location : path
Description : Project ID for this request.
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])?))
Required : Yes
instanceGroupManager
Description : The name of the managed instance group, should conform to RFC1035.
Location : path
Type : string
Required : Yes
region
Type : string
Required : Yes
Description : Name of the region scoping this request, should conform to RFC1035.
Location : path
HTTP Method : POST
Description : Apply updates to selected instances the managed instance group.
Flat Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/applyUpdatesToInstances
Parameter Order :
▼ ▲ compute.regionInstanceGroupManagers.setInstanceTemplate
Scopes :
Parameter Order :
Parameters :
instanceGroupManager
Type : string
Required : Yes
Description : The name of the managed instance group.
Location : path
requestId
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).
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
Required : Yes
Description : Project ID for this request.
region
Required : Yes
Description : Name of the region scoping this request.
Location : path
Type : string
Flat Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setInstanceTemplate
Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setInstanceTemplate
Apiversion : 2026-12-01-preview
Description : Sets the instance template to use when creating new instances or recreating instances in this group. Existing instances are not affected.
HTTP Method : POST
▼ ▲ compute.regionInstanceGroupManagers.abandonInstances
Parameter Order :
Description : Flags the specified instances to be immediately removed from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces thetargetSize of the managed instance group by the number of instances that you abandon. This operation is marked asDONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with thelistmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request.
Flat Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/abandonInstances
HTTP Method : POST
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])?))
Description : Project ID for this request.
Type : string
Required : Yes
Location : path
instanceGroupManager
Required : Yes
Type : string
Description : Name of the managed instance group.
Location : path
region
Type : string
Required : Yes
Description : Name of the region scoping this request.
Location : path
requestId
Location : query
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
Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/abandonInstances
Apiversion : 2026-12-01-preview
Scopes :
▼ ▲ compute.storagePools.listDisks
Path : projects/{project}/zones/{zone}/storagePools/{storagePool}/listDisks
Parameter Order :
Flat Path : projects/{project}/zones/{zone}/storagePools/{storagePool}/listDisks
Description : Lists the disks in a specified storage pool.
Scopes :
Parameters :
zone
Location : path
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Description : The name of the zone for this request.
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.
Type : string
Location : query
storagePool
Type : string
Description : Name of the storage pool to list disks of.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
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
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])?))
Location : path
Description : Project ID for this request.
maxResults
Format : uint32
Location : query
Type : integer
Minimum : 0
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`)
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.
Type : string
Location : query
Apiversion : 2026-12-01-preview
HTTP Method : GET
▼ ▲ compute.storagePools.setIamPolicy
Apiversion : 2026-12-01-preview
Description : Sets the access control policy on the specified resource. Replaces any existing policy.
Parameters :
project
Location : path
Description : Project ID for this request.
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])?))
Type : string
resource
Required : Yes
Description : Name or id of the resource for this request.
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
zone
Required : Yes
Type : string
Description : The name of the zone for this request.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Flat Path : projects/{project}/zones/{zone}/storagePools/{resource}/setIamPolicy
Parameter Order :
Scopes :
Path : projects/{project}/zones/{zone}/storagePools/{resource}/setIamPolicy
HTTP Method : POST
▼ ▲ compute.storagePools.testIamPermissions
HTTP Method : POST
Parameter Order :
Description : Returns permissions that a caller has on the specified resource.
Scopes :
Path : projects/{project}/zones/{zone}/storagePools/{resource}/testIamPermissions
Parameters :
zone
Required : Yes
Type : string
Description : The name of the zone for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
resource
Location : path
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Description : Name or id of the resource for this request.
project
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])?))
Required : Yes
Location : path
Description : Project ID for this request.
Flat Path : projects/{project}/zones/{zone}/storagePools/{resource}/testIamPermissions
Apiversion : 2026-12-01-preview
▼ ▲ compute.storagePools.insert
Parameter Order :
Path : projects/{project}/zones/{zone}/storagePools
Description : Creates a storage pool in the specified project using the data in the request.
HTTP Method : POST
Scopes :
Parameters :
project
Type : string
Description : Project ID for this request.
Location : path
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])?))
zone
Description : The name of the zone for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Type : string
Required : Yes
requestId
Type : string
Location : query
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).
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/zones/{zone}/storagePools
▼ ▲ compute.storagePools.get
Description : Returns a specified storage pool. Gets a list of available storage pools by making a list() request.
Scopes :
Apiversion : 2026-12-01-preview
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
Description : Project ID for this request.
Location : path
storagePool
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Type : string
Description : Name of the storage pool to return.
zone
Required : Yes
Description : The name of the zone for this request.
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
HTTP Method : GET
Parameter Order :
Path : projects/{project}/zones/{zone}/storagePools/{storagePool}
Flat Path : projects/{project}/zones/{zone}/storagePools/{storagePool}
▼ ▲ compute.storagePools.getIamPolicy
Description : Gets the access control policy for a resource. May be empty if no such policy or resource exists.
Flat Path : projects/{project}/zones/{zone}/storagePools/{resource}/getIamPolicy
Scopes :
HTTP Method : GET
Parameter Order :
Apiversion : 2026-12-01-preview
Path : projects/{project}/zones/{zone}/storagePools/{resource}/getIamPolicy
Parameters :
optionsRequestedPolicyVersion
Location : query
Description : Requested IAM Policy version.
Type : integer
Format : int32
zone
Type : string
Required : Yes
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : The name of the zone for this request.
project
Location : path
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])?))
Description : Project ID for this request.
Required : Yes
resource
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name or id of the resource for this request.
Type : string
Location : path
▼ ▲ compute.storagePools.delete
Apiversion : 2026-12-01-preview
Parameters :
storagePool
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the storage pool to delete.
Required : Yes
Type : string
zone
Required : Yes
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Description : The name of the zone for this request.
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])?))
Required : Yes
Description : Project ID for this request.
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
Path : projects/{project}/zones/{zone}/storagePools/{storagePool}
Flat Path : projects/{project}/zones/{zone}/storagePools/{storagePool}
Description : Deletes the specified storage pool. Deleting a storagePool removes its data permanently and is irreversible. However, deleting a storagePool does not delete any snapshots previously made from the storagePool. You must separately delete snapshots.
Parameter Order :
HTTP Method : DELETE
Scopes :
▼ ▲ compute.storagePools.aggregatedList
Parameter Order : project
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`)
Minimum : 0
Format : uint32
Type : integer
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.
Required : Yes
Location : path
Type : string
orderBy
Type : string
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.
includeAllScopes
Location : query
Type : boolean
Description : Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
serviceProjectNumber
Description : The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.
Format : int64
Type : string
Location : query
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
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.
Location : query
Type : string
Path : projects/{project}/aggregated/storagePools
Apiversion : 2026-12-01-preview
Description : Retrieves an aggregated list of storage pools. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.
HTTP Method : GET
Scopes :
Flat Path : projects/{project}/aggregated/storagePools
▼ ▲ compute.storagePools.update
Path : projects/{project}/zones/{zone}/storagePools/{storagePool}
HTTP Method : PATCH
Scopes :
Description : Updates the specified storagePool with the data included in the request. The update is performed only on selected fields included as part of update-mask. Only the following fields can be modified: pool_provisioned_capacity_gb, pool_provisioned_iops and pool_provisioned_throughput.
Apiversion : 2026-12-01-preview
Parameters :
storagePool
Description : The storagePool name for this request.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Required : Yes
requestId
Location : query
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
zone
Required : Yes
Type : string
Description : The name of the zone for this request.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
updateMask
Location : query
Type : string
Format : google-fieldmask
Description : update_mask indicates fields to be updated as part of this request.
project
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])?))
Location : path
Description : Project ID for this request.
Flat Path : projects/{project}/zones/{zone}/storagePools/{storagePool}
Parameter Order :
▼ ▲ compute.storagePools.list
Parameter Order :
Description : Retrieves a list of storage pools contained within the specified zone.
Path : projects/{project}/zones/{zone}/storagePools
Flat Path : projects/{project}/zones/{zone}/storagePools
Scopes :
HTTP Method : GET
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])?))
Description : Project ID for this request.
Required : Yes
Type : string
Location : path
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
maxResults
Location : query
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`)
Format : uint32
Minimum : 0
Default : 500
Type : integer
orderBy
Type : string
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.
zone
Location : path
Required : Yes
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : The name of the zone for this request.
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
Apiversion : 2026-12-01-preview
▼ ▲ compute.regionHealthCheckServices.get
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}
Parameters :
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Type : string
Location : path
Description : Name of the region scoping this request.
project
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])?))
Required : Yes
Description : Project ID for this request.
healthCheckService
Description : Name of the HealthCheckService to update. The name must be 1-63 characters long, and comply with RFC1035.
Location : path
Required : Yes
Type : string
Description : Returns the specified regional HealthCheckService resource.
HTTP Method : GET
Scopes :
Path : projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}
Parameter Order :
▼ ▲ compute.regionHealthCheckServices.aggregatedList
Apiversion : 2026-12-01-preview
Description : Retrieves the list of all HealthCheckService resources, regional and global, available to the specified project. To prevent failure, it is recommended that you set the `returnPartialSuccess` parameter to `true`.
Parameter Order : project
Parameters :
project
Required : Yes
Type : string
Location : path
Description : Name of the project scoping 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])?))
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
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
maxResults
Type : integer
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
Location : query
Minimum : 0
serviceProjectNumber
Format : int64
Description : The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.
Location : query
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
includeAllScopes
Type : boolean
Location : query
Description : Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
Scopes :
HTTP Method : GET
Flat Path : projects/{project}/aggregated/healthCheckServices
Path : projects/{project}/aggregated/healthCheckServices
▼ ▲ compute.regionHealthCheckServices.delete
Scopes :
HTTP Method : DELETE
Parameter Order :
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}
Parameters :
healthCheckService
Required : Yes
Type : string
Location : path
Description : Name of the HealthCheckService to delete. The name must be 1-63 characters long, and comply with RFC1035.
region
Description : Name of the region scoping this request.
Type : string
Location : path
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
requestId
Type : string
Location : query
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).
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])?))
Type : string
Location : path
Description : Project ID for this request.
Required : Yes
Path : projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}
Description : Deletes the specified regional HealthCheckService.
▼ ▲ compute.regionHealthCheckServices.testIamPermissions
Path : projects/{project}/regions/{region}/healthCheckServices/{resource}/testIamPermissions
Apiversion : 2026-12-01-preview
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])?))
Type : string
Location : path
Description : Project ID for this request.
Required : Yes
resource
Type : string
Required : Yes
Description : Name or id of the resource for this request.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
region
Required : Yes
Type : string
Description : The name of the region for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
HTTP Method : POST
Description : Returns permissions that a caller has on the specified resource.
Parameter Order :
Flat Path : projects/{project}/regions/{region}/healthCheckServices/{resource}/testIamPermissions
Scopes :
▼ ▲ compute.regionHealthCheckServices.insert
Scopes :
Parameters :
requestId
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).
Location : query
region
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Description : Name of the region scoping this request.
Required : Yes
project
Location : path
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])?))
Description : Project ID for this request.
Required : Yes
Apiversion : 2026-12-01-preview
Path : projects/{project}/regions/{region}/healthCheckServices
Description : Creates a regional HealthCheckService resource in the specified project and region using the data included in the request.
HTTP Method : POST
Flat Path : projects/{project}/regions/{region}/healthCheckServices
Parameter Order :
▼ ▲ compute.regionHealthCheckServices.list
HTTP Method : GET
Flat Path : projects/{project}/regions/{region}/healthCheckServices
Scopes :
Apiversion : 2026-12-01-preview
Description : Lists all the HealthCheckService resources that have been configured for the specified project in the given region.
Parameter Order :
Path : projects/{project}/regions/{region}/healthCheckServices
Parameters :
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.
pageToken
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.
Type : string
maxResults
Format : uint32
Type : integer
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`)
Minimum : 0
Default : 500
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.
region
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Description : Name of the region scoping this request.
Type : string
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])?))
Description : Project ID for this request.
Required : Yes
Type : string
▼ ▲ compute.regionHealthCheckServices.patch
Description : Updates the specified regional HealthCheckService resource with the data included in the request. This method supportsPATCH semantics and uses theJSON merge patch format and processing rules.
Path : projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}
Parameters :
region
Description : Name of the region scoping this request.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Location : path
healthCheckService
Description : Name of the HealthCheckService to update. The name must be 1-63 characters long, and comply with RFC1035.
Location : path
Required : Yes
Type : string
project
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])?))
Location : path
Description : Project ID for this request.
Required : Yes
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
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}
HTTP Method : PATCH
Parameter Order :
Scopes :
▼ ▲ compute.snapshots.delete
HTTP Method : DELETE
Scopes :
Description : Deletes the specified Snapshot resource. Keep in mind that deleting a single snapshot might not necessarily delete all the data on that snapshot. If any data on the snapshot that is marked for deletion is needed for subsequent snapshots, the data will be moved to the next corresponding snapshot. For more information, seeDeleting snapshots.
Flat Path : projects/{project}/global/snapshots/{snapshot}
Path : projects/{project}/global/snapshots/{snapshot}
Apiversion : 2026-12-01-preview
Parameters :
snapshot
Type : string
Description : Name of the Snapshot resource to delete.
Location : path
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
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])?))
Type : string
Location : path
Description : Project ID for 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
Parameter Order :
▼ ▲ compute.snapshots.setIamPolicy
Flat Path : projects/{project}/global/snapshots/{resource}/setIamPolicy
HTTP Method : POST
Description : Sets the access control policy on the specified resource. Replaces any existing policy.
Parameter Order :
Parameters :
project
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])?))
Required : Yes
Location : path
Description : Project ID for this request.
resource
Location : path
Type : string
Description : Name or id of the resource for this request.
Required : Yes
Pattern : [a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Apiversion : 2026-12-01-preview
Path : projects/{project}/global/snapshots/{resource}/setIamPolicy
Scopes :
▼ ▲ compute.snapshots.get
Parameter Order :
HTTP Method : GET
Path : projects/{project}/global/snapshots/{snapshot}
Scopes :
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/global/snapshots/{snapshot}
Parameters :
snapshot
Description : Name of the Snapshot resource to return.
Location : path
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
project
Description : Project ID for this request.
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])?))
Location : path
Type : string
Description : Returns the specified Snapshot resource.
▼ ▲ compute.snapshots.testIamPermissions
HTTP Method : POST
Flat Path : projects/{project}/global/snapshots/{resource}/testIamPermissions
Path : projects/{project}/global/snapshots/{resource}/testIamPermissions
Description : Returns permissions that a caller has on the specified resource.
Parameter Order :
Scopes :
Apiversion : 2026-12-01-preview
Parameters :
project
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])?))
Description : Project ID for this request.
Location : path
resource
Pattern : [a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name or id of the resource for this request.
Type : string
Required : Yes
Location : path
▼ ▲ compute.snapshots.setLabels
Parameter Order :
Description : Sets the labels on a snapshot. To learn more about labels, read theLabeling Resources documentation.
Flat Path : projects/{project}/global/snapshots/{resource}/setLabels
HTTP Method : POST
Path : projects/{project}/global/snapshots/{resource}/setLabels
Scopes :
Apiversion : 2026-12-01-preview
Parameters :
resource
Type : string
Required : Yes
Description : Name or id of the resource for this request.
Location : path
Pattern : [a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
project
Required : Yes
Description : Project ID for this request.
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])?))
▼ ▲ compute.snapshots.insert
Scopes :
Apiversion : 2026-12-01-preview
Path : projects/{project}/global/snapshots
Parameters :
project
Required : Yes
Description : Project ID for this request.
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])?))
requestId
Type : string
Location : query
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 : project
Description : Creates a snapshot in the specified project using the data included in the request. For regular snapshot creation, consider using this method instead of disks.createSnapshot, as this method supports more features, such as creating snapshots in a project different from the source disk project.
HTTP Method : POST
Flat Path : projects/{project}/global/snapshots
▼ ▲ compute.snapshots.updateKmsKey
HTTP Method : POST
Scopes :
Parameter Order :
Path : projects/{project}/global/snapshots/{snapshot}/updateKmsKey
Flat Path : projects/{project}/global/snapshots/{snapshot}/updateKmsKey
Apiversion : 2026-12-01-preview
Description : Rotates the customer-managed encryption key to the latest version for the specified snapshot.
Parameters :
snapshot
Required : Yes
Description : Name of the snapshot resource to update. Should conform to RFC1035.
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
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
Location : path
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])?))
Required : Yes
▼ ▲ compute.snapshots.list
Path : projects/{project}/global/snapshots
Apiversion : 2026-12-01-preview
Parameter Order : project
Parameters :
maxResults
Minimum : 0
Default : 500
Type : integer
Location : query
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
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
filter
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.
Location : query
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
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])?))
Required : Yes
Location : path
Description : Project ID for this request.
Flat Path : projects/{project}/global/snapshots
Scopes :
Description : Retrieves the list of Snapshot resources contained within the specified project.
HTTP Method : GET
▼ ▲ compute.snapshots.getIamPolicy
Apiversion : 2026-12-01-preview
Parameters :
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
resource
Pattern : [a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Location : path
Description : Name or id of the resource for this request.
Type : string
optionsRequestedPolicyVersion
Type : integer
Location : query
Description : Requested IAM Policy version.
Format : int32
Description : Gets the access control policy for a resource. May be empty if no such policy or resource exists.
Flat Path : projects/{project}/global/snapshots/{resource}/getIamPolicy
HTTP Method : GET
Parameter Order :
Path : projects/{project}/global/snapshots/{resource}/getIamPolicy
Scopes :
▼ ▲ compute.targetInstances.insert
Scopes :
Flat Path : projects/{project}/zones/{zone}/targetInstances
HTTP Method : POST
Apiversion : 2026-12-01-preview
Parameters :
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
Type : string
Description : Name of the zone scoping this request.
Required : Yes
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
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
Required : Yes
Description : Project ID for this request.
Parameter Order :
Path : projects/{project}/zones/{zone}/targetInstances
Description : Creates a TargetInstance resource in the specified project and zone using the data included in the request.
▼ ▲ compute.targetInstances.list
Path : projects/{project}/zones/{zone}/targetInstances
HTTP Method : GET
Scopes :
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.
Location : query
Type : string
zone
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Description : Name of the zone scoping this request.
Type : string
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
maxResults
Location : query
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
Default : 500
Minimum : 0
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.
Type : string
Location : query
project
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])?))
Description : Project ID for this request.
Location : path
Parameter Order :
Flat Path : projects/{project}/zones/{zone}/targetInstances
Description : Retrieves a list of TargetInstance resources available to the specified project and zone.
Apiversion : 2026-12-01-preview
▼ ▲ compute.targetInstances.delete
Flat Path : projects/{project}/zones/{zone}/targetInstances/{targetInstance}
Parameter Order :
Parameters :
targetInstance
Description : Name of the TargetInstance resource to delete.
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
project
Location : path
Type : string
Required : Yes
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])?))
requestId
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).
Location : query
zone
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Type : string
Description : Name of the zone scoping this request.
Required : Yes
Apiversion : 2026-12-01-preview
Scopes :
Description : Deletes the specified TargetInstance resource.
HTTP Method : DELETE
Path : projects/{project}/zones/{zone}/targetInstances/{targetInstance}
▼ ▲ compute.targetInstances.aggregatedList
HTTP Method : GET
Scopes :
Description : Retrieves an aggregated list of target instances. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.
Apiversion : 2026-12-01-preview
Parameter Order : project
Parameters :
serviceProjectNumber
Location : query
Format : int64
Type : string
Description : The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.
orderBy
Type : string
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.
maxResults
Type : integer
Default : 500
Minimum : 0
Location : query
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`)
filter
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.
Type : string
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
includeAllScopes
Description : Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
Location : query
Type : boolean
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
Path : projects/{project}/aggregated/targetInstances
Flat Path : projects/{project}/aggregated/targetInstances
▼ ▲ compute.targetInstances.testIamPermissions
Apiversion : 2026-12-01-preview
Parameters :
zone
Required : Yes
Type : string
Description : The name of the zone for this request.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
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
Description : Project ID for this request.
Type : string
resource
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name or id of the resource for this request.
Required : Yes
Location : path
Type : string
Path : projects/{project}/zones/{zone}/targetInstances/{resource}/testIamPermissions
HTTP Method : POST
Flat Path : projects/{project}/zones/{zone}/targetInstances/{resource}/testIamPermissions
Parameter Order :
Description : Returns permissions that a caller has on the specified resource.
Scopes :
▼ ▲ compute.targetInstances.get
Scopes :
Parameters :
targetInstance
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the TargetInstance resource to return.
Type : string
Required : Yes
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.
Required : Yes
Location : path
Type : string
zone
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Name of the zone scoping this request.
Type : string
Required : Yes
Apiversion : 2026-12-01-preview
Description : Returns the specified TargetInstance resource.
HTTP Method : GET
Path : projects/{project}/zones/{zone}/targetInstances/{targetInstance}
Parameter Order :
Flat Path : projects/{project}/zones/{zone}/targetInstances/{targetInstance}
▼ ▲ compute.targetInstances.setSecurityPolicy
Apiversion : 2026-12-01-preview
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
Description : Project ID for this request.
Location : path
requestId
Location : query
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
targetInstance
Location : path
Description : Name of the TargetInstance resource to which the security policy should be set. The name should conform to RFC1035.
Required : Yes
Type : string
zone
Location : path
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Description : Name of the zone scoping this request.
Flat Path : projects/{project}/zones/{zone}/targetInstances/{targetInstance}/setSecurityPolicy
Scopes :
Description : Sets the Google Cloud Armor security policy for the specified target instance. For more information, seeGoogle Cloud Armor Overview
HTTP Method : POST
Parameter Order :
Path : projects/{project}/zones/{zone}/targetInstances/{targetInstance}/setSecurityPolicy
▼ ▲ compute.routers.getNatMappingInfo
Apiversion : 2026-12-01-preview
Parameters :
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.
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.
natName
Location : query
Description : Name of the nat service to filter the Nat Mapping information. If it is omitted, all nats for this router will be returned. Name should conform to RFC1035.
Type : string
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])?))
Description : Project ID for this request.
Required : Yes
Type : string
router
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Description : Name of the Router resource to query for Nat Mapping information of VM endpoints.
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
maxResults
Default : 500
Type : integer
Minimum : 0
Format : uint32
Location : query
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`)
region
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Type : string
Description : Name of the region for this request.
Parameter Order :
Flat Path : projects/{project}/regions/{region}/routers/{router}/getNatMappingInfo
Scopes :
Path : projects/{project}/regions/{region}/routers/{router}/getNatMappingInfo
HTTP Method : GET
Description : Retrieves runtime Nat mapping information of VM endpoints.
▼ ▲ compute.routers.patchRoutePolicy
Parameter Order :
Flat Path : projects/{project}/regions/{region}/routers/{router}/patchRoutePolicy
HTTP Method : POST
Description : Patches Route Policy
Scopes :
Apiversion : 2026-12-01-preview
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).
Location : query
Type : string
region
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Description : Name of the region for this request.
Type : string
router
Description : Name of the Router resource where Route Policy is defined.
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
project
Description : Project ID for this request.
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])?))
Required : Yes
Location : path
Path : projects/{project}/regions/{region}/routers/{router}/patchRoutePolicy
▼ ▲ compute.routers.aggregatedList
Scopes :
HTTP Method : GET
Parameter Order : project
Description : Retrieves an aggregated list of routers. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.
Path : projects/{project}/aggregated/routers
Flat Path : projects/{project}/aggregated/routers
Parameters :
project
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])?))
Required : Yes
Location : path
Type : string
serviceProjectNumber
Type : string
Description : The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.
Location : query
Format : int64
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
includeAllScopes
Type : boolean
Description : Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
Location : query
maxResults
Format : uint32
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`)
Type : integer
Default : 500
Location : query
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.
Location : query
Type : string
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
Apiversion : 2026-12-01-preview
▼ ▲ compute.routers.patchNamedSet
Scopes :
Flat Path : projects/{project}/regions/{region}/routers/{router}/patchNamedSet
Path : projects/{project}/regions/{region}/routers/{router}/patchNamedSet
Apiversion : 2026-12-01-preview
Parameters :
requestId
Location : query
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
router
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Required : Yes
Description : Name of the Router resource where Named Set is defined.
Location : path
region
Location : path
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Name of the region for this request.
Type : string
project
Type : string
Location : path
Required : Yes
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])?))
Parameter Order :
Description : Patches Named Set
HTTP Method : POST
▼ ▲ compute.routers.deleteRoutePolicy
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/regions/{region}/routers/{router}/deleteRoutePolicy
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])?))
Type : string
Description : Project ID for this request.
Location : path
region
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Name of the region for this request.
Required : Yes
Type : string
policy
Location : query
Description : The Policy name for this request. Name must conform to RFC1035
Type : string
requestId
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).
Location : query
router
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Description : Name of the Router resource where Route Policy is defined.
Required : Yes
Description : Deletes Route Policy
Scopes :
Parameter Order :
HTTP Method : POST
Path : projects/{project}/regions/{region}/routers/{router}/deleteRoutePolicy
▼ ▲ compute.routers.list
Apiversion : 2026-12-01-preview
Path : projects/{project}/regions/{region}/routers
Parameters :
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.
maxResults
Default : 500
Minimum : 0
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`)
Location : query
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
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.
Type : string
Required : Yes
region
Type : string
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Name of the region for this request.
Location : path
orderBy
Type : string
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.
Description : Retrieves a list of Router resources available to the specified project.
HTTP Method : GET
Parameter Order :
Scopes :
Flat Path : projects/{project}/regions/{region}/routers
▼ ▲ compute.routers.update
Parameter Order :
Parameters :
router
Description : Name of the Router resource to update.
Type : string
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
project
Required : Yes
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])?))
Type : string
Location : path
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
region
Type : string
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Name of the region for this request.
Location : path
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/regions/{region}/routers/{router}
Path : projects/{project}/regions/{region}/routers/{router}
Scopes :
HTTP Method : PUT
Description : Updates the specified Router resource with the data included in the request. This method conforms toPUT semantics, which requests that the state of the target resource be created or replaced with the state defined by the representation enclosed in the request message payload.
▼ ▲ compute.routers.getRoutePolicy
HTTP Method : GET
Flat Path : projects/{project}/regions/{region}/routers/{router}/getRoutePolicy
Scopes :
Description : Returns specified Route Policy
Apiversion : 2026-12-01-preview
Parameter Order :
Path : projects/{project}/regions/{region}/routers/{router}/getRoutePolicy
Parameters :
region
Required : Yes
Description : Name of the region for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Type : string
policy
Type : string
Description : The Policy name for this request. Name must conform to RFC1035
Location : query
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])?))
router
Location : path
Required : Yes
Type : string
Description : Name of the Router resource to query for the route policy. The name should conform to RFC1035.
▼ ▲ compute.routers.getNatIpInfo
Scopes :
HTTP Method : GET
Description : Retrieves runtime NAT IP information.
Apiversion : 2026-12-01-preview
Parameter Order :
Parameters :
router
Required : Yes
Description : Name of the Router resource to query for Nat IP information. The name should conform to RFC1035.
Type : string
Location : path
project
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])?))
Location : path
natName
Description : Name of the nat service to filter the NAT IP information. If it is omitted, all nats for this router will be returned. Name should conform to RFC1035.
Location : query
Type : string
region
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Name of the region for this request.
Location : path
Required : Yes
Flat Path : projects/{project}/regions/{region}/routers/{router}/getNatIpInfo
Path : projects/{project}/regions/{region}/routers/{router}/getNatIpInfo
▼ ▲ compute.routers.getNamedSet
Apiversion : 2026-12-01-preview
Parameter Order :
Description : Returns specified Named Set
Parameters :
router
Required : Yes
Description : Name of the Router resource to query for the named set. The name should conform to RFC1035.
Type : string
Location : path
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])?))
Type : string
Location : path
Description : Project ID for this request.
Required : Yes
region
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Description : Name of the region for this request.
Required : Yes
namedSet
Description : The Named Set name for this request. Name must conform to RFC1035
Type : string
Location : query
Flat Path : projects/{project}/regions/{region}/routers/{router}/getNamedSet
Scopes :
Path : projects/{project}/regions/{region}/routers/{router}/getNamedSet
HTTP Method : GET
▼ ▲ compute.routers.updateNamedSet
Description : Updates or creates new Named Set
Parameter Order :
Flat Path : projects/{project}/regions/{region}/routers/{router}/updateNamedSet
Apiversion : 2026-12-01-preview
Parameters :
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])?))
Description : Project ID for this request.
Type : string
Required : Yes
region
Required : Yes
Type : string
Description : Name of the region for this request.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
router
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the Router resource where Named Set is defined.
Type : string
Required : Yes
Location : path
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
Scopes :
HTTP Method : POST
Path : projects/{project}/regions/{region}/routers/{router}/updateNamedSet
▼ ▲ compute.routers.listBgpRoutes
Scopes :
Path : projects/{project}/regions/{region}/routers/{router}/listBgpRoutes
Parameter Order :
HTTP Method : GET
Flat Path : projects/{project}/regions/{region}/routers/{router}/listBgpRoutes
Description : Retrieves a list of router bgp routes available to the specified project.
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`)
Minimum : 0
Type : integer
Format : uint32
policyApplied
Description : When true, the method returns post-policy routes. Otherwise, it returns pre-policy routes.
Default : true
Type : boolean
Location : query
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.
Type : string
Required : Yes
peer
Description : (Required) limit results to the BGP peer with the given name. Name should conform to RFC1035.
Location : query
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
addressFamily
Location : query
Default : UNSPECIFIED_IP_VERSION
Description : (Required) limit results to this address family (either IPv4 or IPv6)
Enum Descriptions :
Type : string
Enum :
router
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Required : Yes
Description : Name or id of the resource for this request. Name should conform to RFC1035.
orderBy
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.
Location : query
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.
destinationPrefix
Description : Limit results to destinations that are subnets of this CIDR range
Location : query
Type : string
region
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Description : Name of the region for this request.
Type : string
routeType
Location : query
Default : UNSPECIFIED_ROUTE_TYPE
Type : string
Description : (Required) limit results to this type of route (either LEARNED or ADVERTISED)
Enum Descriptions :
Enum :
Apiversion : 2026-12-01-preview
▼ ▲ compute.routers.get
Flat Path : projects/{project}/regions/{region}/routers/{router}
Scopes :
Apiversion : 2026-12-01-preview
Parameters :
region
Type : string
Location : path
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Name of the region for this request.
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])?))
Description : Project ID for this request.
Type : string
Required : Yes
router
Required : Yes
Type : string
Location : path
Description : Name of the Router resource to return.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Returns the specified Router resource.
HTTP Method : GET
Parameter Order :
Path : projects/{project}/regions/{region}/routers/{router}
▼ ▲ compute.routers.updateRoutePolicy
Scopes :
Apiversion : 2026-12-01-preview
Description : Updates or creates new Route Policy
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).
Location : query
Type : string
router
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Type : string
Description : Name of the Router resource where Route Policy is defined.
Required : Yes
project
Description : Project ID for this request.
Location : path
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])?))
Required : Yes
region
Location : path
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Description : Name of the region for this request.
Parameter Order :
HTTP Method : POST
Path : projects/{project}/regions/{region}/routers/{router}/updateRoutePolicy
Flat Path : projects/{project}/regions/{region}/routers/{router}/updateRoutePolicy
▼ ▲ compute.routers.patch
Apiversion : 2026-12-01-preview
Parameters :
requestId
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).
Location : query
project
Location : path
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])?))
Description : Project ID for this request.
Required : Yes
router
Type : string
Required : Yes
Description : Name of the Router resource to patch.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
region
Description : Name of the region for this request.
Location : path
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Parameter Order :
Flat Path : projects/{project}/regions/{region}/routers/{router}
Scopes :
Path : projects/{project}/regions/{region}/routers/{router}
HTTP Method : PATCH
Description : Patches the specified Router resource with the data included in the request. This method supportsPATCH semantics and usesJSON merge patch format and processing rules.
▼ ▲ compute.routers.getRouterStatus
Parameters :
project
Required : Yes
Description : Project ID for this request.
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])?))
router
Required : Yes
Type : string
Description : Name of the Router resource to query.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
region
Type : string
Location : path
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Name of the region for this request.
Path : projects/{project}/regions/{region}/routers/{router}/getRouterStatus
Apiversion : 2026-12-01-preview
Parameter Order :
Flat Path : projects/{project}/regions/{region}/routers/{router}/getRouterStatus
Scopes :
Description : Retrieves runtime information of the specified router.
HTTP Method : GET
▼ ▲ compute.routers.insert
Parameters :
region
Required : Yes
Description : Name of the region for this request.
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
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])?))
Location : path
Description : Project ID for 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).
Location : query
Type : string
Apiversion : 2026-12-01-preview
Parameter Order :
Scopes :
Description : Creates a Router resource in the specified project and region using the data included in the request.
Path : projects/{project}/regions/{region}/routers
HTTP Method : POST
Flat Path : projects/{project}/regions/{region}/routers
▼ ▲ compute.routers.preview
Flat Path : projects/{project}/regions/{region}/routers/{router}/preview
Path : projects/{project}/regions/{region}/routers/{router}/preview
Scopes :
HTTP Method : POST
Apiversion : 2026-12-01-preview
Parameters :
region
Required : Yes
Type : string
Description : Name of the region for this request.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
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])?))
Location : path
Type : string
Description : Project ID for this request.
router
Description : Name of the Router resource to query.
Location : path
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Parameter Order :
Description : Preview fields auto-generated during router create andupdate operations. Calling this method does NOT create or update the router.
▼ ▲ compute.routers.listNamedSets
Flat Path : projects/{project}/regions/{region}/routers/{router}/listNamedSets
Path : projects/{project}/regions/{region}/routers/{router}/listNamedSets
Parameters :
router
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Required : Yes
Location : path
Description : Name or id of the resource for this request. Name should conform to RFC1035.
maxResults
Type : integer
Format : uint32
Location : query
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`)
Minimum : 0
Default : 500
filter
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.
Type : string
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
region
Description : Name of the region for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
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])?))
Location : path
Type : string
Description : Project ID for this request.
Required : Yes
pageToken
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.
Type : string
Apiversion : 2026-12-01-preview
Description : Retrieves a list of router named set subresources available to the specified project.
HTTP Method : GET
Parameter Order :
Scopes :
▼ ▲ compute.routers.deleteNamedSet
Description : Deletes Named Set
Parameter Order :
Flat Path : projects/{project}/regions/{region}/routers/{router}/deleteNamedSet
Parameters :
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])?))
router
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Required : Yes
Description : Name of the Router resource where Named Set is defined.
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).
namedSet
Type : string
Description : The Named Set name for this request. Name must conform to RFC1035
Location : query
region
Description : Name of the region for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Location : path
Type : string
Path : projects/{project}/regions/{region}/routers/{router}/deleteNamedSet
Apiversion : 2026-12-01-preview
HTTP Method : POST
Scopes :
▼ ▲ compute.routers.delete
Path : projects/{project}/regions/{region}/routers/{router}
Apiversion : 2026-12-01-preview
Description : Deletes the specified Router resource.
Parameters :
router
Description : Name of the Router resource to delete.
Type : string
Location : path
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
project
Required : Yes
Location : path
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])?))
Type : string
requestId
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).
Location : query
region
Description : Name of the region for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Location : path
Type : string
Parameter Order :
HTTP Method : DELETE
Scopes :
Flat Path : projects/{project}/regions/{region}/routers/{router}
▼ ▲ compute.routers.listRoutePolicies
Path : projects/{project}/regions/{region}/routers/{router}/listRoutePolicies
Parameters :
maxResults
Format : uint32
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`)
Type : integer
Default : 500
region
Required : Yes
Description : Name of the region for this request.
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
router
Description : Name or id of the resource for this request. Name should conform to RFC1035.
Required : Yes
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
project
Required : Yes
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])?))
Location : path
Type : string
filter
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.
Type : string
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
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
Scopes :
Apiversion : 2026-12-01-preview
Parameter Order :
Description : Retrieves a list of router route policy subresources available to the specified project.
HTTP Method : GET
Flat Path : projects/{project}/regions/{region}/routers/{router}/listRoutePolicies
▼ ▲ compute.vpnGateways.delete
Parameters :
project
Location : path
Description : Project ID for this request.
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])?))
Required : Yes
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
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Type : string
Location : path
Description : Name of the region for this request.
vpnGateway
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Type : string
Location : path
Description : Name of the VPN gateway to delete.
Scopes :
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/regions/{region}/vpnGateways/{vpnGateway}
Parameter Order :
Path : projects/{project}/regions/{region}/vpnGateways/{vpnGateway}
Description : Deletes the specified VPN gateway.
HTTP Method : DELETE
▼ ▲ compute.vpnGateways.get
Flat Path : projects/{project}/regions/{region}/vpnGateways/{vpnGateway}
Parameter Order :
HTTP Method : GET
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.
Type : string
Location : path
region
Required : Yes
Location : path
Type : string
Description : Name of the region for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
vpnGateway
Location : path
Description : Name of the VPN gateway to return.
Required : Yes
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Returns the specified VPN gateway.
Scopes :
Apiversion : 2026-12-01-preview
Path : projects/{project}/regions/{region}/vpnGateways/{vpnGateway}
▼ ▲ compute.vpnGateways.aggregatedList
Parameter Order : project
Scopes :
HTTP Method : GET
Description : Retrieves an aggregated list of VPN gateways. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/aggregated/vpnGateways
Parameters :
pageToken
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.
Type : string
serviceProjectNumber
Type : string
Location : query
Description : The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.
Format : int64
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`)
Format : uint32
Default : 500
Minimum : 0
Location : query
Type : integer
includeAllScopes
Type : boolean
Location : query
Description : Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
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
Type : string
Description : Project ID for this request.
Required : Yes
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.
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.
Path : projects/{project}/aggregated/vpnGateways
▼ ▲ compute.vpnGateways.getStatus
HTTP Method : GET
Flat Path : projects/{project}/regions/{region}/vpnGateways/{vpnGateway}/getStatus
Apiversion : 2026-12-01-preview
Scopes :
Parameter Order :
Path : projects/{project}/regions/{region}/vpnGateways/{vpnGateway}/getStatus
Parameters :
vpnGateway
Required : Yes
Description : Name of the VPN gateway to return.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
region
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Name of the region for this request.
Type : string
Location : path
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.
Type : string
Required : Yes
Description : Returns the status for the specified VPN gateway.
▼ ▲ compute.vpnGateways.testIamPermissions
Flat Path : projects/{project}/regions/{region}/vpnGateways/{resource}/testIamPermissions
Scopes :
Apiversion : 2026-12-01-preview
Path : projects/{project}/regions/{region}/vpnGateways/{resource}/testIamPermissions
Parameters :
project
Required : Yes
Description : Project ID for this request.
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])?))
Location : path
resource
Required : Yes
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name or id of the resource for this request.
Location : path
region
Location : path
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Description : The name of the region for this request.
Description : Returns permissions that a caller has on the specified resource.
HTTP Method : POST
Parameter Order :
▼ ▲ compute.vpnGateways.insert
HTTP Method : POST
Parameter Order :
Scopes :
Description : Creates a VPN gateway in the specified project and region using the data included in the request.
Path : projects/{project}/regions/{region}/vpnGateways
Flat Path : projects/{project}/regions/{region}/vpnGateways
Apiversion : 2026-12-01-preview
Parameters :
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 : Project ID for this request.
Location : path
region
Type : string
Location : path
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Name of the region for 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).
Location : query
Type : string
▼ ▲ compute.vpnGateways.list
HTTP Method : GET
Flat Path : projects/{project}/regions/{region}/vpnGateways
Scopes :
Parameter Order :
Path : projects/{project}/regions/{region}/vpnGateways
Apiversion : 2026-12-01-preview
Description : Retrieves a list of VPN gateways available to the specified project and region.
Parameters :
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.
maxResults
Location : query
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`)
Format : uint32
Minimum : 0
Default : 500
Type : integer
project
Type : string
Location : path
Description : Project ID for this request.
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])?))
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.
orderBy
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.
Location : query
region
Required : Yes
Description : Name of the region for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Location : path
▼ ▲ compute.vpnGateways.setLabels
Apiversion : 2026-12-01-preview
Parameters :
resource
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Description : Name or id of the resource for this request.
Required : Yes
project
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])?))
Location : path
Description : Project ID for 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).
Location : query
Type : string
region
Description : The region for this request.
Location : path
Type : string
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Sets the labels on a VpnGateway. To learn more about labels, read theLabeling Resources documentation.
Flat Path : projects/{project}/regions/{region}/vpnGateways/{resource}/setLabels
Scopes :
Parameter Order :
HTTP Method : POST
Path : projects/{project}/regions/{region}/vpnGateways/{resource}/setLabels
▼ ▲ compute.rollouts.resume
Path : projects/{project}/global/rollouts/{rollout}/resume
Parameter Order :
Scopes :
HTTP Method : POST
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/global/rollouts/{rollout}/resume
Description : Resumes a Rollout.
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])?))
Type : string
Location : path
Description : Required. Project ID for 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).
Location : query
Type : string
etag
Type : string
Description : The etag of the Rollout. If this is provided, the request will only succeed if the etag matches the current etag of the Rollout.
Location : query
rollout
Description : Required. Name of the Rollout resource to resume.
Location : path
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
▼ ▲ compute.rollouts.cancel
Parameter Order :
HTTP Method : PATCH
Path : projects/{project}/global/rollouts/{rollout}
Apiversion : 2026-12-01-preview
Parameters :
project
Location : path
Description : Project ID for this request.
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])?))
rollout
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Description : Name of the Rollout resource to cancel.
Required : Yes
requestId
Type : string
Location : query
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).
rollback
Location : query
Description : Optional. If true, then the ongoing rollout must be rolled back. Else, just cancel the rollout without taking any further actions. Note that products must support at least one of these options, however, it does not need to support both.
Type : boolean
Scopes :
Description : Cancels a Rollout.
Flat Path : projects/{project}/global/rollouts/{rollout}
▼ ▲ compute.rollouts.pause
Parameter Order :
Apiversion : 2026-12-01-preview
Parameters :
etag
Description : The etag of the Rollout. If this is provided, the request will only succeed if the etag matches the current etag of the Rollout.
Type : string
Location : query
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
Required : Yes
Description : Required. 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])?))
Type : string
rollout
Location : path
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Description : Required. Name of the Rollout resource to pause.
Path : projects/{project}/global/rollouts/{rollout}/pause
Description : Pauses a Rollout.
Scopes :
HTTP Method : POST
Flat Path : projects/{project}/global/rollouts/{rollout}/pause
▼ ▲ compute.rollouts.list
Apiversion : 2026-12-01-preview
Parameters :
orderBy
Type : string
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.
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.
maxResults
Default : 500
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`)
Format : uint32
Location : query
filter
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.
Location : query
project
Description : Project ID for this request.
Location : path
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])?))
Required : Yes
Flat Path : projects/{project}/global/rollouts
Parameter Order : project
Path : projects/{project}/global/rollouts
Description : Lists Rollouts in a given project and location.
Scopes :
HTTP Method : GET
▼ ▲ compute.rollouts.advance
Flat Path : projects/{project}/global/rollouts/{rollout}/advance
Scopes :
Description : Advances a Rollout to the next wave, or completes it if no waves remain.
Parameters :
project
Type : string
Location : path
Required : Yes
Description : Required. 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])?))
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
currentWaveNumber
Description : Required. Wave number of the current wave.
Format : int64
Type : string
Location : query
rollout
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Location : path
Description : Required. Name of the Rollout resource to advance.
Apiversion : 2026-12-01-preview
Parameter Order :
Path : projects/{project}/global/rollouts/{rollout}/advance
HTTP Method : POST
▼ ▲ compute.rollouts.get
Path : projects/{project}/global/rollouts/{rollout}
Parameter Order :
HTTP Method : GET
Flat Path : projects/{project}/global/rollouts/{rollout}
Description : Gets details of a single project-scoped Rollout.
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
Description : Project ID for this request.
Location : path
Type : string
rollout
Type : string
Location : path
Required : Yes
Description : Name of the persistent rollout to return.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Scopes :
Apiversion : 2026-12-01-preview
▼ ▲ compute.rollouts.delete
HTTP Method : DELETE
Scopes :
Parameter Order :
Path : projects/{project}/global/rollouts/{rollout}
Description : Deletes a Rollout.
Flat Path : projects/{project}/global/rollouts/{rollout}
Apiversion : 2026-12-01-preview
Parameters :
rollout
Type : string
Required : Yes
Description : Name of the Rollout resource to delete.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
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
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])?))
Location : path
Type : string
Description : Project ID for this request.
▼ ▲ compute.regionDiskTypes.list
Parameters :
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.
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
Format : uint32
Location : query
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`)
Minimum : 0
Type : integer
Default : 500
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.
project
Description : Project ID for this request.
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])?))
Type : string
Location : path
region
Required : Yes
Location : path
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : The name of the region for this request.
Apiversion : 2026-12-01-preview
Description : Retrieves a list of regional disk types available to the specified project.
Parameter Order :
Path : projects/{project}/regions/{region}/diskTypes
Flat Path : projects/{project}/regions/{region}/diskTypes
Scopes :
HTTP Method : GET
▼ ▲ compute.regionDiskTypes.get
HTTP Method : GET
Scopes :
Parameter Order :
Path : projects/{project}/regions/{region}/diskTypes/{diskType}
Apiversion : 2026-12-01-preview
Description : Returns the specified regional disk type.
Parameters :
region
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : The name of the region for this request.
Required : Yes
Location : path
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])?))
Type : string
Location : path
Description : Project ID for this request.
diskType
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Description : Name of the disk type to return.
Location : path
Type : string
Flat Path : projects/{project}/regions/{region}/diskTypes/{diskType}
▼ ▲ compute.regionSnapshotSettings.patch
Apiversion : 2026-12-01-preview
Parameter Order :
Parameters :
updateMask
Format : google-fieldmask
Location : query
Type : string
Description : update_mask indicates fields to be updated as part of this request.
project
Location : path
Type : string
Required : Yes
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])?))
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
region
Location : path
Description : Name of the region for this request.
Type : string
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Flat Path : projects/{project}/regions/{region}/snapshotSettings
Description : Patch region snapshot settings.
Scopes :
Path : projects/{project}/regions/{region}/snapshotSettings
HTTP Method : PATCH
▼ ▲ compute.regionSnapshotSettings.get
HTTP Method : GET
Parameter Order :
Path : projects/{project}/regions/{region}/snapshotSettings
Flat Path : projects/{project}/regions/{region}/snapshotSettings
Scopes :
Description : Get region snapshot settings.
Parameters :
region
Type : string
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Name of the region for this request.
Location : path
project
Required : Yes
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])?))
Location : path
Type : string
Apiversion : 2026-12-01-preview
▼ ▲ compute.instantSnapshots.list
Flat Path : projects/{project}/zones/{zone}/instantSnapshots
Scopes :
Parameters :
filter
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.
Type : string
zone
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Type : string
Description : The name of the zone for this request.
Location : path
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.
maxResults
Type : integer
Location : query
Format : uint32
Minimum : 0
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`)
project
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])?))
Location : path
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.
Path : projects/{project}/zones/{zone}/instantSnapshots
Apiversion : 2026-12-01-preview
Description : Retrieves the list of InstantSnapshot resources contained within the specified zone.
Parameter Order :
HTTP Method : GET
▼ ▲ compute.instantSnapshots.testIamPermissions
HTTP Method : POST
Parameter Order :
Scopes :
Path : projects/{project}/zones/{zone}/instantSnapshots/{resource}/testIamPermissions
Description : Returns permissions that a caller has on the specified resource.
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])?))
Description : Project ID for this request.
Required : Yes
Location : path
Type : string
resource
Location : path
Description : Name or id of the resource for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Required : Yes
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])?
Flat Path : projects/{project}/zones/{zone}/instantSnapshots/{resource}/testIamPermissions
Apiversion : 2026-12-01-preview
▼ ▲ compute.instantSnapshots.setIamPolicy
Scopes :
Flat Path : projects/{project}/zones/{zone}/instantSnapshots/{resource}/setIamPolicy
Path : projects/{project}/zones/{zone}/instantSnapshots/{resource}/setIamPolicy
HTTP Method : POST
Parameters :
zone
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Required : Yes
Description : The name of the zone for this request.
Location : path
resource
Description : Name or id of the resource for this request.
Required : Yes
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
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
Required : Yes
Description : Project ID for this request.
Apiversion : 2026-12-01-preview
Parameter Order :
Description : Sets the access control policy on the specified resource. Replaces any existing policy.
▼ ▲ compute.instantSnapshots.setLabels
Flat Path : projects/{project}/zones/{zone}/instantSnapshots/{resource}/setLabels
HTTP Method : POST
Scopes :
Parameter Order :
Apiversion : 2026-12-01-preview
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
Type : string
Description : Project ID for this request.
Required : Yes
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
resource
Type : string
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Description : Name or id of the resource for this request.
zone
Type : string
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Description : The name of the zone for this request.
Path : projects/{project}/zones/{zone}/instantSnapshots/{resource}/setLabels
Description : Sets the labels on a instantSnapshot in the given zone. To learn more about labels, read the Labeling Resources documentation.
▼ ▲ compute.instantSnapshots.get
Flat Path : projects/{project}/zones/{zone}/instantSnapshots/{instantSnapshot}
HTTP Method : GET
Apiversion : 2026-12-01-preview
Parameters :
project
Description : Project ID for this request.
Type : string
Location : path
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])?))
zone
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Type : string
Description : The name of the zone for this request.
Location : path
instantSnapshot
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Required : Yes
Description : Name of the InstantSnapshot resource to return.
Description : Returns the specified InstantSnapshot resource in the specified zone.
Parameter Order :
Path : projects/{project}/zones/{zone}/instantSnapshots/{instantSnapshot}
Scopes :
▼ ▲ compute.instantSnapshots.delete
Scopes :
Flat Path : projects/{project}/zones/{zone}/instantSnapshots/{instantSnapshot}
Parameters :
requestId
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).
Location : query
instantSnapshot
Location : path
Description : Name of the InstantSnapshot resource to delete.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
zone
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Description : The name of the zone for this request.
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])?))
Location : path
Description : Project ID for this request.
Type : string
Required : Yes
Apiversion : 2026-12-01-preview
Path : projects/{project}/zones/{zone}/instantSnapshots/{instantSnapshot}
HTTP Method : DELETE
Description : Deletes the specified InstantSnapshot resource. Keep in mind that deleting a single instantSnapshot might not necessarily delete all the data on that instantSnapshot. If any data on the instantSnapshot that is marked for deletion is needed for subsequent instantSnapshots, the data will be moved to the next corresponding instantSnapshot. For more information, seeDeleting instantSnapshots.
Parameter Order :
▼ ▲ compute.instantSnapshots.getIamPolicy
Scopes :
HTTP Method : GET
Path : projects/{project}/zones/{zone}/instantSnapshots/{resource}/getIamPolicy
Parameters :
optionsRequestedPolicyVersion
Format : int32
Type : integer
Description : Requested IAM Policy version.
Location : query
resource
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Description : Name or id of the resource for this request.
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])?))
Type : string
Required : Yes
Location : path
Description : Project ID for this request.
zone
Required : Yes
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Description : The name of the zone for this request.
Parameter Order :
Description : Gets the access control policy for a resource. May be empty if no such policy or resource exists.
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/zones/{zone}/instantSnapshots/{resource}/getIamPolicy
▼ ▲ compute.instantSnapshots.insert
Parameter Order :
Scopes :
Parameters :
requestId
Type : string
Location : query
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
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Location : path
Description : Name of the zone for this request.
Type : string
project
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])?))
Location : path
Description : Creates an instant snapshot in the specified zone.
Apiversion : 2026-12-01-preview
Path : projects/{project}/zones/{zone}/instantSnapshots
HTTP Method : POST
Flat Path : projects/{project}/zones/{zone}/instantSnapshots
▼ ▲ compute.instantSnapshots.aggregatedList
HTTP Method : GET
Flat Path : projects/{project}/aggregated/instantSnapshots
Parameter Order : project
Description : Retrieves an aggregated list of instantSnapshots. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.
Path : projects/{project}/aggregated/instantSnapshots
Scopes :
Apiversion : 2026-12-01-preview
Parameters :
project
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])?))
Location : path
Required : Yes
Description : Project ID for this request.
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
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
serviceProjectNumber
Format : int64
Type : string
Description : The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.
Location : query
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
maxResults
Type : integer
Format : uint32
Location : query
Minimum : 0
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`)
includeAllScopes
Description : Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
Location : query
Type : boolean
▼ ▲ compute.regionNetworkEndpointGroups.delete
Description : Deletes the specified network endpoint group. Note that the NEG cannot be deleted if it is configured as a backend of a backend service.
Path : projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}
Flat Path : projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}
Parameter Order :
HTTP Method : DELETE
Parameters :
networkEndpointGroup
Required : Yes
Type : string
Location : path
Description : The name of the network endpoint group to delete. It should comply with RFC1035.
requestId
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).
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])?))
Description : Project ID for this request.
Type : string
Required : Yes
region
Description : The name of the region where the network endpoint group is located. It should comply with RFC1035.
Required : Yes
Type : string
Location : path
Scopes :
Apiversion : 2026-12-01-preview
▼ ▲ compute.regionNetworkEndpointGroups.listNetworkEndpoints
Scopes :
HTTP Method : POST
Flat Path : projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}/listNetworkEndpoints
Description : Lists the network endpoints in the specified network endpoint group.
Parameter Order :
Path : projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}/listNetworkEndpoints
Apiversion : 2026-12-01-preview
Parameters :
networkEndpointGroup
Location : path
Type : string
Description : The name of the network endpoint group from which you want to generate a list of included network endpoints. It should comply with RFC1035.
Required : Yes
filter
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.
Type : string
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.
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`)
Type : integer
Minimum : 0
Default : 500
Format : uint32
Location : query
orderBy
Type : string
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.
project
Required : Yes
Description : Project ID for this request.
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])?))
region
Location : path
Description : The name of theregion where the network endpoint group is located. It should comply with RFC1035.
Type : string
Required : Yes
▼ ▲ compute.regionNetworkEndpointGroups.list
Parameters :
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.
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
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
Required : Yes
Description : Project ID for this request.
Location : path
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])?))
maxResults
Format : uint32
Type : integer
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`)
Default : 500
region
Description : The name of theregion where the network endpoint group is located. It should comply with RFC1035.
Location : path
Type : string
Required : Yes
Description : Retrieves the list of regional network endpoint groups available to the specified project in the given region.
Apiversion : 2026-12-01-preview
Parameter Order :
Flat Path : projects/{project}/regions/{region}/networkEndpointGroups
Path : projects/{project}/regions/{region}/networkEndpointGroups
Scopes :
HTTP Method : GET
▼ ▲ compute.regionNetworkEndpointGroups.get
Flat Path : projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}
Description : Returns the specified network endpoint group.
Path : projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}
HTTP Method : GET
Parameter Order :
Apiversion : 2026-12-01-preview
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])?))
Type : string
Location : path
Description : Project ID for this request.
region
Description : The name of the region where the network endpoint group is located. It should comply with RFC1035.
Type : string
Required : Yes
Location : path
networkEndpointGroup
Location : path
Type : string
Required : Yes
Description : The name of the network endpoint group. It should comply with RFC1035.
Scopes :
▼ ▲ compute.regionNetworkEndpointGroups.detachNetworkEndpoints
Scopes :
HTTP Method : POST
Parameter Order :
Apiversion : 2026-12-01-preview
Description : Detach the network endpoint from the specified network endpoint group.
Parameters :
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])?))
Description : Project ID for this request.
Type : string
Required : Yes
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). end_interface: MixerMutationRequestBuilder
networkEndpointGroup
Location : path
Type : string
Description : The name of the network endpoint group you are detaching network endpoints from. It should comply with RFC1035.
Required : Yes
region
Location : path
Description : The name of the region where the network endpoint group is located. It should comply with RFC1035.
Type : string
Required : Yes
Flat Path : projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints
Path : projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints
▼ ▲ compute.regionNetworkEndpointGroups.insert
Flat Path : projects/{project}/regions/{region}/networkEndpointGroups
Apiversion : 2026-12-01-preview
Parameter Order :
Parameters :
project
Type : string
Description : Project ID for this request.
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])?))
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).
region
Required : Yes
Type : string
Description : The name of the region where you want to create the network endpoint group. It should comply with RFC1035.
Location : path
Scopes :
HTTP Method : POST
Description : Creates a network endpoint group in the specified project using the parameters that are included in the request. Note: Use the following APIs to manage network endpoint groups: - To manage NEGs with zonal scope (such as zonal NEGs, hybrid connectivity NEGs): zonal API - To manage NEGs with regional scope (such as regional internet NEGs, serverless NEGs, Private Service Connect NEGs): regional API - To manage NEGs with global scope (such as global internet NEGs):global API
Path : projects/{project}/regions/{region}/networkEndpointGroups
▼ ▲ compute.regionNetworkEndpointGroups.attachNetworkEndpoints
Parameters :
networkEndpointGroup
Description : The name of the network endpoint group where you are attaching network endpoints to. It should comply with RFC1035.
Type : string
Location : path
Required : Yes
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
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
region
Type : string
Description : The name of the region where you want to create the network endpoint group. It should comply with RFC1035.
Required : Yes
Location : path
Parameter Order :
Path : projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints
Description : Attach a list of network endpoints to the specified network endpoint group.
Scopes :
HTTP Method : POST
▼ ▲ compute.regionSecurityPolicies.removeRule
Path : projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/removeRule
Flat Path : projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/removeRule
HTTP Method : POST
Parameter Order :
Description : Deletes a rule at the specified priority.
Scopes :
Parameters :
priority
Description : The priority of the rule to remove from the security policy.
Location : query
Format : int32
Type : integer
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.
Type : string
Location : path
Required : Yes
securityPolicy
Location : path
Description : Name of the security policy to update.
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
region
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Name of the region scoping this request.
Required : Yes
Type : string
Apiversion : 2026-12-01-preview
▼ ▲ compute.regionSecurityPolicies.setLabels
Description : Sets the labels on a security policy. To learn more about labels, read the Labeling Resources documentation.
Path : projects/{project}/regions/{region}/securityPolicies/{resource}/setLabels
Apiversion : 2026-12-01-preview
Parameters :
requestId
Type : string
Location : query
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).
resource
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name or id of the resource for this request.
Location : path
Type : string
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.
Type : string
Location : path
region
Description : The region for this request.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Type : string
HTTP Method : POST
Parameter Order :
Scopes :
Flat Path : projects/{project}/regions/{region}/securityPolicies/{resource}/setLabels
▼ ▲ compute.regionSecurityPolicies.getRule
HTTP Method : GET
Description : Gets a rule at the specified priority.
Scopes :
Parameter Order :
Flat Path : projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/getRule
Parameters :
priority
Location : query
Type : integer
Format : int32
Description : The priority of the rule to get from the security policy.
securityPolicy
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Location : path
Description : Name of the security policy to which the queried rule belongs.
Type : string
region
Location : path
Description : Name of the region scoping this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Required : Yes
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
Apiversion : 2026-12-01-preview
Path : projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/getRule
▼ ▲ compute.regionSecurityPolicies.delete
Parameter Order :
HTTP Method : DELETE
Apiversion : 2026-12-01-preview
Path : projects/{project}/regions/{region}/securityPolicies/{securityPolicy}
Flat Path : projects/{project}/regions/{region}/securityPolicies/{securityPolicy}
Parameters :
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).
region
Type : string
Description : Name of the region scoping this request.
Location : path
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
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
Type : string
Required : Yes
Description : Project ID for this request.
securityPolicy
Required : Yes
Type : string
Description : Name of the security policy to delete.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Scopes :
Description : Deletes the specified policy.
▼ ▲ compute.regionSecurityPolicies.insert
Path : projects/{project}/regions/{region}/securityPolicies
Scopes :
Description : Creates a new policy in the specified project using the data included in the request.
HTTP Method : POST
Parameters :
validateOnly
Location : query
Type : boolean
Description : If true, the request will not be committed.
region
Location : path
Description : Name of the region scoping this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Required : Yes
project
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])?))
Required : Yes
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).
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/regions/{region}/securityPolicies
Parameter Order :
▼ ▲ compute.regionSecurityPolicies.list
HTTP Method : GET
Scopes :
Parameter Order :
Description : List all the policies that have been configured for the specified project and region.
Flat Path : projects/{project}/regions/{region}/securityPolicies
Path : projects/{project}/regions/{region}/securityPolicies
Apiversion : 2026-12-01-preview
Parameters :
maxResults
Type : integer
Default : 500
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`)
Format : uint32
Location : query
filter
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.
Type : string
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.
project
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])?))
Location : path
Required : Yes
Description : Project ID for this request.
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.
region
Type : string
Required : Yes
Description : Name of the region scoping this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
▼ ▲ compute.regionSecurityPolicies.patchRule
Description : Patches a rule at the specified priority. To clear fields in the rule, leave the fields empty and specify them in the updateMask.
HTTP Method : POST
Path : projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/patchRule
Parameter Order :
Flat Path : projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/patchRule
Scopes :
Apiversion : 2026-12-01-preview
Parameters :
updateMask
Format : google-fieldmask
Location : query
Description : Indicates fields to be cleared as part of this request.
Type : string
project
Description : Project ID for this request.
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])?))
Type : string
Location : path
securityPolicy
Description : Name of the security policy to update.
Type : string
Location : path
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
region
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Location : path
Description : Name of the region scoping this request.
validateOnly
Description : If true, the request will not be committed.
Location : query
Type : boolean
priority
Description : The priority of the rule to patch.
Type : integer
Location : query
Format : int32
▼ ▲ compute.regionSecurityPolicies.get
HTTP Method : GET
Description : List all of the ordered rules present in a single specified policy.
Flat Path : projects/{project}/regions/{region}/securityPolicies/{securityPolicy}
Parameters :
securityPolicy
Location : path
Required : Yes
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the security policy to get.
region
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Name of the region scoping this request.
Required : Yes
Type : string
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])?))
Description : Project ID for this request.
Required : Yes
Type : string
Parameter Order :
Path : projects/{project}/regions/{region}/securityPolicies/{securityPolicy}
Apiversion : 2026-12-01-preview
Scopes :
▼ ▲ compute.regionSecurityPolicies.patch
HTTP Method : PATCH
Path : projects/{project}/regions/{region}/securityPolicies/{securityPolicy}
Description : Patches the specified policy with the data included in the request. To clear fields in the policy, leave the fields empty and specify them in the updateMask. This cannot be used to be update the rules in the policy. Please use the per rule methods like addRule, patchRule, and removeRule instead.
Scopes :
Apiversion : 2026-12-01-preview
Parameter Order :
Parameters :
region
Type : string
Description : Name of the region scoping this request.
Location : path
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
requestId
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).
Location : query
updateMask
Location : query
Format : google-fieldmask
Type : string
Description : Indicates fields to be cleared as part of this request.
securityPolicy
Description : Name of the security policy to update.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Location : path
Type : string
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])?))
Location : path
Description : Project ID for this request.
Flat Path : projects/{project}/regions/{region}/securityPolicies/{securityPolicy}
▼ ▲ compute.regionSecurityPolicies.addRule
Scopes :
Flat Path : projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/addRule
HTTP Method : POST
Apiversion : 2026-12-01-preview
Parameter Order :
Path : projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/addRule
Parameters :
region
Description : Name of the region scoping this request.
Location : path
Required : Yes
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
validateOnly
Location : query
Description : If true, the request will not be committed.
Type : boolean
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])?))
Type : string
Description : Project ID for this request.
Location : path
securityPolicy
Description : Name of the security policy to update.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Type : string
Required : Yes
Description : Inserts a rule into a security policy.
▼ ▲ compute.networkAttachments.patch
HTTP Method : PATCH
Parameter Order :
Scopes :
Description : Patches the specified NetworkAttachment resource with the data included in the request. This method supports PATCH semantics and usesJSON merge patch format and processing rules.
Flat Path : projects/{project}/regions/{region}/networkAttachments/{networkAttachment}
Apiversion : 2026-12-01-preview
Path : projects/{project}/regions/{region}/networkAttachments/{networkAttachment}
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.
networkAttachment
Description : Name of the NetworkAttachment resource to patch.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Required : Yes
region
Description : Name of the region for this request.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Type : string
requestId
Type : string
Location : query
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). end_interface: MixerMutationRequestBuilder
▼ ▲ compute.networkAttachments.delete
HTTP Method : DELETE
Path : projects/{project}/regions/{region}/networkAttachments/{networkAttachment}
Description : Deletes the specified NetworkAttachment in the given scope
Flat Path : projects/{project}/regions/{region}/networkAttachments/{networkAttachment}
Scopes :
Apiversion : 2026-12-01-preview
Parameters :
region
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Description : Name of the region of this request.
networkAttachment
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Description : Name of the NetworkAttachment resource to delete.
Required : Yes
Location : path
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). end_interface: MixerMutationRequestBuilder
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.
Type : string
Required : Yes
Location : path
Parameter Order :
▼ ▲ compute.networkAttachments.getIamPolicy
HTTP Method : GET
Scopes :
Parameter Order :
Flat Path : projects/{project}/regions/{region}/networkAttachments/{resource}/getIamPolicy
Description : Gets the access control policy for a resource. May be empty if no such policy or resource exists.
Apiversion : 2026-12-01-preview
Path : projects/{project}/regions/{region}/networkAttachments/{resource}/getIamPolicy
Parameters :
resource
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Description : Name or id of the resource for this request.
Type : string
Required : Yes
project
Type : string
Description : Project ID for this request.
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])?))
Location : path
optionsRequestedPolicyVersion
Description : Requested IAM Policy version.
Location : query
Format : int32
Type : integer
region
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Description : The name of the region for this request.
Required : Yes
▼ ▲ compute.networkAttachments.insert
Description : Creates a NetworkAttachment in the specified project in the given scope using the parameters that are included in the request.
HTTP Method : POST
Flat Path : projects/{project}/regions/{region}/networkAttachments
Path : projects/{project}/regions/{region}/networkAttachments
Scopes :
Parameters :
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). end_interface: MixerMutationRequestBuilder
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.
Required : Yes
Location : path
Type : string
region
Required : Yes
Description : Name of the region of this request.
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Parameter Order :
Apiversion : 2026-12-01-preview
▼ ▲ compute.networkAttachments.list
Flat Path : projects/{project}/regions/{region}/networkAttachments
Apiversion : 2026-12-01-preview
Path : projects/{project}/regions/{region}/networkAttachments
Description : Lists the NetworkAttachments for a project in the given scope.
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`)
Type : integer
Format : uint32
Default : 500
Minimum : 0
Location : query
project
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])?))
Required : Yes
Location : path
Description : Project ID for this request.
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Description : Name of the region of this request.
Required : Yes
Location : path
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
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
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
HTTP Method : GET
Scopes :
Parameter Order :
▼ ▲ compute.networkAttachments.setIamPolicy
Parameter Order :
Flat Path : projects/{project}/regions/{region}/networkAttachments/{resource}/setIamPolicy
Parameters :
resource
Required : Yes
Description : Name or id of the resource for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
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])?))
Description : Project ID for this request.
Required : Yes
Type : string
Location : path
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : The name of the region for this request.
Location : path
Type : string
Required : Yes
Apiversion : 2026-12-01-preview
Description : Sets the access control policy on the specified resource. Replaces any existing policy.
HTTP Method : POST
Scopes :
Path : projects/{project}/regions/{region}/networkAttachments/{resource}/setIamPolicy
▼ ▲ compute.networkAttachments.get
Description : Returns the specified NetworkAttachment resource in the given scope.
HTTP Method : GET
Flat Path : projects/{project}/regions/{region}/networkAttachments/{networkAttachment}
Scopes :
Parameters :
project
Type : string
Description : Project ID for this request.
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])?))
Location : path
networkAttachment
Type : string
Description : Name of the NetworkAttachment resource to return.
Required : Yes
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
region
Description : Name of the region of this request.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Location : path
Parameter Order :
Path : projects/{project}/regions/{region}/networkAttachments/{networkAttachment}
Apiversion : 2026-12-01-preview
▼ ▲ compute.networkAttachments.testIamPermissions
Scopes :
Path : projects/{project}/regions/{region}/networkAttachments/{resource}/testIamPermissions
Parameter Order :
Parameters :
project
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])?))
Location : path
resource
Type : string
Location : path
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name or id of the resource for this request.
region
Required : Yes
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : The name of the region for this request.
Apiversion : 2026-12-01-preview
HTTP Method : POST
Flat Path : projects/{project}/regions/{region}/networkAttachments/{resource}/testIamPermissions
Description : Returns permissions that a caller has on the specified resource.
▼ ▲ compute.networkAttachments.aggregatedList
Parameter Order : project
Apiversion : 2026-12-01-preview
Parameters :
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
Required : Yes
Description : Project ID for this request.
maxResults
Type : integer
Location : query
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
Minimum : 0
Format : uint32
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
filter
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.
Type : string
includeAllScopes
Location : query
Description : Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
Type : boolean
serviceProjectNumber
Description : The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.
Type : string
Format : int64
Location : query
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.
HTTP Method : GET
Flat Path : projects/{project}/aggregated/networkAttachments
Scopes :
Description : Retrieves the list of all NetworkAttachment resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.
Path : projects/{project}/aggregated/networkAttachments
▼ ▲ compute.disks.aggregatedList
Path : projects/{project}/aggregated/disks
HTTP Method : GET
Flat Path : projects/{project}/aggregated/disks
Description : Retrieves an aggregated list of persistent disks. To prevent failure, it is recommended that you set the `returnPartialSuccess` parameter to `true`.
Apiversion : 2026-12-01-preview
Parameters :
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
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.
project
Description : Project ID for this request.
Location : path
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])?))
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
maxResults
Minimum : 0
Default : 500
Format : uint32
Type : integer
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`)
Location : query
serviceProjectNumber
Format : int64
Description : The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.
Location : query
Type : string
includeAllScopes
Description : Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
Type : boolean
Location : query
Scopes :
Parameter Order : project
▼ ▲ compute.disks.stopAsyncReplication
Description : Stops asynchronous replication. Can be invoked either on the primary or on the secondary disk.
Apiversion : 2026-12-01-preview
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
project
Description : Project ID for this request.
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
zone
Description : The name of the zone for this request.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Location : path
disk
Location : path
Type : string
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : The name of the persistent disk.
Parameter Order :
Flat Path : projects/{project}/zones/{zone}/disks/{disk}/stopAsyncReplication
HTTP Method : POST
Scopes :
Path : projects/{project}/zones/{zone}/disks/{disk}/stopAsyncReplication
▼ ▲ compute.disks.insert
Scopes :
Description : Creates a persistent disk in the specified project using the data in the request. You can create a disk from a source (sourceImage, sourceSnapshot, orsourceDisk) or create an empty 500 GB data disk by omitting all properties. You can also create a disk that is larger than the default size by specifying the sizeGb property.
Parameters :
sourceImage
Type : string
Location : query
Description : Source image to restore onto a disk. This field is optional.
project
Required : Yes
Description : Project ID for this request.
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])?))
zone
Type : string
Location : path
Description : The name of the zone for this request.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
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).
Path : projects/{project}/zones/{zone}/disks
Flat Path : projects/{project}/zones/{zone}/disks
Apiversion : 2026-12-01-preview
HTTP Method : POST
Parameter Order :
▼ ▲ compute.disks.setIamPolicy
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/zones/{zone}/disks/{resource}/setIamPolicy
Parameters :
zone
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Description : The name of the zone for this request.
Location : path
Type : string
resource
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Description : Name or id of the resource for this request.
Type : string
Required : Yes
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
Type : string
Required : Yes
Scopes :
Description : Sets the access control policy on the specified resource. Replaces any existing policy.
HTTP Method : POST
Parameter Order :
Path : projects/{project}/zones/{zone}/disks/{resource}/setIamPolicy
▼ ▲ compute.disks.delete
Scopes :
HTTP Method : DELETE
Path : projects/{project}/zones/{zone}/disks/{disk}
Description : Deletes the specified persistent disk. Deleting a disk removes its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separatelydelete snapshots.
Parameters :
requestId
Location : query
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
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])?
project
Location : path
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])?))
Description : Project ID for this request.
Required : Yes
disk
Required : Yes
Pattern : \S{1,66}
Description : Name of the persistent disk to delete.
Type : string
Location : path
Parameter Order :
Flat Path : projects/{project}/zones/{zone}/disks/{disk}
Apiversion : 2026-12-01-preview
▼ ▲ compute.disks.get
Flat Path : projects/{project}/zones/{zone}/disks/{disk}
Description : Returns the specified persistent disk.
Scopes :
Parameters :
disk
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the persistent disk to return.
Type : string
Required : Yes
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])?))
Type : string
Location : path
Description : Project ID for this request.
zone
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Type : string
Location : path
Description : The name of the zone for this request.
Parameter Order :
Apiversion : 2026-12-01-preview
Path : projects/{project}/zones/{zone}/disks/{disk}
HTTP Method : GET
▼ ▲ compute.disks.resize
HTTP Method : POST
Path : projects/{project}/zones/{zone}/disks/{disk}/resize
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])?))
Location : path
Type : string
Description : Project ID for this request.
requestId
Location : query
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
disk
Required : Yes
Type : string
Description : The name of the persistent disk.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
zone
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : The name of the zone for this request.
Required : Yes
Location : path
Type : string
Description : Resizes the specified persistent disk. You can only increase the size of the disk.
Apiversion : 2026-12-01-preview
Scopes :
Parameter Order :
Flat Path : projects/{project}/zones/{zone}/disks/{disk}/resize
▼ ▲ compute.disks.getIamPolicy
Parameters :
optionsRequestedPolicyVersion
Location : query
Description : Requested IAM Policy version.
Type : integer
Format : int32
zone
Required : Yes
Description : The name of the zone for this request.
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
resource
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Location : path
Type : string
Description : Name or id of the resource for this request.
project
Description : Project ID for this request.
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])?))
Location : path
Description : Gets the access control policy for a resource. May be empty if no such policy or resource exists.
Apiversion : 2026-12-01-preview
Scopes :
Parameter Order :
Flat Path : projects/{project}/zones/{zone}/disks/{resource}/getIamPolicy
HTTP Method : GET
Path : projects/{project}/zones/{zone}/disks/{resource}/getIamPolicy
▼ ▲ compute.disks.testIamPermissions
Flat Path : projects/{project}/zones/{zone}/disks/{resource}/testIamPermissions
HTTP Method : POST
Description : Returns permissions that a caller has on the specified resource.
Scopes :
Parameter Order :
Parameters :
resource
Type : string
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 resource for this request.
Required : Yes
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.
Type : string
Required : Yes
Location : path
zone
Required : Yes
Description : The name of the zone for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Type : string
Path : projects/{project}/zones/{zone}/disks/{resource}/testIamPermissions
Apiversion : 2026-12-01-preview
▼ ▲ compute.disks.list
Parameters :
maxResults
Type : integer
Default : 500
Format : uint32
Minimum : 0
Location : query
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
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.
Location : query
project
Description : Project ID for this request.
Location : path
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])?))
Type : string
zone
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Required : Yes
Description : The name of the zone for this request.
Location : path
pageToken
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.
Type : string
filter
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.
Type : string
Description : Retrieves a list of persistent disks contained within the specified zone.
Apiversion : 2026-12-01-preview
Scopes :
Parameter Order :
Path : projects/{project}/zones/{zone}/disks
Flat Path : projects/{project}/zones/{zone}/disks
HTTP Method : GET
▼ ▲ compute.disks.startAsyncReplication
Parameter Order :
Flat Path : projects/{project}/zones/{zone}/disks/{disk}/startAsyncReplication
HTTP Method : POST
Path : projects/{project}/zones/{zone}/disks/{disk}/startAsyncReplication
Description : Starts asynchronous replication. Must be invoked on the primary disk.
Parameters :
disk
Type : string
Description : The name of the persistent disk.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
requestId
Type : string
Location : query
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).
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.
Required : Yes
Location : path
Type : string
zone
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Type : string
Description : The name of the zone for this request.
Location : path
Apiversion : 2026-12-01-preview
Scopes :
▼ ▲ compute.disks.updateKmsKey
Description : Rotates the customer-managed encryption key to the latest version for the specified persistent disk.
Path : projects/{project}/zones/{zone}/disks/{disk}/updateKmsKey
Flat Path : projects/{project}/zones/{zone}/disks/{disk}/updateKmsKey
Apiversion : 2026-12-01-preview
Parameters :
disk
Type : string
Location : path
Required : Yes
Description : Name of the Disk resource, should conform to RFC1035.
requestId
Type : string
Location : query
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).
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
Type : string
Required : Yes
zone
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : The name of the zone for this request.
Type : string
Required : Yes
Scopes :
HTTP Method : POST
Parameter Order :
▼ ▲ compute.disks.createSnapshot
Scopes :
Path : projects/{project}/zones/{zone}/disks/{disk}/createSnapshot
Flat Path : projects/{project}/zones/{zone}/disks/{disk}/createSnapshot
HTTP Method : POST
Parameter Order :
Description : Creates a snapshot of a specified persistent disk. For regular snapshot creation, consider using snapshots.insert instead, as that method supports more features, such as creating snapshots in a project different from the source disk project.
Parameters :
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).
disk
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Type : string
Description : Name of the persistent disk to snapshot.
Location : path
zone
Required : Yes
Description : The name of the zone for this request.
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
guestFlush
Description : [Input Only] Whether to attempt an application consistent snapshot by informing the OS to prepare for the snapshot process.
Type : boolean
Location : query
project
Description : 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])?))
Apiversion : 2026-12-01-preview
▼ ▲ compute.disks.removeResourcePolicies
Flat Path : projects/{project}/zones/{zone}/disks/{disk}/removeResourcePolicies
Apiversion : 2026-12-01-preview
Description : Removes resource policies from a disk.
Parameters :
disk
Location : path
Description : The disk name for this request.
Type : string
Required : Yes
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
Description : Project ID for this request.
Type : string
Required : Yes
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
zone
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Description : The name of the zone for this request.
Type : string
HTTP Method : POST
Parameter Order :
Scopes :
Path : projects/{project}/zones/{zone}/disks/{disk}/removeResourcePolicies
▼ ▲ compute.disks.update
HTTP Method : PATCH
Parameters :
project
Description : Project ID for this request.
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])?))
Type : string
Location : path
updateMask
Format : google-fieldmask
Location : query
Description : update_mask indicates fields to be updated as part of this request.
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).
Type : string
Location : query
paths
Type : string
Location : query
Repeated : Yes
disk
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : The disk name for this request.
Required : Yes
zone
Location : path
Description : The name of the zone for this request.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Path : projects/{project}/zones/{zone}/disks/{disk}
Flat Path : projects/{project}/zones/{zone}/disks/{disk}
Apiversion : 2026-12-01-preview
Parameter Order :
Scopes :
Description : Updates the specified disk with the data included in the request. The update is performed only on selected fields included as part of update-mask.
▼ ▲ compute.disks.bulkSetLabels
Apiversion : 2026-12-01-preview
Parameters :
zone
Description : The name of the zone for this request.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Type : string
requestId
Location : query
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
resource
Description : Name or id of the resource for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Location : query
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.
Type : string
Location : path
Parameter Order :
Flat Path : projects/{project}/zones/{zone}/disks/bulkSetLabels
Path : projects/{project}/zones/{zone}/disks/bulkSetLabels
Description : Sets the labels on many disks at once. To learn more about labels, read theLabeling Resources documentation.
HTTP Method : POST
Scopes :
▼ ▲ compute.disks.setLabels
Parameter Order :
Parameters :
project
Required : Yes
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])?))
Type : string
Location : path
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
zone
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Description : The name of the zone for this request.
Required : Yes
Location : path
resource
Description : Name or id of the resource for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Location : path
Type : string
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/zones/{zone}/disks/{resource}/setLabels
HTTP Method : POST
Scopes :
Description : Sets the labels on a disk. To learn more about labels, read theLabeling Resources documentation.
Path : projects/{project}/zones/{zone}/disks/{resource}/setLabels
▼ ▲ compute.disks.addResourcePolicies
Description : Adds existing resource policies to a disk. You can only add one policy which will be applied to this disk for scheduling snapshot creation.
HTTP Method : POST
Path : projects/{project}/zones/{zone}/disks/{disk}/addResourcePolicies
Scopes :
Parameter Order :
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/zones/{zone}/disks/{disk}/addResourcePolicies
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
disk
Required : Yes
Description : The disk name for this request.
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
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])?))
Type : string
Location : path
Required : Yes
Description : Project ID for this request.
zone
Required : Yes
Description : The name of the zone for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Type : string
▼ ▲ compute.disks.bulkInsert
Scopes :
HTTP Method : POST
Flat Path : projects/{project}/zones/{zone}/disks/bulkInsert
Description : Bulk create a set of disks.
Path : projects/{project}/zones/{zone}/disks/bulkInsert
Parameter Order :
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
zone
Required : Yes
Description : The name of the zone for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Type : string
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])?))
Location : path
Type : string
Description : Project ID for this request.
Apiversion : 2026-12-01-preview
▼ ▲ compute.disks.stopGroupAsyncReplication
Parameter Order :
Description : Stops asynchronous replication for a consistency group of disks. Can be invoked either in the primary or secondary scope.
Path : projects/{project}/zones/{zone}/disks/stopGroupAsyncReplication
Scopes :
HTTP Method : POST
Parameters :
requestId
Location : query
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
zone
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : The name of the zone for this request. This must be the zone of the primary or secondary disks in the consistency group.
Required : Yes
Type : string
project
Description : Project ID for this request.
Location : path
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])?))
Type : string
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/zones/{zone}/disks/stopGroupAsyncReplication
▼ ▲ compute.projects.setUsageExportBucket
Flat Path : projects/{project}/setUsageExportBucket
Parameter Order : project
HTTP Method : POST
Description : Enables the usage export feature and sets theusage export bucket where reports are stored. If you provide an empty request body using this method, the usage export feature will be disabled.
Path : projects/{project}/setUsageExportBucket
Scopes :
Parameters :
requestId
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).
Location : query
project
Description : Project ID for this request.
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])?))
Location : path
Apiversion : 2026-12-01-preview
▼ ▲ compute.projects.getXpnHost
Parameter Order : project
Scopes :
Flat Path : projects/{project}/getXpnHost
Description : Gets the shared VPC host project that this project links to. May be empty if no link exists.
HTTP Method : GET
Path : projects/{project}/getXpnHost
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])?))
Description : Project ID for this request.
Required : Yes
Type : string
Location : path
Apiversion : 2026-12-01-preview
▼ ▲ compute.projects.enableXpnHost
Parameters :
requestId
Type : string
Location : query
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).
project
Description : Project ID for this request.
Location : path
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])?))
Required : Yes
Apiversion : 2026-12-01-preview
Path : projects/{project}/enableXpnHost
Description : Enable this project as a shared VPC host project.
Parameter Order : project
Flat Path : projects/{project}/enableXpnHost
HTTP Method : POST
Scopes :
▼ ▲ compute.projects.listXpnHosts
Apiversion : 2026-12-01-preview
Description : Lists all shared VPC host projects visible to the user in an organization.
Parameters :
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.
filter
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.
Location : query
orderBy
Type : string
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.
maxResults
Format : uint32
Type : integer
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`)
Minimum : 0
project
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])?))
Location : path
Description : Project ID for this request.
Required : Yes
Flat Path : projects/{project}/listXpnHosts
Scopes :
Path : projects/{project}/listXpnHosts
HTTP Method : POST
Parameter Order : project
▼ ▲ compute.projects.moveDisk
Flat Path : projects/{project}/moveDisk
Deprecated : Yes
Scopes :
HTTP Method : POST
Parameter Order : project
Description : Moves a persistent disk from one zone to another. *Note*: The moveDisk API will be deprecated on September 29, 2026. Starting September 29, 2025, you can't use the moveDisk API on new projects. To move a disk to a different region or zone, follow the steps in [Change the location of a disk](https://cloud.google.com/compute/docs/disks/migrate-to-hyperdisk#migrate-to-hd). Projects that already use the moveDisk API can continue usage until September 29, 2026. Starting November 1, 2025, API responses will include a warning message in the response body about the upcoming deprecation. You can skip the message to continue using the service without interruption.
Path : projects/{project}/moveDisk
Apiversion : 2026-12-01-preview
Parameters :
project
Location : path
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])?))
Type : string
Required : Yes
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
▼ ▲ compute.projects.setCommonInstanceMetadata
Description : Sets metadata common to all instances within the specified project using the data included in the request.
Scopes :
Parameters :
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])?))
Required : Yes
Description : Project ID for this request.
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).
Apiversion : 2026-12-01-preview
Parameter Order : project
Flat Path : projects/{project}/setCommonInstanceMetadata
Path : projects/{project}/setCommonInstanceMetadata
HTTP Method : POST
▼ ▲ compute.projects.enableXpnResource
Description : Enable service resource (a.k.a service project) for a host project, so that subnets in the host project can be used by instances in the service project.
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])?))
Type : string
Location : path
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).
Apiversion : 2026-12-01-preview
Scopes :
HTTP Method : POST
Parameter Order : project
Flat Path : projects/{project}/enableXpnResource
Path : projects/{project}/enableXpnResource
▼ ▲ compute.projects.getXpnResources
HTTP Method : GET
Parameter Order : project
Description : Gets service resources (a.k.a service project) associated with this host project.
Path : projects/{project}/getXpnResources
Flat Path : projects/{project}/getXpnResources
Scopes :
Apiversion : 2026-12-01-preview
Parameters :
project
Description : Project ID for this request.
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])?))
Location : path
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
pageToken
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.
Type : string
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`)
Type : integer
Format : uint32
Default : 500
Minimum : 0
Location : query
filter
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.
Location : query
▼ ▲ compute.projects.disableXpnResource
Path : projects/{project}/disableXpnResource
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.
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
Scopes :
Apiversion : 2026-12-01-preview
Description : Disable a service resource (also known as service project) associated with this host project.
Flat Path : projects/{project}/disableXpnResource
HTTP Method : POST
▼ ▲ compute.projects.setDefaultNetworkTier
Path : projects/{project}/setDefaultNetworkTier
Scopes :
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).
Location : query
Type : string
project
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])?))
Description : Project ID for this request.
Required : Yes
Location : path
Apiversion : 2026-12-01-preview
Description : Sets the default network tier of the project. The default network tier is used when an address/forwardingRule/instance is created without specifying the network tier field.
Parameter Order : project
HTTP Method : POST
Flat Path : projects/{project}/setDefaultNetworkTier
▼ ▲ compute.projects.setCloudArmorTier
Flat Path : projects/{project}/setCloudArmorTier
HTTP Method : POST
Parameters :
project
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])?))
Description : Project ID for this request.
Required : Yes
requestId
Type : string
Location : query
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).
Apiversion : 2026-12-01-preview
Description : Sets the Cloud Armor tier of the project. To set ENTERPRISE or above the billing account of the project must be subscribed to Cloud Armor Enterprise. See Subscribing to Cloud Armor Enterprise for more information.
Path : projects/{project}/setCloudArmorTier
Scopes :
Parameter Order : project
▼ ▲ compute.projects.moveInstance
Description : Moves an instance and its attached persistent disks from one zone to another. *Note*: Moving VMs or disks by using this method might cause unexpected behavior. For more information, see the [known issue](/compute/docs/troubleshooting/known-issues#moving_vms_or_disks_using_the_moveinstance_api_or_the_causes_unexpected_behavior). [Deprecated] This method is deprecated. See [moving instance across zones](/compute/docs/instances/moving-instance-across-zones) instead.
Apiversion : 2026-12-01-preview
Path : projects/{project}/moveInstance
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).
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])?))
Type : string
Required : Yes
Description : Project ID for this request.
Location : path
Flat Path : projects/{project}/moveInstance
HTTP Method : POST
Scopes :
Parameter Order : project
Deprecated : Yes
▼ ▲ compute.projects.get
HTTP Method : GET
Path : projects/{project}
Parameter Order : project
Apiversion : 2026-12-01-preview
Flat Path : projects/{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.
Scopes :
Description : Returns the specified Project resource. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request.
▼ ▲ compute.projects.disableXpnHost
Scopes :
Parameter Order : project
Parameters :
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
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).
Path : projects/{project}/disableXpnHost
Apiversion : 2026-12-01-preview
Description : Disable this project as a shared VPC host project.
HTTP Method : POST
Flat Path : projects/{project}/disableXpnHost
▼ ▲ compute.instanceGroupManagerResizeRequests.cancel
Parameters :
zone
Type : string
Location : path
Description : The name of thezone where the managed instance group is located. The name should conform to RFC1035.
Required : Yes
instanceGroupManager
Location : path
Type : string
Required : Yes
Description : The name of the managed instance group. The name should conform to RFC1035 or be a resource ID.
resizeRequest
Location : path
Type : string
Description : The name of the resize request to cancel. The name should conform to RFC1035 or be a resource ID.
Required : Yes
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
Description : Project ID for this request.
Location : path
Type : string
requestId
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).
Location : query
Parameter Order :
Apiversion : 2026-12-01-preview
Scopes :
Flat Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}/cancel
Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}/cancel
HTTP Method : POST
Description : Cancels the specified resize request and removes it from the queue. Cancelled resize request does no longer wait for the resources to be provisioned. Cancel is only possible for requests that are accepted in the queue.
▼ ▲ compute.instanceGroupManagerResizeRequests.get
HTTP Method : GET
Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}
Flat Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}
Scopes :
Description : Returns all of the details about the specified resize request.
Parameters :
resizeRequest
Type : string
Description : The name of the resize request. Name should conform to RFC1035 or be a resource ID.
Required : Yes
Location : path
project
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])?))
Description : Project ID for this request.
Required : Yes
zone
Location : path
Type : string
Description : Name of the href="/compute/docs/regions-zones/#available">zone scoping this request. Name should conform to RFC1035.
Required : Yes
instanceGroupManager
Location : path
Description : The name of the managed instance group. Name should conform to RFC1035 or be a resource ID.
Type : string
Required : Yes
Parameter Order :
Apiversion : 2026-12-01-preview
▼ ▲ compute.instanceGroupManagerResizeRequests.insert
Flat Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests
Apiversion : 2026-12-01-preview
Parameters :
instanceGroupManager
Description : The name of the managed instance group to which the resize request will be added. Name should conform to RFC1035 or be a resource ID.
Required : Yes
Location : path
Type : string
zone
Type : string
Required : Yes
Location : path
Description : The name of thezone where the managed instance group is located and where the resize request will be created. 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).
Type : string
Location : query
project
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])?))
Required : Yes
Description : Project ID for this request.
HTTP Method : POST
Scopes :
Description : Creates a new resize request that starts provisioning VMs immediately or queues VM creation.
Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests
Parameter Order :
▼ ▲ compute.instanceGroupManagerResizeRequests.list
Parameter Order :
HTTP Method : GET
Scopes :
Flat Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests
Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests
Parameters :
instanceGroupManager
Type : string
Description : The name of the managed instance group. The name should conform to RFC1035.
Required : Yes
Location : path
zone
Description : The name of thezone where the managed instance group is located. The name should conform to RFC1035.
Required : Yes
Type : string
Location : path
maxResults
Location : query
Default : 500
Minimum : 0
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`)
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
Required : Yes
Description : Project ID for this request.
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
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
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.
Location : query
Description : Retrieves a list of resize requests that are contained in the managed instance group.
Apiversion : 2026-12-01-preview
▼ ▲ compute.instanceGroupManagerResizeRequests.delete
Path : projects/{project}/zones/{zone}/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.
Parameter Order :
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}
Parameters :
project
Type : string
Location : path
Required : Yes
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
Required : Yes
Type : string
Description : The name of thezone where the managed instance group is located. The name should conform to RFC1035.
Location : path
instanceGroupManager
Required : Yes
Description : The name of the managed instance group. The name should conform to RFC1035 or be a resource ID.
Type : string
Location : path
requestId
Location : query
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
resizeRequest
Required : Yes
Location : path
Type : string
Description : The name of the resize request to delete. The name should conform to RFC1035 or be a resource ID.
Scopes :
HTTP Method : DELETE
▼ ▲ compute.diskTypes.get
Parameter Order :
Path : projects/{project}/zones/{zone}/diskTypes/{diskType}
HTTP Method : GET
Scopes :
Apiversion : 2026-12-01-preview
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])?))
Type : string
Description : Project ID for this request.
Location : path
diskType
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Required : Yes
Description : Name of the disk type to return.
Type : string
zone
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Type : string
Description : The name of the zone for this request.
Required : Yes
Flat Path : projects/{project}/zones/{zone}/diskTypes/{diskType}
Description : Returns the specified disk type.
▼ ▲ compute.diskTypes.aggregatedList
Flat Path : projects/{project}/aggregated/diskTypes
Apiversion : 2026-12-01-preview
Description : Retrieves an aggregated list of disk types. To prevent failure, it is recommended that you set the `returnPartialSuccess` parameter to `true`.
Scopes :
Parameters :
includeAllScopes
Location : query
Description : Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
Type : boolean
project
Location : path
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])?))
Type : string
Required : Yes
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
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
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.
Location : query
Type : string
maxResults
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`)
Minimum : 0
Location : query
Format : uint32
Type : integer
serviceProjectNumber
Format : int64
Type : string
Location : query
Description : The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.
HTTP Method : GET
Path : projects/{project}/aggregated/diskTypes
Parameter Order : project
▼ ▲ compute.diskTypes.list
Description : Retrieves a list of disk types available to the specified project.
Flat Path : projects/{project}/zones/{zone}/diskTypes
Parameter Order :
Scopes :
Parameters :
orderBy
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.
Location : query
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
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
Type : string
Description : Project ID for this request.
Required : Yes
maxResults
Minimum : 0
Default : 500
Format : uint32
Type : integer
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`)
Location : query
zone
Type : string
Required : Yes
Description : The name of the zone for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
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.
Location : query
Type : string
Apiversion : 2026-12-01-preview
HTTP Method : GET
Path : projects/{project}/zones/{zone}/diskTypes
▼ ▲ compute.nodeGroups.setNodeTemplate
Description : Updates the node template of the node group.
Parameters :
project
Description : Project ID for this request.
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])?))
Location : path
zone
Description : The name of the zone for this request.
Required : Yes
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
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).
nodeGroup
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Required : Yes
Description : Name of the NodeGroup resource to update.
Apiversion : 2026-12-01-preview
Path : projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/setNodeTemplate
HTTP Method : POST
Flat Path : projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/setNodeTemplate
Parameter Order :
Scopes :
▼ ▲ compute.nodeGroups.testIamPermissions
Flat Path : projects/{project}/zones/{zone}/nodeGroups/{resource}/testIamPermissions
Scopes :
HTTP Method : POST
Parameter Order :
Description : Returns permissions that a caller has on the specified resource.
Path : projects/{project}/zones/{zone}/nodeGroups/{resource}/testIamPermissions
Apiversion : 2026-12-01-preview
Parameters :
resource
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Required : Yes
Description : Name or id of the resource for this request.
Location : path
zone
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : The name of the zone for this request.
Required : Yes
Type : string
project
Location : path
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])?))
Required : Yes
Type : string
▼ ▲ compute.nodeGroups.aggregatedList
Flat Path : projects/{project}/aggregated/nodeGroups
Apiversion : 2026-12-01-preview
Description : Retrieves an aggregated list of node groups. Note: use nodeGroups.listNodes for more details about each group. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.
Parameters :
includeAllScopes
Description : Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
Type : boolean
Location : query
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
maxResults
Format : uint32
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
Location : query
Type : integer
project
Required : Yes
Description : Project ID for this request.
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])?))
Location : path
serviceProjectNumber
Type : string
Description : The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.
Format : int64
Location : query
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
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
HTTP Method : GET
Parameter Order : project
Scopes :
Path : projects/{project}/aggregated/nodeGroups
▼ ▲ compute.nodeGroups.simulateMaintenanceEvent
Parameters :
nodeGroup
Required : Yes
Type : string
Description : Name of the NodeGroup resource whose nodes will go under maintenance simulation.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
zone
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Description : The name of the zone for this request.
Type : string
project
Location : path
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])?))
Description : Project ID for this request.
Required : Yes
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
Scopes :
Parameter Order :
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/simulateMaintenanceEvent
Path : projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/simulateMaintenanceEvent
Description : Simulates maintenance event on specified nodes from the node group.
HTTP Method : POST
▼ ▲ compute.nodeGroups.insert
Apiversion : 2026-12-01-preview
Path : projects/{project}/zones/{zone}/nodeGroups
Parameters :
requestId
Type : string
Location : query
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.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Location : path
initialNodeCount
Required : Yes
Format : int32
Description : Initial count of nodes in the node group.
Type : integer
Location : query
project
Description : Project ID for this request.
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])?))
Location : path
Scopes :
Flat Path : projects/{project}/zones/{zone}/nodeGroups
Description : Creates a NodeGroup resource in the specified project using the data included in the request.
Parameter Order :
HTTP Method : POST
▼ ▲ compute.nodeGroups.deleteNodes
HTTP Method : POST
Path : projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/deleteNodes
Flat Path : projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/deleteNodes
Description : Deletes specified nodes from the node group.
Parameter Order :
Scopes :
Apiversion : 2026-12-01-preview
Parameters :
nodeGroup
Required : Yes
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the NodeGroup resource whose nodes will be deleted.
Location : path
zone
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Description : The name of the zone for this request.
Required : Yes
project
Description : Project ID for this request.
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])?))
Type : string
Location : path
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).
▼ ▲ compute.nodeGroups.listNodes
Parameters :
zone
Description : The name of the zone for this request.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Type : string
nodeGroup
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Description : Name of the NodeGroup resource whose nodes you want to list.
Type : string
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.
Type : string
Location : query
maxResults
Minimum : 0
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`)
Default : 500
Type : integer
Location : query
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.
Type : string
Required : Yes
Location : path
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
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.
Location : query
Type : string
Flat Path : projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/listNodes
Apiversion : 2026-12-01-preview
Parameter Order :
Description : Lists nodes in the node group.
Scopes :
Path : projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/listNodes
HTTP Method : POST
▼ ▲ compute.nodeGroups.delete
Apiversion : 2026-12-01-preview
Scopes :
Parameters :
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 : Project ID for this request.
Location : path
nodeGroup
Location : path
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the NodeGroup resource to delete.
Required : Yes
zone
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Required : Yes
Description : The name of the zone for this request.
Location : path
requestId
Location : query
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
Parameter Order :
Description : Deletes the specified NodeGroup resource.
Flat Path : projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}
Path : projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}
HTTP Method : DELETE
▼ ▲ compute.nodeGroups.setIamPolicy
Scopes :
HTTP Method : POST
Parameter Order :
Flat Path : projects/{project}/zones/{zone}/nodeGroups/{resource}/setIamPolicy
Path : projects/{project}/zones/{zone}/nodeGroups/{resource}/setIamPolicy
Apiversion : 2026-12-01-preview
Description : Sets the access control policy on the specified resource. Replaces any existing policy.
Parameters :
zone
Required : Yes
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : The name of the zone for this request.
Location : path
resource
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Description : Name or id of the resource for this request.
Required : Yes
Type : string
project
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])?))
Required : Yes
Location : path
Type : string
▼ ▲ compute.nodeGroups.getIamPolicy
Parameters :
optionsRequestedPolicyVersion
Description : Requested IAM Policy version.
Type : integer
Format : int32
Location : query
resource
Type : string
Required : Yes
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 resource for 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])?))
Location : path
Type : string
Required : Yes
Description : Project ID for this request.
zone
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Location : path
Description : The name of the zone for this request.
Flat Path : projects/{project}/zones/{zone}/nodeGroups/{resource}/getIamPolicy
Apiversion : 2026-12-01-preview
Path : projects/{project}/zones/{zone}/nodeGroups/{resource}/getIamPolicy
Scopes :
Description : Gets the access control policy for a resource. May be empty if no such policy or resource exists.
Parameter Order :
HTTP Method : GET
▼ ▲ compute.nodeGroups.get
Flat Path : projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}
HTTP Method : GET
Parameter Order :
Description : Returns the specified NodeGroup. Get a list of available NodeGroups by making a list() request. Note: the "nodes" field should not be used. Use nodeGroups.listNodes instead.
Scopes :
Apiversion : 2026-12-01-preview
Parameters :
zone
Required : Yes
Description : The name of the zone for this request.
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
nodeGroup
Description : Name of the node group to return.
Type : string
Location : path
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
project
Location : path
Type : string
Description : Project ID for this request.
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])?))
Path : projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}
▼ ▲ compute.nodeGroups.performMaintenance
Scopes :
Flat Path : projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/performMaintenance
HTTP Method : POST
Parameters :
zone
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Description : The name of the zone for this request.
Required : Yes
nodeGroup
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Required : Yes
Description : Name of the node group scoping this request.
Location : path
project
Location : path
Description : Project ID for this request.
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
Type : string
Location : query
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).
Apiversion : 2026-12-01-preview
Path : projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/performMaintenance
Parameter Order :
Description : Perform maintenance on a subset of nodes in the node group.
▼ ▲ compute.nodeGroups.list
Parameter Order :
Scopes :
Description : Retrieves a list of node groups available to the specified project. Note: use nodeGroups.listNodes for more details about each group.
Parameters :
orderBy
Type : string
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.
pageToken
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.
Type : string
zone
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : The name of the zone for this request.
Required : Yes
Type : string
Location : path
maxResults
Location : query
Minimum : 0
Default : 500
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`)
Type : integer
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])?))
Type : string
Location : path
Description : Project ID for this request.
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
Apiversion : 2026-12-01-preview
HTTP Method : GET
Flat Path : projects/{project}/zones/{zone}/nodeGroups
Path : projects/{project}/zones/{zone}/nodeGroups
▼ ▲ compute.nodeGroups.addNodes
Apiversion : 2026-12-01-preview
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).
Location : query
Type : string
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])?))
Type : string
Description : Project ID for this request.
Location : path
nodeGroup
Required : Yes
Description : Name of the NodeGroup resource.
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
zone
Required : Yes
Description : The name of the zone for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Location : path
Description : Adds specified number of nodes to the node group.
Parameter Order :
Flat Path : projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/addNodes
HTTP Method : POST
Path : projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/addNodes
Scopes :
▼ ▲ compute.nodeGroups.patch
Parameter Order :
HTTP Method : PATCH
Flat Path : projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}
Scopes :
Path : projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}
Description : Updates the specified node group.
Apiversion : 2026-12-01-preview
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).
Location : query
Type : string
zone
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Description : The name of the zone for this request.
Location : path
nodeGroup
Required : Yes
Description : Name of the NodeGroup resource to update.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Location : path
project
Location : path
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 : Project ID for this request.
▼ ▲ compute.globalOperations.aggregatedList
Apiversion : 2026-12-01-preview
Path : projects/{project}/aggregated/operations
Parameter Order : project
Description : Retrieves an aggregated list of all operations. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.
Parameters :
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.
serviceProjectNumber
Type : string
Location : query
Format : int64
Description : The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.
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
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
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
Type : string
Required : Yes
Description : Project ID for this request.
maxResults
Default : 500
Minimum : 0
Format : uint32
Location : query
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
includeAllScopes
Description : Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
Location : query
Type : boolean
Scopes :
Flat Path : projects/{project}/aggregated/operations
HTTP Method : GET
▼ ▲ compute.globalOperations.delete
Parameters :
project
Description : Project ID for this request.
Required : Yes
Location : path
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])?))
operation
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the Operations resource to delete, or its unique numeric identifier.
Required : Yes
Type : string
Location : path
Apiversion : 2026-12-01-preview
Description : Deletes the specified Operations resource.
Flat Path : projects/{project}/global/operations/{operation}
Parameter Order :
Scopes :
Path : projects/{project}/global/operations/{operation}
HTTP Method : DELETE
▼ ▲ compute.globalOperations.wait
Flat Path : projects/{project}/global/operations/{operation}/wait
Apiversion : 2026-12-01-preview
Parameter Order :
Parameters :
operation
Type : string
Description : Name of the Operations resource to return, or its unique numeric identifier.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
project
Location : path
Description : Project ID for this request.
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])?))
Required : Yes
Scopes :
HTTP Method : POST
Description : Waits for the specified Operation resource to return as `DONE` or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource. This method differs from the `GET` method in that it waits for no more than the default deadline (2 minutes) and then returns the current state of the operation, which might be `DONE` or still in progress. This method is called on a best-effort basis. Specifically: - In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. - If the default deadline is reached, there is no guarantee that the operation is actually done when the method returns. Be prepared to retry if the operation is not `DONE`.
Path : projects/{project}/global/operations/{operation}/wait
▼ ▲ compute.globalOperations.get
Apiversion : 2026-12-01-preview
Parameters :
project
Description : Project ID for this request.
Location : path
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])?))
operation
Location : path
Type : string
Description : Name of the Operations resource to return, or its unique numeric identifier.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Parameter Order :
Path : projects/{project}/global/operations/{operation}
Description : Retrieves the specified Operations resource.
Scopes :
Flat Path : projects/{project}/global/operations/{operation}
HTTP Method : GET
▼ ▲ compute.globalOperations.list
Flat Path : projects/{project}/global/operations
Parameters :
pageToken
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.
Type : string
project
Description : Project ID for this request.
Location : path
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])?))
Required : Yes
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
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`)
Format : uint32
Location : query
Default : 500
Type : integer
Minimum : 0
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.
Apiversion : 2026-12-01-preview
Path : projects/{project}/global/operations
Description : Retrieves a list of Operation resources contained within the specified project.
Scopes :
Parameter Order : project
HTTP Method : GET
▼ ▲ compute.reservationBlocks.setIamPolicy
Description : Sets the access control policy on the specified resource. Replaces any existing policy.
Parameter Order :
Apiversion : 2026-12-01-preview
Parameters :
resource
Description : Name or id of the resource for this request.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Type : string
zone
Description : The name of the zone for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Location : path
Type : string
parentResource
Pattern : [a-z](?:[-a-zA-Z0-9/]{0,255}[a-zA-Z0-9])?
Location : path
Description : Name or id of parent resource of the resource for this request.
Type : string
Required : Yes
project
Required : Yes
Description : Project ID for this request.
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])?))
Location : path
Scopes :
Flat Path : projects/{project}/zones/{zone}/reservations/{parentResource}/reservationBlocks/{resource}/setIamPolicy
HTTP Method : POST
Path : projects/{project}/zones/{zone}/reservations/{parentResource}/reservationBlocks/{resource}/setIamPolicy
▼ ▲ compute.reservationBlocks.performMaintenance
Description : Allows customers to perform maintenance on a reservation block
Parameters :
zone
Required : Yes
Description : Name of the zone for this request. Zone name should conform to RFC1035.
Location : path
Type : string
requestId
Type : string
Location : query
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).
reservationBlock
Description : The name of the reservation block. Name should conform to RFC1035 or be a resource ID.
Required : Yes
Type : string
Location : path
reservation
Required : Yes
Description : The name of the reservation. Name should conform to RFC1035 or be a resource ID.
Type : string
Location : path
project
Required : Yes
Type : string
Location : path
Description : Project ID for this request.
Parameter Order :
Apiversion : 2026-12-01-preview
Scopes :
Path : projects/{project}/zones/{zone}/reservations/{reservation}/reservationBlocks/{reservationBlock}/performMaintenance
Flat Path : projects/{project}/zones/{zone}/reservations/{reservation}/reservationBlocks/{reservationBlock}/performMaintenance
HTTP Method : POST
▼ ▲ compute.reservationBlocks.testIamPermissions
Path : projects/{project}/zones/{zone}/reservations/{parentResource}/reservationBlocks/{resource}/testIamPermissions
Scopes :
HTTP Method : POST
Parameter Order :
Parameters :
parentResource
Description : Name or id of parent resource of the resource for this request.
Required : Yes
Pattern : [a-z](?:[-a-zA-Z0-9/]{0,255}[a-zA-Z0-9])?
Location : path
Type : string
resource
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Type : string
Description : Name or id of the resource for this request.
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])?))
Description : Project ID for this request.
Type : string
Required : Yes
zone
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : The name of the zone for this request.
Location : path
Type : string
Required : Yes
Flat Path : projects/{project}/zones/{zone}/reservations/{parentResource}/reservationBlocks/{resource}/testIamPermissions
Apiversion : 2026-12-01-preview
Description : Returns permissions that a caller has on the specified resource.
▼ ▲ compute.reservationBlocks.list
Scopes :
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
project
Location : path
Description : Project ID for this request.
Required : Yes
Type : string
maxResults
Default : 500
Minimum : 0
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`)
Type : integer
Location : query
filter
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.
Type : string
zone
Required : Yes
Location : path
Description : Name of the zone for this request. Zone name should conform to RFC1035.
Type : string
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
reservation
Location : path
Description : The name of the reservation. Name should conform to RFC1035 or be a resource ID.
Type : string
Required : Yes
Parameter Order :
Apiversion : 2026-12-01-preview
Path : projects/{project}/zones/{zone}/reservations/{reservation}/reservationBlocks
Description : Retrieves a list of reservation blocks under a single reservation.
Flat Path : projects/{project}/zones/{zone}/reservations/{reservation}/reservationBlocks
HTTP Method : GET
▼ ▲ compute.reservationBlocks.getIamPolicy
Description : Gets the access control policy for a resource. May be empty if no such policy or resource exists.
HTTP Method : GET
Path : projects/{project}/zones/{zone}/reservations/{parentResource}/reservationBlocks/{resource}/getIamPolicy
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/zones/{zone}/reservations/{parentResource}/reservationBlocks/{resource}/getIamPolicy
Parameters :
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])?))
Type : string
Required : Yes
parentResource
Location : path
Pattern : [a-z](?:[-a-zA-Z0-9/]{0,255}[a-zA-Z0-9])?
Description : Name or id of parent resource of the resource for this request.
Required : Yes
Type : string
resource
Description : Name or id of the resource for this request.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Location : path
optionsRequestedPolicyVersion
Location : query
Type : integer
Format : int32
Description : Requested IAM Policy version.
zone
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : The name of the zone for this request.
Type : string
Location : path
Scopes :
Parameter Order :
▼ ▲ compute.reservationBlocks.get
Apiversion : 2026-12-01-preview
Parameter Order :
Flat Path : projects/{project}/zones/{zone}/reservations/{reservation}/reservationBlocks/{reservationBlock}
Parameters :
view
Enum :
Description : View of the Block.
Type : string
Location : query
Enum Descriptions :
reservationBlock
Description : The name of the reservation block. Name should conform to RFC1035 or be a resource ID.
Type : string
Location : path
Required : Yes
zone
Description : Name of the zone for this request. Zone name should conform to RFC1035.
Location : path
Type : string
Required : Yes
reservation
Location : path
Type : string
Required : Yes
Description : The name of the reservation. Name should conform to RFC1035 or be a resource ID.
project
Description : Project ID for this request.
Type : string
Location : path
Required : Yes
Scopes :
Path : projects/{project}/zones/{zone}/reservations/{reservation}/reservationBlocks/{reservationBlock}
HTTP Method : GET
Description : Retrieves information about the specified reservation block.
▼ ▲ compute.regionNetworkFirewallPolicies.insert
Scopes :
HTTP Method : POST
Parameter Order :
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/regions/{region}/firewallPolicies
Parameters :
requestId
Location : query
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
region
Location : path
Type : string
Description : Name of the region scoping this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
project
Location : path
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])?))
Required : Yes
Type : string
Path : projects/{project}/regions/{region}/firewallPolicies
Description : Creates a new network firewall policy in the specified project and region.
▼ ▲ compute.regionNetworkFirewallPolicies.getEffectiveFirewalls
Description : Returns the effective firewalls on a given network.
Apiversion : 2026-12-01-preview
Parameters :
project
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])?))
Description : Project ID for this request.
Required : Yes
Location : path
network
Description : Network reference
Location : query
Required : Yes
Type : string
region
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Description : Name of the region scoping this request.
Required : Yes
Scopes :
Parameter Order :
HTTP Method : GET
Flat Path : projects/{project}/regions/{region}/firewallPolicies/getEffectiveFirewalls
Path : projects/{project}/regions/{region}/firewallPolicies/getEffectiveFirewalls
▼ ▲ compute.regionNetworkFirewallPolicies.patchAssociation
Flat Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/patchAssociation
Apiversion : 2026-12-01-preview
Parameters :
firewallPolicy
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Type : string
Description : Name of the firewall policy to update.
Required : Yes
region
Type : string
Description : Name of the region scoping this request.
Location : path
Required : Yes
Pattern : [a-z](?:[-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).
Type : string
Location : query
project
Location : path
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])?))
Required : Yes
Parameter Order :
Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/patchAssociation
HTTP Method : POST
Scopes :
Description : Updates an association for the specified network firewall policy.
▼ ▲ compute.regionNetworkFirewallPolicies.list
Flat Path : projects/{project}/regions/{region}/firewallPolicies
HTTP Method : GET
Path : projects/{project}/regions/{region}/firewallPolicies
Scopes :
Parameters :
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.
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
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.
Type : string
Required : Yes
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
maxResults
Type : integer
Minimum : 0
Default : 500
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`)
Location : query
region
Description : Name of the region scoping this request.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Type : string
Parameter Order :
Description : Lists all the network firewall policies that have been configured for the specified project in the given region.
Apiversion : 2026-12-01-preview
▼ ▲ compute.regionNetworkFirewallPolicies.getRule
Description : Gets a rule of the specified priority.
Parameters :
priority
Description : The priority of the rule to get from the firewall policy.
Format : int32
Location : query
Type : integer
firewallPolicy
Location : path
Description : Name of the firewall policy to which the queried rule belongs.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Required : Yes
region
Description : Name of the region scoping this request.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Location : path
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.
Required : Yes
Location : path
Type : string
Apiversion : 2026-12-01-preview
Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/getRule
Parameter Order :
HTTP Method : GET
Scopes :
Flat Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/getRule
▼ ▲ compute.regionNetworkFirewallPolicies.removeRule
Flat Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/removeRule
HTTP Method : POST
Parameter Order :
Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/removeRule
Scopes :
Apiversion : 2026-12-01-preview
Description : Deletes a rule of the specified priority.
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
Description : Project ID for this request.
Location : path
Type : string
priority
Location : query
Type : integer
Format : int32
Description : The priority of the rule to remove from the firewall policy.
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Description : Name of the region scoping this request.
Location : path
Required : Yes
firewallPolicy
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Type : string
Description : Name of the firewall policy to update.
Location : path
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
▼ ▲ compute.regionNetworkFirewallPolicies.delete
Description : Deletes the specified network firewall policy.
Parameter Order :
Parameters :
firewallPolicy
Required : Yes
Type : string
Description : Name of the firewall policy to delete.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
project
Required : Yes
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])?))
Type : string
Location : path
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
region
Type : string
Location : path
Required : Yes
Description : Name of the region scoping this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}
HTTP Method : DELETE
Scopes :
Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}
▼ ▲ compute.regionNetworkFirewallPolicies.patch
Parameter Order :
Apiversion : 2026-12-01-preview
Parameters :
firewallPolicy
Type : string
Description : Name of the firewall policy to update.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Required : Yes
project
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])?))
Description : Project ID for this request.
region
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Description : Name of the region scoping this request.
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).
Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}
Flat Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}
Description : Patches the specified network firewall policy.
HTTP Method : PATCH
Scopes :
▼ ▲ compute.regionNetworkFirewallPolicies.cloneRules
Flat Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/cloneRules
Apiversion : 2026-12-01-preview
Scopes :
Parameter Order :
Parameters :
requestId
Type : string
Location : query
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).
sourceFirewallPolicy
Location : query
Type : string
Description : The firewall policy from which to copy rules.
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
Description : Project ID for this request.
Location : path
Type : string
firewallPolicy
Required : Yes
Type : string
Description : Name of the firewall policy to update.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
region
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Name of the region scoping this request.
Required : Yes
Type : string
Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/cloneRules
HTTP Method : POST
Description : Copies rules to the specified network firewall policy.
▼ ▲ compute.regionNetworkFirewallPolicies.getAssociation
Parameter Order :
Flat Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/getAssociation
Scopes :
Apiversion : 2026-12-01-preview
Parameters :
project
Required : Yes
Description : Project ID for this request.
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])?))
Location : path
firewallPolicy
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Description : Name of the firewall policy to which the queried association belongs.
Location : path
Type : string
name
Location : query
Description : The name of the association to get from the firewall policy.
Type : string
region
Required : Yes
Type : string
Description : Name of the region scoping this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
HTTP Method : GET
Description : Gets an association with the specified name.
Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/getAssociation
▼ ▲ compute.regionNetworkFirewallPolicies.addAssociation
Parameters :
requestId
Location : query
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
project
Description : Project ID for this request.
Required : Yes
Location : path
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])?))
associatedPolicyToBeReplaced
Description : Name of the firewall policy associated with the target network to swap association with. This field is mutually exclusive with 'replace_existing_association'.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : query
Type : string
replaceExistingAssociation
Location : query
Type : boolean
Description : Indicates whether or not to replace it if an association already exists. This is false by default, in which case an error will be returned if an association already exists.
firewallPolicy
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the firewall policy to update.
Required : Yes
region
Location : path
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Name of the region scoping this request.
Type : string
Parameter Order :
Apiversion : 2026-12-01-preview
Description : Inserts an association for the specified network firewall policy.
Flat Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/addAssociation
Scopes :
HTTP Method : POST
Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/addAssociation
▼ ▲ compute.regionNetworkFirewallPolicies.get
Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}
HTTP Method : GET
Parameter Order :
Flat Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}
Apiversion : 2026-12-01-preview
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])?))
Type : string
Location : path
Required : Yes
Description : Project ID for this request.
firewallPolicy
Description : Name of the firewall policy to get.
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
region
Required : Yes
Description : Name of the region scoping this request.
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Description : Returns the specified network firewall policy.
Scopes :
▼ ▲ compute.regionNetworkFirewallPolicies.patchRule
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).
Location : query
Type : string
region
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Description : Name of the region scoping this request.
priority
Description : The priority of the rule to patch.
Location : query
Format : int32
Type : integer
project
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])?))
Location : path
Description : Project ID for this request.
Required : Yes
firewallPolicy
Required : Yes
Type : string
Description : Name of the firewall policy to update.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Parameter Order :
Description : Patches a rule of the specified priority.
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/patchRule
Scopes :
Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/patchRule
HTTP Method : POST
▼ ▲ compute.regionNetworkFirewallPolicies.getIamPolicy
Path : projects/{project}/regions/{region}/firewallPolicies/{resource}/getIamPolicy
HTTP Method : GET
Parameters :
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : The name of the region for this request.
Type : string
Required : Yes
Location : path
optionsRequestedPolicyVersion
Format : int32
Type : integer
Description : Requested IAM Policy version.
Location : query
project
Type : string
Location : path
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])?))
Required : Yes
resource
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name or id of the resource for this request.
Type : string
Required : Yes
Location : path
Scopes :
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/regions/{region}/firewallPolicies/{resource}/getIamPolicy
Description : Gets the access control policy for a resource. May be empty if no such policy or resource exists.
Parameter Order :
▼ ▲ compute.regionNetworkFirewallPolicies.setIamPolicy
Parameter Order :
Parameters :
project
Type : string
Location : path
Description : Project ID for this request.
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])?))
region
Required : Yes
Description : The name of the region for this request.
Location : path
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
resource
Type : string
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name or id of the resource for this request.
Location : path
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/regions/{region}/firewallPolicies/{resource}/setIamPolicy
Path : projects/{project}/regions/{region}/firewallPolicies/{resource}/setIamPolicy
Description : Sets the access control policy on the specified resource. Replaces any existing policy.
Scopes :
HTTP Method : POST
▼ ▲ compute.regionNetworkFirewallPolicies.addRule
Flat Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/addRule
Apiversion : 2026-12-01-preview
Scopes :
Parameters :
maxPriority
Type : integer
Description : When rule.priority is not specified, auto choose a unused priority betweenminPriority and maxPriority>. This field is exclusive with rule.priority.
Location : query
Format : int32
firewallPolicy
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Description : Name of the firewall policy to update.
Type : string
Required : Yes
region
Required : Yes
Description : Name of the region scoping this request.
Type : string
Location : path
Pattern : [a-z](?:[-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).
Type : string
Location : query
project
Required : Yes
Description : Project ID for this request.
Location : path
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])?))
minPriority
Format : int32
Location : query
Type : integer
Description : When rule.priority is not specified, auto choose a unused priority betweenminPriority and maxPriority>. This field is exclusive with rule.priority.
HTTP Method : POST
Description : Inserts a rule into a network firewall policy.
Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/addRule
Parameter Order :
▼ ▲ compute.regionNetworkFirewallPolicies.removeAssociation
HTTP Method : POST
Parameter Order :
Scopes :
Apiversion : 2026-12-01-preview
Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/removeAssociation
Parameters :
firewallPolicy
Required : Yes
Type : string
Description : Name of the firewall policy to update.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
region
Location : path
Description : Name of the region scoping this request.
Required : Yes
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
name
Type : string
Location : query
Description : Name for the association that will be removed.
project
Required : Yes
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])?))
Location : path
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
Description : Removes an association for the specified network firewall policy.
Flat Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/removeAssociation
▼ ▲ compute.regionNetworkFirewallPolicies.testIamPermissions
Parameter Order :
Scopes :
HTTP Method : POST
Flat Path : projects/{project}/regions/{region}/firewallPolicies/{resource}/testIamPermissions
Apiversion : 2026-12-01-preview
Description : Returns permissions that a caller has on the specified resource.
Path : projects/{project}/regions/{region}/firewallPolicies/{resource}/testIamPermissions
Parameters :
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Location : path
Description : The name of the region for this request.
Type : string
resource
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Type : string
Description : Name or id of the resource for this request.
project
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])?))
Required : Yes
Type : string
Location : path
▼ ▲ compute.haControllers.failover
Apiversion : 2026-12-01-preview
Scopes :
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.
Type : string
Required : Yes
requestId
Location : query
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.
Type : string
haController
Required : Yes
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : ID of the HaController resource to update.
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Description : Name of the region for this request.
Required : Yes
Type : string
HTTP Method : POST
Description : Fails over a VM targeted by the specified HaController to the selected zone.
Flat Path : projects/{project}/regions/{region}/haControllers/{haController}/failover
Parameter Order :
Path : projects/{project}/regions/{region}/haControllers/{haController}/failover
▼ ▲ compute.haControllers.insert
Flat Path : projects/{project}/regions/{region}/haControllers
Description : Creates HaController in the specified project.
Apiversion : 2026-12-01-preview
Path : projects/{project}/regions/{region}/haControllers
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.
Location : query
Type : string
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Type : string
Location : path
Description : Name of the region for 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])?))
Required : Yes
Type : string
Location : path
Description : Project ID for this request.
HTTP Method : POST
Scopes :
Parameter Order :
▼ ▲ compute.haControllers.aggregatedList
Path : projects/{project}/aggregated/haControllers
Flat Path : projects/{project}/aggregated/haControllers
HTTP Method : GET
Scopes :
Parameter Order : project
Apiversion : 2026-12-01-preview
Parameters :
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.
serviceProjectNumber
Description : The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.
Location : query
Format : int64
Type : string
project
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])?))
Required : Yes
Description : Project ID for this request.
includeAllScopes
Type : boolean
Location : query
Description : Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
maxResults
Minimum : 0
Format : uint32
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
Location : query
orderBy
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.
Location : query
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 : Retrieves an aggregated list of all of the HaControllers in the specified project across all regions.
▼ ▲ compute.haControllers.list
HTTP Method : GET
Path : projects/{project}/regions/{region}/haControllers
Flat Path : projects/{project}/regions/{region}/haControllers
Parameter Order :
Parameters :
filter
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.
Type : string
maxResults
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`)
Minimum : 0
Default : 500
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.
Type : string
Location : query
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.
Type : string
Location : query
region
Description : Name of the region for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Type : string
Required : Yes
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.
Type : string
Required : Yes
Scopes :
Apiversion : 2026-12-01-preview
Description : Lists all HaControllers in the specified project in the specified region.
▼ ▲ compute.haControllers.get
Parameters :
haController
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Description : Name of the HaController resource to return.
Required : Yes
Type : string
region
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Name of the region for this request.
Type : string
Location : path
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.
Type : string
Location : path
Path : projects/{project}/regions/{region}/haControllers/{haController}
Parameter Order :
Apiversion : 2026-12-01-preview
HTTP Method : GET
Flat Path : projects/{project}/regions/{region}/haControllers/{haController}
Scopes :
Description : Returns all the details of a specific HaController.
▼ ▲ compute.haControllers.delete
Parameters :
haController
Description : Name of the HaController resource to delete.
Type : string
Location : path
Required : Yes
force
Type : boolean
Description : Force-deletes HA Controller when the Delete is stuck. Instance that is not primary at the moment will also be deleted. Can only be used against the HA Controller resource that is already being deleted.
Location : query
requestId
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.
Location : query
region
Description : Name of the region for this request.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
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])?))
Type : string
Location : path
Required : Yes
Description : Project ID for this request.
Parameter Order :
Path : projects/{project}/regions/{region}/haControllers/{haController}
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/regions/{region}/haControllers/{haController}
Description : Deletes an HaController in the specified project.
Scopes :
HTTP Method : DELETE
▼ ▲ compute.haControllers.patch
HTTP Method : PATCH
Description : Updates HaController in the specified project.
Apiversion : 2026-12-01-preview
Parameters :
updateMask
Location : query
Description : update_mask indicates fields to be updated as part of this request.
Type : string
Format : google-fieldmask
haController
Required : Yes
Description : ID of the HaController resource to update.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Location : path
requestId
Type : string
Location : query
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.
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Description : Name of the region for this request.
Type : string
Required : Yes
project
Required : Yes
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])?))
Location : path
Type : string
Flat Path : projects/{project}/regions/{region}/haControllers/{haController}
Path : projects/{project}/regions/{region}/haControllers/{haController}
Scopes :
Parameter Order :
▼ ▲ compute.interconnectGroups.patch
Apiversion : 2026-12-01-preview
Parameter Order :
Path : projects/{project}/global/interconnectGroups/{interconnectGroup}
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). end_interface: MixerMutationRequestBuilder
Location : query
Type : string
updateMask
Location : query
Format : google-fieldmask
Description : The list of fields to update.
Type : string
interconnectGroup
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Required : Yes
Description : Name of the InterconnectGroup resource to patch.
Location : path
project
Location : path
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])?))
Description : Project ID for this request.
Required : Yes
Scopes :
Flat Path : projects/{project}/global/interconnectGroups/{interconnectGroup}
Description : Patches the specified InterconnectGroup resource with the data included in the request. This method supports PATCH semantics and usesJSON merge patch format and processing rules.
HTTP Method : PATCH
▼ ▲ compute.interconnectGroups.list
Description : Lists the InterconnectGroups for a project in the given scope.
Path : projects/{project}/global/interconnectGroups
Parameter Order : project
Parameters :
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.
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
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`)
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.
Type : string
Location : query
project
Location : path
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])?))
Type : string
Required : Yes
Scopes :
Apiversion : 2026-12-01-preview
HTTP Method : GET
Flat Path : projects/{project}/global/interconnectGroups
▼ ▲ compute.interconnectGroups.delete
Description : Deletes the specified InterconnectGroup in the given scope
Parameters :
interconnectGroup
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Description : Name of the InterconnectGroup resource to delete.
project
Type : string
Location : path
Required : Yes
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])?))
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). end_interface: MixerMutationRequestBuilder
Location : query
Type : string
Apiversion : 2026-12-01-preview
Path : projects/{project}/global/interconnectGroups/{interconnectGroup}
Scopes :
Flat Path : projects/{project}/global/interconnectGroups/{interconnectGroup}
HTTP Method : DELETE
Parameter Order :
▼ ▲ compute.interconnectGroups.getIamPolicy
Flat Path : projects/{project}/global/interconnectGroups/{resource}/getIamPolicy
Description : Gets the access control policy for a resource. May be empty if no such policy or resource exists.
Apiversion : 2026-12-01-preview
Scopes :
Parameter Order :
Parameters :
project
Required : Yes
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])?))
Location : path
Type : string
resource
Required : Yes
Description : Name or id of the resource for this request.
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
optionsRequestedPolicyVersion
Location : query
Format : int32
Type : integer
Description : Requested IAM Policy version.
Path : projects/{project}/global/interconnectGroups/{resource}/getIamPolicy
HTTP Method : GET
▼ ▲ compute.interconnectGroups.insert
HTTP Method : POST
Scopes :
Path : projects/{project}/global/interconnectGroups
Parameter Order : project
Description : Creates a InterconnectGroup in the specified project in the given scope using the parameters that are included in the request.
Parameters :
requestId
Type : string
Location : query
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). end_interface: MixerMutationRequestBuilder
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])?))
Description : Project ID for this request.
Type : string
Required : Yes
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/global/interconnectGroups
▼ ▲ compute.interconnectGroups.createMembers
Scopes :
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
Type : string
Description : Project ID for this request.
Required : Yes
interconnectGroup
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Description : Name of the group resource to create members for.
Parameter Order :
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/global/interconnectGroups/{interconnectGroup}/createMembers
Description : Create Interconnects with redundancy by creating them in a specified interconnect group.
HTTP Method : POST
Path : projects/{project}/global/interconnectGroups/{interconnectGroup}/createMembers
▼ ▲ compute.interconnectGroups.testIamPermissions
Parameter Order :
Parameters :
project
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])?))
Required : Yes
Location : path
Type : string
resource
Required : Yes
Pattern : [a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Location : path
Description : Name or id of the resource for this request.
Path : projects/{project}/global/interconnectGroups/{resource}/testIamPermissions
Scopes :
Apiversion : 2026-12-01-preview
Description : Returns permissions that a caller has on the specified resource.
Flat Path : projects/{project}/global/interconnectGroups/{resource}/testIamPermissions
HTTP Method : POST
▼ ▲ compute.interconnectGroups.getOperationalStatus
Flat Path : projects/{project}/global/interconnectGroups/{interconnectGroup}/getOperationalStatus
Scopes :
Apiversion : 2026-12-01-preview
Parameters :
interconnectGroup
Location : path
Type : string
Description : Name of the interconnectGroup resource to query.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
project
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])?))
Required : Yes
Description : Project ID for this request.
HTTP Method : GET
Parameter Order :
Path : projects/{project}/global/interconnectGroups/{interconnectGroup}/getOperationalStatus
Description : Returns the interconnectStatuses for the specified InterconnectGroup.
▼ ▲ compute.interconnectGroups.setIamPolicy
Description : Sets the access control policy on the specified resource. Replaces any existing policy.
HTTP Method : POST
Scopes :
Path : projects/{project}/global/interconnectGroups/{resource}/setIamPolicy
Flat Path : projects/{project}/global/interconnectGroups/{resource}/setIamPolicy
Parameters :
project
Required : Yes
Description : Project ID for this request.
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])?))
resource
Location : path
Type : string
Pattern : [a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Description : Name or id of the resource for this request.
Apiversion : 2026-12-01-preview
Parameter Order :
▼ ▲ compute.interconnectGroups.get
Parameter Order :
HTTP Method : GET
Parameters :
project
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])?))
Location : path
Description : Project ID for this request.
interconnectGroup
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Required : Yes
Description : Name of the InterconnectGroup resource to return.
Location : path
Flat Path : projects/{project}/global/interconnectGroups/{interconnectGroup}
Scopes :
Apiversion : 2026-12-01-preview
Path : projects/{project}/global/interconnectGroups/{interconnectGroup}
Description : Returns the specified InterconnectGroup resource in the given scope.
▼ ▲ compute.regionCompositeHealthChecks.aggregatedList
Parameters :
orderBy
Type : string
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.
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
filter
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.
Type : string
maxResults
Minimum : 0
Default : 500
Format : uint32
Type : integer
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`)
Location : query
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])?))
Type : string
Description : Name of the project scoping this request.
Location : path
serviceProjectNumber
Location : query
Type : string
Description : The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.
Format : int64
includeAllScopes
Location : query
Description : Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
Type : boolean
Scopes :
Apiversion : 2026-12-01-preview
Path : projects/{project}/aggregated/compositeHealthChecks
Flat Path : projects/{project}/aggregated/compositeHealthChecks
Parameter Order : project
Description : Retrieves the list of all CompositeHealthCheck resources (all regional) available to the specified project. To prevent failure, it is recommended that you set the `returnPartialSuccess` parameter to `true`.
HTTP Method : GET
▼ ▲ compute.regionCompositeHealthChecks.patch
Scopes :
Flat Path : projects/{project}/regions/{region}/compositeHealthChecks/{compositeHealthCheck}
Parameter Order :
HTTP Method : PATCH
Parameters :
region
Description : Name of the region scoping this request.
Location : path
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
compositeHealthCheck
Location : path
Description : Name of the CompositeHealthCheck to update. The name must be 1-63 characters long, and comply with RFC1035.
Type : string
Required : Yes
requestId
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).
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
Required : Yes
Description : Project ID for this request.
Apiversion : 2026-12-01-preview
Path : projects/{project}/regions/{region}/compositeHealthChecks/{compositeHealthCheck}
Description : Updates the specified regional CompositeHealthCheck resource with the data included in the request. This method supportsPATCH semantics and uses theJSON merge patch format and processing rules.
▼ ▲ compute.regionCompositeHealthChecks.get
HTTP Method : GET
Flat Path : projects/{project}/regions/{region}/compositeHealthChecks/{compositeHealthCheck}
Scopes :
Apiversion : 2026-12-01-preview
Parameter Order :
Description : Returns the specified CompositeHealthCheck resource in the given region.
Parameters :
compositeHealthCheck
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Description : Name of the CompositeHealthCheck resource to return.
Location : path
project
Type : string
Description : Project ID for this request.
Location : path
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])?))
region
Required : Yes
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Name of the region scoping this request.
Location : path
Path : projects/{project}/regions/{region}/compositeHealthChecks/{compositeHealthCheck}
▼ ▲ compute.regionCompositeHealthChecks.list
Description : Lists the CompositeHealthChecks for a project in the given region.
Path : projects/{project}/regions/{region}/compositeHealthChecks
Scopes :
Parameters :
maxResults
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`)
Minimum : 0
Type : integer
Default : 500
Location : query
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
region
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Name of the region scoping this request.
Type : string
Location : path
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
Location : path
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])?))
Description : Project ID for this request.
Required : Yes
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.
Location : query
Type : string
Flat Path : projects/{project}/regions/{region}/compositeHealthChecks
Apiversion : 2026-12-01-preview
Parameter Order :
HTTP Method : GET
▼ ▲ compute.regionCompositeHealthChecks.getHealth
Scopes :
Apiversion : 2026-12-01-preview
Parameter Order :
Parameters :
region
Required : Yes
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Name of the region scoping this request.
project
Required : Yes
Location : path
Description : Name of the project scoping this request.
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])?))
compositeHealthCheck
Location : path
Description : Name of the CompositeHealthCheck resource to get health for.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Required : Yes
Description : Gets the most recent health check results for this regional CompositeHealthCheck.
Flat Path : projects/{project}/regions/{region}/compositeHealthChecks/{compositeHealthCheck}/getHealth
Path : projects/{project}/regions/{region}/compositeHealthChecks/{compositeHealthCheck}/getHealth
HTTP Method : GET
▼ ▲ compute.regionCompositeHealthChecks.insert
Flat Path : projects/{project}/regions/{region}/compositeHealthChecks
Parameters :
requestId
Location : query
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
region
Required : Yes
Type : string
Description : Name of the region scoping this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
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
Scopes :
Apiversion : 2026-12-01-preview
Description : Create a CompositeHealthCheck in the specified project in the given region using the parameters that are included in the request.
Path : projects/{project}/regions/{region}/compositeHealthChecks
HTTP Method : POST
Parameter Order :
▼ ▲ compute.regionCompositeHealthChecks.testIamPermissions
Scopes :
Flat Path : projects/{project}/regions/{region}/compositeHealthChecks/{resource}/testIamPermissions
Parameters :
region
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Description : The name of the region for this request.
resource
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name or id of the resource for this request.
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
Apiversion : 2026-12-01-preview
Description : Returns permissions that a caller has on the specified resource.
Path : projects/{project}/regions/{region}/compositeHealthChecks/{resource}/testIamPermissions
HTTP Method : POST
Parameter Order :
▼ ▲ compute.regionCompositeHealthChecks.delete
HTTP Method : DELETE
Description : Deletes the specified CompositeHealthCheck in the given region
Path : projects/{project}/regions/{region}/compositeHealthChecks/{compositeHealthCheck}
Parameter Order :
Parameters :
compositeHealthCheck
Required : Yes
Description : Name of the CompositeHealthCheck resource to delete.
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
region
Location : path
Description : Name of the region scoping this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
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).
project
Description : Project ID for this request.
Location : path
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])?))
Flat Path : projects/{project}/regions/{region}/compositeHealthChecks/{compositeHealthCheck}
Scopes :
Apiversion : 2026-12-01-preview
▼ ▲ compute.globalPublicDelegatedPrefixes.insert
HTTP Method : POST
Flat Path : projects/{project}/global/publicDelegatedPrefixes
Parameter Order : project
Scopes :
Path : projects/{project}/global/publicDelegatedPrefixes
Apiversion : 2026-12-01-preview
Description : Creates a global PublicDelegatedPrefix in the specified project using the parameters that are included in the request.
Parameters :
project
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])?))
Description : Project ID for this request.
Required : Yes
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
▼ ▲ compute.globalPublicDelegatedPrefixes.list
Path : projects/{project}/global/publicDelegatedPrefixes
Flat Path : projects/{project}/global/publicDelegatedPrefixes
HTTP Method : GET
Apiversion : 2026-12-01-preview
Parameter Order : project
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
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
maxResults
Default : 500
Format : uint32
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`)
Location : query
Type : integer
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.
filter
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.
Type : string
Scopes :
Description : Lists the global PublicDelegatedPrefixes for a project.
▼ ▲ compute.globalPublicDelegatedPrefixes.get
HTTP Method : GET
Description : Returns the specified global PublicDelegatedPrefix resource.
Parameter Order :
Scopes :
Flat Path : projects/{project}/global/publicDelegatedPrefixes/{publicDelegatedPrefix}
Parameters :
publicDelegatedPrefix
Type : string
Location : path
Description : Name of the PublicDelegatedPrefix resource to return.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
project
Location : path
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])?))
Description : Project ID for this request.
Required : Yes
Path : projects/{project}/global/publicDelegatedPrefixes/{publicDelegatedPrefix}
Apiversion : 2026-12-01-preview
▼ ▲ compute.globalPublicDelegatedPrefixes.patch
HTTP Method : PATCH
Flat Path : projects/{project}/global/publicDelegatedPrefixes/{publicDelegatedPrefix}
Description : Patches the specified global PublicDelegatedPrefix resource with the data included in the request. This method supportsPATCH semantics and usesJSON merge patch format and processing rules.
Path : projects/{project}/global/publicDelegatedPrefixes/{publicDelegatedPrefix}
Scopes :
Parameter Order :
Parameters :
publicDelegatedPrefix
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Description : Name of the PublicDelegatedPrefix resource to patch.
Required : Yes
requestId
Location : query
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
project
Type : string
Location : path
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.
Apiversion : 2026-12-01-preview
▼ ▲ compute.globalPublicDelegatedPrefixes.delete
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
project
Type : string
Location : path
Description : Project ID for this request.
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])?))
publicDelegatedPrefix
Required : Yes
Description : Name of the PublicDelegatedPrefix resource to delete.
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Flat Path : projects/{project}/global/publicDelegatedPrefixes/{publicDelegatedPrefix}
Apiversion : 2026-12-01-preview
Parameter Order :
Path : projects/{project}/global/publicDelegatedPrefixes/{publicDelegatedPrefix}
HTTP Method : DELETE
Description : Deletes the specified global PublicDelegatedPrefix.
Scopes :
▼ ▲ compute.previewFeatures.get
Description : Returns the details of the given PreviewFeature.
Flat Path : projects/{project}/global/previewFeatures/{previewFeature}
Scopes :
Apiversion : 2026-12-01-preview
Parameters :
previewFeature
Required : Yes
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Description : Name of the PreviewFeature for this request.
project
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])?))
Location : path
Required : Yes
Type : string
Path : projects/{project}/global/previewFeatures/{previewFeature}
HTTP Method : GET
Parameter Order :
▼ ▲ compute.previewFeatures.list
Flat Path : projects/{project}/global/previewFeatures
Description : Returns the details of the given PreviewFeature.
HTTP Method : GET
Path : projects/{project}/global/previewFeatures
Scopes :
Apiversion : 2026-12-01-preview
Parameters :
maxResults
Location : query
Type : integer
Minimum : 0
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`)
Default : 500
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
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])?))
Type : string
Required : Yes
filter
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.
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.
Parameter Order : project
▼ ▲ compute.previewFeatures.update
Path : projects/{project}/global/previewFeatures/{previewFeature}
Description : Patches the given PreviewFeature. This method is used to enable or disable a PreviewFeature.
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).
Location : query
Type : string
previewFeature
Required : Yes
Description : Name of the PreviewFeature for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Location : path
project
Location : path
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])?))
Required : Yes
Description : Project ID for this request.
Parameter Order :
Apiversion : 2026-12-01-preview
Scopes :
Flat Path : projects/{project}/global/previewFeatures/{previewFeature}
HTTP Method : PATCH
▼ ▲ compute.zoneVmExtensionPolicies.insert
Apiversion : 2026-12-01-preview
Parameters :
requestId
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).
Location : query
zone
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Type : string
Description : Name of the zone for this request.
Required : Yes
project
Description : Project ID for this request.
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])?))
Location : path
Flat Path : projects/{project}/zones/{zone}/vmExtensionPolicies
Parameter Order :
Scopes :
Description : Creates a new zone-level VM extension policy within a project.
HTTP Method : POST
Path : projects/{project}/zones/{zone}/vmExtensionPolicies
▼ ▲ compute.zoneVmExtensionPolicies.list
Scopes :
Parameter Order :
HTTP Method : GET
Parameters :
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.
zone
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Type : string
Description : Name of the zone for this request.
Required : Yes
filter
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.
Location : query
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.
Type : string
Location : query
maxResults
Minimum : 0
Default : 500
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`)
Location : query
Type : integer
project
Type : string
Location : path
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])?))
Required : Yes
Path : projects/{project}/zones/{zone}/vmExtensionPolicies
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/zones/{zone}/vmExtensionPolicies
Description : Lists all VM extension policies within a specific zone for a project.
▼ ▲ compute.zoneVmExtensionPolicies.update
HTTP Method : PATCH
Flat Path : projects/{project}/zones/{zone}/vmExtensionPolicies/{vmExtensionPolicy}
Scopes :
Path : projects/{project}/zones/{zone}/vmExtensionPolicies/{vmExtensionPolicy}
Parameters :
zone
Type : string
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Name of the zone for this request.
Location : path
project
Type : string
Location : path
Required : Yes
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])?))
vmExtensionPolicy
Description : Name of the zone VM extension policy to update.
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).
Type : string
Location : query
Description : Modifies an existing zone VM extension policy within a project.
Parameter Order :
Apiversion : 2026-12-01-preview
▼ ▲ compute.zoneVmExtensionPolicies.delete
Description : Deletes a specified zone VM extension policy within a project.
Flat Path : projects/{project}/zones/{zone}/vmExtensionPolicies/{vmExtensionPolicy}
Scopes :
Parameters :
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
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Description : Name of the zone for this request.
Type : string
Required : Yes
project
Required : Yes
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])?))
Type : string
Location : path
vmExtensionPolicy
Required : Yes
Description : Name of the zone VM extension policy to delete.
Type : string
Location : path
Apiversion : 2026-12-01-preview
Path : projects/{project}/zones/{zone}/vmExtensionPolicies/{vmExtensionPolicy}
HTTP Method : DELETE
Parameter Order :
▼ ▲ compute.zoneVmExtensionPolicies.get
Path : projects/{project}/zones/{zone}/vmExtensionPolicies/{vmExtensionPolicy}
Scopes :
HTTP Method : GET
Parameter Order :
Description : Retrieves details of a specific zone VM extension policy within a project.
Flat Path : projects/{project}/zones/{zone}/vmExtensionPolicies/{vmExtensionPolicy}
Apiversion : 2026-12-01-preview
Parameters :
vmExtensionPolicy
Description : Name of the VM extension policy resource to return.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Location : path
zone
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Description : Name of the zone for this request.
Required : Yes
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])?))
Location : path
Description : Project ID for this request.
▼ ▲ compute.regionHealthSources.delete
Parameters :
project
Description : Project ID for this request.
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])?))
Location : path
Type : string
region
Location : path
Description : Name of the region scoping this request.
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
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
healthSource
Location : path
Description : Name of the HealthSource resource to delete.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Type : string
Description : Deletes the specified HealthSource in the given region
Apiversion : 2026-12-01-preview
Parameter Order :
Scopes :
Flat Path : projects/{project}/regions/{region}/healthSources/{healthSource}
Path : projects/{project}/regions/{region}/healthSources/{healthSource}
HTTP Method : DELETE
▼ ▲ compute.regionHealthSources.list
Apiversion : 2026-12-01-preview
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
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.
Type : string
Location : query
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.
Type : string
Location : query
maxResults
Type : integer
Format : uint32
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`)
Minimum : 0
Location : query
region
Location : path
Required : Yes
Description : Name of the region scoping this request.
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
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])?))
Type : string
Required : Yes
Location : path
Description : Project ID for this request.
Flat Path : projects/{project}/regions/{region}/healthSources
Description : Lists the HealthSources for a project in the given region.
Scopes :
HTTP Method : GET
Path : projects/{project}/regions/{region}/healthSources
Parameter Order :
▼ ▲ compute.regionHealthSources.get
HTTP Method : GET
Path : projects/{project}/regions/{region}/healthSources/{healthSource}
Description : Returns the specified HealthSource resource in the given region.
Parameter Order :
Flat Path : projects/{project}/regions/{region}/healthSources/{healthSource}
Scopes :
Parameters :
region
Type : string
Location : path
Description : Name of the region scoping this request.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
project
Description : Project ID for this request.
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])?))
Location : path
healthSource
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Required : Yes
Description : Name of the HealthSource resource to return.
Apiversion : 2026-12-01-preview
▼ ▲ compute.regionHealthSources.patch
Apiversion : 2026-12-01-preview
Parameters :
healthSource
Location : path
Description : Name of the HealthSource to update. The name must be 1-63 characters long, and comply with RFC1035.
Type : string
Required : Yes
project
Type : string
Description : Project ID for this request.
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])?))
region
Type : string
Location : path
Description : Name of the region scoping this request.
Required : Yes
Pattern : [a-z](?:[-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
Parameter Order :
Description : Updates the specified regional HealthSource resource with the data included in the request. This method supportsPATCH semantics and uses theJSON merge patch format and processing rules.
Flat Path : projects/{project}/regions/{region}/healthSources/{healthSource}
Path : projects/{project}/regions/{region}/healthSources/{healthSource}
HTTP Method : PATCH
Scopes :
▼ ▲ compute.regionHealthSources.insert
Path : projects/{project}/regions/{region}/healthSources
Scopes :
HTTP Method : POST
Parameter Order :
Description : Create a HealthSource in the specified project in the given region using the parameters that are included in the request.
Flat Path : projects/{project}/regions/{region}/healthSources
Parameters :
region
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Name of the region scoping this request.
Required : Yes
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 : Project ID for this request.
Location : path
requestId
Location : query
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
Apiversion : 2026-12-01-preview
▼ ▲ compute.regionHealthSources.getHealth
Parameters :
healthSource
Location : path
Description : Name of the HealthSource resource to get health for.
Type : string
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
region
Description : Name of the region scoping this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
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
Location : path
Description : Name of the project scoping this request.
Path : projects/{project}/regions/{region}/healthSources/{healthSource}/getHealth
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/regions/{region}/healthSources/{healthSource}/getHealth
Description : Gets the most recent health check results for this regional HealthSource.
Scopes :
Parameter Order :
HTTP Method : GET
▼ ▲ compute.regionHealthSources.aggregatedList
Scopes :
Path : projects/{project}/aggregated/healthSources
Description : Retrieves the list of all HealthSource resources (all regional) available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.
Parameter Order : project
Flat Path : projects/{project}/aggregated/healthSources
HTTP Method : GET
Parameters :
includeAllScopes
Type : boolean
Description : Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
Location : query
filter
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.
Location : query
serviceProjectNumber
Description : The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.
Location : query
Type : string
Format : int64
maxResults
Type : integer
Minimum : 0
Default : 500
Format : uint32
Location : query
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`)
project
Location : path
Type : string
Description : Name of the project scoping 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])?))
Required : Yes
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.
Apiversion : 2026-12-01-preview
▼ ▲ compute.regionHealthSources.testIamPermissions
Apiversion : 2026-12-01-preview
Parameters :
region
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : The name of the region for this request.
Type : string
Location : path
resource
Location : path
Type : string
Description : Name or id of the resource for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
project
Description : Project ID for this request.
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
Path : projects/{project}/regions/{region}/healthSources/{resource}/testIamPermissions
Flat Path : projects/{project}/regions/{region}/healthSources/{resource}/testIamPermissions
Parameter Order :
Description : Returns permissions that a caller has on the specified resource.
HTTP Method : POST
Scopes :
▼ ▲ compute.healthChecks.patch
Flat Path : projects/{project}/global/healthChecks/{healthCheck}
HTTP Method : PATCH
Path : projects/{project}/global/healthChecks/{healthCheck}
Parameter Order :
Parameters :
healthCheck
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Description : Name of the HealthCheck resource to patch.
Type : string
Required : Yes
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
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.
Type : string
Location : path
Apiversion : 2026-12-01-preview
Scopes :
Description : Updates a HealthCheck resource in the specified project using the data included in the request. This method supportsPATCH semantics and uses theJSON merge patch format and processing rules.
▼ ▲ compute.healthChecks.list
Flat Path : projects/{project}/global/healthChecks
HTTP Method : GET
Path : projects/{project}/global/healthChecks
Scopes :
Description : Retrieves the list of HealthCheck resources available to the specified project.
Parameters :
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.
orderBy
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.
Location : query
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.
Type : string
Location : query
project
Type : string
Location : path
Required : Yes
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])?))
maxResults
Format : uint32
Minimum : 0
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
Parameter Order : project
Apiversion : 2026-12-01-preview
▼ ▲ compute.healthChecks.update
Apiversion : 2026-12-01-preview
Parameters :
healthCheck
Type : string
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the HealthCheck resource to update.
Location : path
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).
project
Description : Project ID for this request.
Location : path
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])?))
Flat Path : projects/{project}/global/healthChecks/{healthCheck}
Description : Updates a HealthCheck resource in the specified project using the data included in the request.
Path : projects/{project}/global/healthChecks/{healthCheck}
Parameter Order :
Scopes :
HTTP Method : PUT
▼ ▲ compute.healthChecks.delete
HTTP Method : DELETE
Scopes :
Parameter Order :
Parameters :
project
Description : Project ID for this request.
Location : path
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])?))
healthCheck
Location : path
Type : string
Description : Name of the HealthCheck resource to delete.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
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).
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/global/healthChecks/{healthCheck}
Path : projects/{project}/global/healthChecks/{healthCheck}
Description : Deletes the specified HealthCheck resource.
▼ ▲ compute.healthChecks.aggregatedList
Parameters :
orderBy
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.
Location : query
filter
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.
Location : query
maxResults
Minimum : 0
Type : integer
Default : 500
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`)
Location : query
includeAllScopes
Type : boolean
Location : query
Description : Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
project
Location : path
Description : Name of the project scoping this request.
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])?))
Type : string
serviceProjectNumber
Type : string
Description : The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.
Format : int64
Location : query
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
Description : Retrieves the list of all HealthCheck resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.
Apiversion : 2026-12-01-preview
Parameter Order : project
Scopes :
Flat Path : projects/{project}/aggregated/healthChecks
HTTP Method : GET
Path : projects/{project}/aggregated/healthChecks
▼ ▲ compute.healthChecks.testIamPermissions
Path : projects/{project}/global/healthChecks/{resource}/testIamPermissions
Flat Path : projects/{project}/global/healthChecks/{resource}/testIamPermissions
HTTP Method : POST
Parameter Order :
Scopes :
Parameters :
project
Description : Project ID for this request.
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])?))
Required : Yes
resource
Location : path
Pattern : [a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Description : Name or id of the resource for this request.
Required : Yes
Description : Returns permissions that a caller has on the specified resource.
Apiversion : 2026-12-01-preview
▼ ▲ compute.healthChecks.insert
Description : Creates a HealthCheck resource in the specified project using the data included in the request.
Parameter Order : project
HTTP Method : POST
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])?))
Type : string
Description : Project ID for this request.
Location : path
requestId
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).
Location : query
Flat Path : projects/{project}/global/healthChecks
Scopes :
Apiversion : 2026-12-01-preview
Path : projects/{project}/global/healthChecks
▼ ▲ compute.healthChecks.get
Apiversion : 2026-12-01-preview
Parameters :
project
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])?))
Required : Yes
Type : string
Location : path
healthCheck
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Type : string
Description : Name of the HealthCheck resource to return.
Required : Yes
Flat Path : projects/{project}/global/healthChecks/{healthCheck}
Scopes :
Description : Returns the specified HealthCheck resource.
Parameter Order :
HTTP Method : GET
Path : projects/{project}/global/healthChecks/{healthCheck}
▼ ▲ compute.subnetworks.expandIpCidrRange
Flat Path : projects/{project}/regions/{region}/subnetworks/{subnetwork}/expandIpCidrRange
Path : projects/{project}/regions/{region}/subnetworks/{subnetwork}/expandIpCidrRange
HTTP Method : POST
Scopes :
Apiversion : 2026-12-01-preview
Parameters :
subnetwork
Location : path
Type : string
Required : Yes
Description : Name of the Subnetwork resource to update.
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])?))
Required : Yes
Description : Project ID for this request.
Type : string
Location : path
region
Type : string
Location : path
Description : Name of the region scoping this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
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
Parameter Order :
Description : Expands the IP CIDR range of the subnetwork to a specified value.
▼ ▲ compute.subnetworks.setPrivateIpGoogleAccess
Apiversion : 2026-12-01-preview
Description : Set whether VMs in this subnet can access Google services without assigning external IP addresses through Private Google Access.
Parameters :
requestId
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).
Location : query
subnetwork
Required : Yes
Description : Name of the Subnetwork resource.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Location : path
project
Description : Project ID for this request.
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])?))
Location : path
region
Required : Yes
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Name of the region scoping this request.
Type : string
Flat Path : projects/{project}/regions/{region}/subnetworks/{subnetwork}/setPrivateIpGoogleAccess
Scopes :
Path : projects/{project}/regions/{region}/subnetworks/{subnetwork}/setPrivateIpGoogleAccess
HTTP Method : POST
Parameter Order :
▼ ▲ compute.subnetworks.aggregatedList
Scopes :
Description : Retrieves an aggregated list of subnetworks. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.
Path : projects/{project}/aggregated/subnetworks
Apiversion : 2026-12-01-preview
Parameters :
serviceProjectNumber
Description : The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.
Location : query
Type : string
Format : int64
includeAllScopes
Location : query
Type : boolean
Description : Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
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.
Type : string
Location : query
maxResults
Type : integer
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`)
Minimum : 0
Format : uint32
Location : query
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.
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.
views
Description : Defines the extra views returned back in the subnetwork resource. Supported values: - WITH_UTILIZATION: Utilization data is included in the response.
Enum Descriptions :
Repeated : Yes
Enum :
Location : query
Type : string
project
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])?))
Description : Project ID for this request.
HTTP Method : GET
Parameter Order : project
Flat Path : projects/{project}/aggregated/subnetworks
▼ ▲ compute.subnetworks.patch
Path : projects/{project}/regions/{region}/subnetworks/{subnetwork}
Parameter Order :
Scopes :
Description : Patches the specified subnetwork with the data included in the request. Only certain fields can be updated with a patch request as indicated in the field descriptions. You must specify the current fingerprint of the subnetwork resource being patched.
HTTP Method : PATCH
Parameters :
subnetwork
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the Subnetwork resource to patch.
Type : string
Location : path
Required : Yes
project
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])?))
Description : Project ID for this request.
Required : Yes
Location : path
drainTimeoutSeconds
Location : query
Type : integer
Format : int32
Description : The drain timeout specifies the upper bound in seconds on the amount of time allowed to drain connections from the current ACTIVE subnetwork to the current BACKUP subnetwork. The drain timeout is only applicable when the following conditions are true: - the subnetwork being patched has purpose = INTERNAL_HTTPS_LOAD_BALANCER - the subnetwork being patched has role = BACKUP - the patch request is setting the role to ACTIVE. Note that after this patch operation the roles of the ACTIVE and BACKUP subnetworks will be swapped.
region
Location : path
Description : Name of the region scoping this request.
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
requestId
Location : query
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
Flat Path : projects/{project}/regions/{region}/subnetworks/{subnetwork}
Apiversion : 2026-12-01-preview
▼ ▲ compute.subnetworks.setIamPolicy
Description : Sets the access control policy on the specified resource. Replaces any existing policy.
Scopes :
Apiversion : 2026-12-01-preview
Parameter Order :
Parameters :
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Type : string
Description : The name of the region for this request.
Required : Yes
project
Location : path
Description : Project ID for this request.
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])?))
resource
Type : string
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name or id of the resource for this request.
Location : path
HTTP Method : POST
Flat Path : projects/{project}/regions/{region}/subnetworks/{resource}/setIamPolicy
Path : projects/{project}/regions/{region}/subnetworks/{resource}/setIamPolicy
▼ ▲ compute.subnetworks.getIamPolicy
Description : Gets the access control policy for a resource. May be empty if no such policy or resource exists.
Apiversion : 2026-12-01-preview
Path : projects/{project}/regions/{region}/subnetworks/{resource}/getIamPolicy
Parameters :
region
Required : Yes
Description : The name of the region for this request.
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
project
Required : Yes
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])?))
Location : path
Type : string
optionsRequestedPolicyVersion
Description : Requested IAM Policy version.
Location : query
Type : integer
Format : int32
resource
Required : Yes
Description : Name or id of the resource for this request.
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
HTTP Method : GET
Parameter Order :
Scopes :
Flat Path : projects/{project}/regions/{region}/subnetworks/{resource}/getIamPolicy
▼ ▲ compute.subnetworks.delete
Apiversion : 2026-12-01-preview
Parameters :
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Description : Name of the region scoping this request.
Required : Yes
Type : string
requestId
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).
Location : query
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])?))
subnetwork
Required : Yes
Location : path
Description : Name of the Subnetwork resource to delete.
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Flat Path : projects/{project}/regions/{region}/subnetworks/{subnetwork}
Parameter Order :
Path : projects/{project}/regions/{region}/subnetworks/{subnetwork}
Description : Deletes the specified subnetwork.
HTTP Method : DELETE
Scopes :
▼ ▲ compute.subnetworks.list
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.
Type : string
Location : query
filter
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.
Type : string
maxResults
Format : uint32
Minimum : 0
Location : query
Type : integer
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`)
views
Repeated : Yes
Enum :
Location : query
Type : string
Description : Defines the extra views returned back in the subnetwork resource. Supported values: - WITH_UTILIZATION: Utilization data is included in the response.
Enum Descriptions :
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.
Type : string
Location : query
region
Required : Yes
Type : string
Description : Name of the region scoping this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
project
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])?))
Required : Yes
Type : string
Location : path
Scopes :
Apiversion : 2026-12-01-preview
Description : Retrieves a list of subnetworks available to the specified project.
Flat Path : projects/{project}/regions/{region}/subnetworks
Parameter Order :
HTTP Method : GET
Path : projects/{project}/regions/{region}/subnetworks
▼ ▲ compute.subnetworks.listUsable
Path : projects/{project}/aggregated/subnetworks/listUsable
Description : Retrieves an aggregated list of all usable subnetworks in the project.
Flat Path : projects/{project}/aggregated/subnetworks/listUsable
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`)
Type : integer
Location : query
Default : 500
Minimum : 0
Format : uint32
serviceProject
Description : The project id or project number in which the subnetwork is intended to be used. Only applied for Shared VPC. See [Shared VPC documentation](https://cloud.google.com/vpc/docs/shared-vpc/)
Type : string
Location : query
project
Description : Project ID for this request.
Required : Yes
Location : path
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])?))
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.
Type : string
Location : query
orderBy
Type : string
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.
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
Scopes :
Apiversion : 2026-12-01-preview
Parameter Order : project
HTTP Method : GET
▼ ▲ compute.subnetworks.testIamPermissions
HTTP Method : POST
Description : Returns permissions that a caller has on the specified resource.
Parameter Order :
Parameters :
region
Required : Yes
Description : The name of the region for this request.
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
project
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])?))
Description : Project ID for this request.
resource
Required : Yes
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name or id of the resource for this request.
Location : path
Flat Path : projects/{project}/regions/{region}/subnetworks/{resource}/testIamPermissions
Path : projects/{project}/regions/{region}/subnetworks/{resource}/testIamPermissions
Apiversion : 2026-12-01-preview
Scopes :
▼ ▲ compute.subnetworks.insert
HTTP Method : POST
Description : Creates a subnetwork in the specified project using the data included in the request.
Path : projects/{project}/regions/{region}/subnetworks
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).
Location : query
Type : string
project
Location : path
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])?))
Description : Project ID for this request.
Required : Yes
region
Description : Name of the region scoping this request.
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Location : path
Scopes :
Apiversion : 2026-12-01-preview
Parameter Order :
Flat Path : projects/{project}/regions/{region}/subnetworks
▼ ▲ compute.subnetworks.get
Parameter Order :
HTTP Method : GET
Flat Path : projects/{project}/regions/{region}/subnetworks/{subnetwork}
Path : projects/{project}/regions/{region}/subnetworks/{subnetwork}
Apiversion : 2026-12-01-preview
Description : Returns the specified subnetwork.
Parameters :
views
Enum Descriptions :
Description : Defines the extra views returned back in the subnetwork resource. Supported values: - WITH_UTILIZATION: Utilization data is included in the response.
Location : query
Type : string
Repeated : Yes
Enum :
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
subnetwork
Required : Yes
Type : string
Description : Name of the Subnetwork resource to return.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
region
Type : string
Description : Name of the region scoping this request.
Location : path
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Scopes :
▼ ▲ compute.images.setLabels
Path : projects/{project}/global/images/{resource}/setLabels
Parameter Order :
Scopes :
Flat Path : projects/{project}/global/images/{resource}/setLabels
Description : Sets the labels on an image. To learn more about labels, read theLabeling Resources documentation.
HTTP Method : POST
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])?))
Description : Project ID for this request.
Type : string
Required : Yes
Location : path
resource
Description : Name or id of the resource for this request.
Location : path
Pattern : [a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Type : string
Apiversion : 2026-12-01-preview
▼ ▲ compute.images.getFromFamily
Flat Path : projects/{project}/global/images/family/{family}
Apiversion : 2026-12-01-preview
Parameter Order :
Parameters :
family
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Description : Name of the image family to search for.
Type : string
Required : Yes
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 : The image project that the image belongs to. For example, to get a CentOS image, specify centos-cloud as the image project.
Required : Yes
HTTP Method : GET
Path : projects/{project}/global/images/family/{family}
Scopes :
Description : Returns the latest image that is part of an image family and is not deprecated. For more information on image families, seePublic image families documentation.
▼ ▲ compute.images.patch
Flat Path : projects/{project}/global/images/{image}
Scopes :
Apiversion : 2026-12-01-preview
Description : Patches the specified image with the data included in the request. Only the following fields can be modified: family, description, deprecation status.
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.
image
Location : path
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the image resource to patch.
Required : Yes
requestId
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).
Location : query
HTTP Method : PATCH
Path : projects/{project}/global/images/{image}
Parameter Order :
▼ ▲ compute.images.getIamPolicy
Scopes :
Parameters :
optionsRequestedPolicyVersion
Type : integer
Location : query
Format : int32
Description : Requested IAM Policy version.
project
Type : string
Location : path
Description : Project ID for this request.
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])?))
resource
Description : Name or id of the resource for this request.
Location : path
Required : Yes
Pattern : [a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Apiversion : 2026-12-01-preview
Path : projects/{project}/global/images/{resource}/getIamPolicy
Flat Path : projects/{project}/global/images/{resource}/getIamPolicy
Parameter Order :
HTTP Method : GET
Description : Gets the access control policy for a resource. May be empty if no such policy or resource exists.
▼ ▲ compute.images.list
Parameter Order : project
Parameters :
orderBy
Type : string
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.
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.
Type : string
Location : query
project
Description : Project ID for this request.
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])?))
Location : path
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`)
Minimum : 0
Format : uint32
Default : 500
Location : query
Type : integer
filter
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.
Location : query
Path : projects/{project}/global/images
Apiversion : 2026-12-01-preview
Description : Retrieves the list of custom images available to the specified project. Custom images are images you create that belong to your project. This method does not get any images that belong to other projects, including publicly-available images, like Debian 8. If you want to get a list of publicly-available images, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud.
HTTP Method : GET
Scopes :
Flat Path : projects/{project}/global/images
▼ ▲ compute.images.testIamPermissions
Flat Path : projects/{project}/global/images/{resource}/testIamPermissions
Parameters :
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
resource
Required : Yes
Pattern : [a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name or id of the resource for this request.
Type : string
Location : path
Apiversion : 2026-12-01-preview
Scopes :
Path : projects/{project}/global/images/{resource}/testIamPermissions
HTTP Method : POST
Description : Returns permissions that a caller has on the specified resource.
Parameter Order :
▼ ▲ compute.images.get
Flat Path : projects/{project}/global/images/{image}
Scopes :
Apiversion : 2026-12-01-preview
Parameters :
image
Required : Yes
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the image resource to return.
Location : path
project
Description : Project ID for this request.
Required : Yes
Location : path
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])?))
Path : projects/{project}/global/images/{image}
Parameter Order :
Description : Returns the specified image.
HTTP Method : GET
▼ ▲ compute.images.setIamPolicy
Parameter Order :
Parameters :
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.
resource
Location : path
Required : Yes
Type : string
Description : Name or id of the resource for this request.
Pattern : [a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Apiversion : 2026-12-01-preview
Scopes :
Path : projects/{project}/global/images/{resource}/setIamPolicy
HTTP Method : POST
Flat Path : projects/{project}/global/images/{resource}/setIamPolicy
Description : Sets the access control policy on the specified resource. Replaces any existing policy.
▼ ▲ compute.images.delete
Flat Path : projects/{project}/global/images/{image}
Apiversion : 2026-12-01-preview
Path : projects/{project}/global/images/{image}
Parameters :
project
Required : Yes
Description : Project ID for this request.
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])?))
image
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Description : Name of the image resource to delete.
Type : string
requestId
Location : query
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
Scopes :
HTTP Method : DELETE
Parameter Order :
Description : Deletes the specified image.
▼ ▲ compute.images.insert
Path : projects/{project}/global/images
Description : Creates an image in the specified project using the data included in the request.
HTTP Method : POST
Parameter Order : project
Scopes :
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/global/images
Parameters :
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).
forceCreate
Type : boolean
Description : Force image creation if true.
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])?))
Required : Yes
Type : string
Description : Project ID for this request.
▼ ▲ compute.images.deprecate
Parameter Order :
HTTP Method : POST
Description : Sets the deprecation status of an image. If an empty request body is given, clears the deprecation status instead.
Path : projects/{project}/global/images/{image}/deprecate
Flat Path : projects/{project}/global/images/{image}/deprecate
Parameters :
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).
image
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Image name.
Required : Yes
Location : path
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.
Required : Yes
Location : path
Type : string
Scopes :
Apiversion : 2026-12-01-preview
▼ ▲ compute.addresses.delete
HTTP Method : DELETE
Flat Path : projects/{project}/regions/{region}/addresses/{address}
Apiversion : 2026-12-01-preview
Description : Deletes the specified address resource.
Parameters :
project
Type : string
Required : Yes
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])?))
Location : path
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Required : Yes
Type : string
Description : Name of the region for 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
address
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the address resource to delete.
Location : path
Type : string
Parameter Order :
Scopes :
Path : projects/{project}/regions/{region}/addresses/{address}
▼ ▲ compute.addresses.list
Scopes :
HTTP Method : GET
Apiversion : 2026-12-01-preview
Parameter Order :
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.
Type : string
Location : query
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Type : string
Location : path
Description : Name of the region for this request.
orderBy
Type : string
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.
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])?))
Type : string
Required : Yes
Description : Project ID for this request.
Location : path
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.
maxResults
Location : query
Format : uint32
Default : 500
Type : integer
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`)
Minimum : 0
Path : projects/{project}/regions/{region}/addresses
Flat Path : projects/{project}/regions/{region}/addresses
Description : Retrieves a list of addresses contained within the specified region.
▼ ▲ compute.addresses.setLabels
Parameters :
requestId
Location : query
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
resource
Required : Yes
Type : string
Description : Name or id of the resource for this request.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
project
Type : string
Location : path
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.
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Type : string
Description : The region for this request.
Required : Yes
Parameter Order :
Apiversion : 2026-12-01-preview
Scopes :
HTTP Method : POST
Description : Sets the labels on an Address. To learn more about labels, read theLabeling Resources documentation.
Flat Path : projects/{project}/regions/{region}/addresses/{resource}/setLabels
Path : projects/{project}/regions/{region}/addresses/{resource}/setLabels
▼ ▲ compute.addresses.insert
HTTP Method : POST
Flat Path : projects/{project}/regions/{region}/addresses
Description : Creates an address resource in the specified project by using the data included in the request.
Scopes :
Apiversion : 2026-12-01-preview
Parameter Order :
Path : projects/{project}/regions/{region}/addresses
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
Location : path
Description : Project ID for this request.
Type : string
requestId
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).
Location : query
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Description : Name of the region for this request.
Type : string
Required : Yes
▼ ▲ compute.addresses.get
Parameters :
region
Location : path
Description : Name of the region for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
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])?))
Required : Yes
Type : string
Location : path
Description : Project ID for this request.
address
Description : Name of the address resource to return.
Required : Yes
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Scopes :
Description : Returns the specified address resource.
Apiversion : 2026-12-01-preview
Parameter Order :
HTTP Method : GET
Path : projects/{project}/regions/{region}/addresses/{address}
Flat Path : projects/{project}/regions/{region}/addresses/{address}
▼ ▲ compute.addresses.move
Apiversion : 2026-12-01-preview
Parameter Order :
Scopes :
Parameters :
address
Type : string
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the address resource to move.
Location : path
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
Type : string
Required : Yes
Description : Source project ID which the Address is moved from.
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
region
Description : Name of the region for this request.
Location : path
Type : string
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Path : projects/{project}/regions/{region}/addresses/{address}/move
HTTP Method : POST
Flat Path : projects/{project}/regions/{region}/addresses/{address}/move
Description : Moves the specified address resource.
▼ ▲ compute.addresses.aggregatedList
HTTP Method : GET
Path : projects/{project}/aggregated/addresses
Flat Path : projects/{project}/aggregated/addresses
Parameters :
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.
Type : string
Location : query
filter
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.
Type : string
serviceProjectNumber
Location : query
Format : int64
Type : string
Description : The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.
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
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
Description : Project ID for this request.
Type : string
maxResults
Location : query
Default : 500
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`)
Type : integer
Format : uint32
includeAllScopes
Type : boolean
Description : Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
Location : query
Description : Retrieves an aggregated list of addresses. To prevent failure, it is recommended that you set the `returnPartialSuccess` parameter to `true`.
Scopes :
Apiversion : 2026-12-01-preview
Parameter Order : project
▼ ▲ compute.addresses.testIamPermissions
HTTP Method : POST
Description : Returns permissions that a caller has on the specified resource.
Flat Path : projects/{project}/regions/{region}/addresses/{resource}/testIamPermissions
Parameter Order :
Apiversion : 2026-12-01-preview
Scopes :
Parameters :
project
Location : path
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])?))
Required : Yes
Description : Project ID for this request.
resource
Description : Name or id of the resource for this request.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Type : string
region
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : The name of the region for this request.
Required : Yes
Type : string
Path : projects/{project}/regions/{region}/addresses/{resource}/testIamPermissions
▼ ▲ compute.hosts.getVersion
Path : projects/{project}/zones/{zone}/{association}/hosts/{host}/getVersion
Description : Allows customers to get SBOM versions of a host.
HTTP Method : POST
Parameters :
association
Location : path
Description : The parent resource association for the Host. This field specifies the hierarchical context (e.g., reservation, block, sub-block) when accessing the host.
Type : string
Required : Yes
project
Description : Project ID for this request.
Location : path
Type : string
Required : Yes
requestId
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.
Location : query
zone
Location : path
Description : Name of the zone for this request. Zone name should conform to RFC1035.
Type : string
Required : Yes
host
Required : Yes
Type : string
Description : The name of the host, formatted as RFC1035 or a resource ID number.
Location : path
Flat Path : projects/{project}/zones/{zone}/{association}/hosts/{host}/getVersion
Apiversion : 2026-12-01-preview
Scopes :
Parameter Order :
▼ ▲ compute.hosts.list
HTTP Method : GET
Description : Retrieves a list of hosts.
Path : projects/{project}/zones/{zone}/{association}/hosts
Parameter Order :
Parameters :
zone
Description : The name of the zone for this request, formatted as RFC1035.
Location : path
Required : Yes
Type : string
maxResults
Location : query
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`)
Format : uint32
Default : 500
Minimum : 0
Type : integer
orderBy
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.
Location : query
project
Type : string
Description : The project ID for this request.
Location : path
Required : Yes
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
association
Type : string
Required : Yes
Description : The parent resource association for the Host. This field specifies the hierarchical context (e.g., reservation, block, sub-block) when accessing the host. For example, reservations/reservation_name, reservations/reservation_name/reservationBlocks/reservation_block_name or reservations/reservation_name/reservationBlocks/reservation_block_name/reservationSubBlocks/reservation_sub_block_name.
Location : path
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.
Flat Path : projects/{project}/zones/{zone}/{association}/hosts
Apiversion : 2026-12-01-preview
Scopes :
▼ ▲ compute.hosts.get
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/zones/{zone}/{association}/hosts/{host}
Parameters :
association
Location : path
Description : The parent resource association for the Host. This field specifies the hierarchical context (e.g., reservation, block, sub-block) when accessing the host. For example, reservations/reservation_name, reservations/reservation_name/reservationBlocks/reservation_block_name or reservations/reservation_name/reservationBlocks/reservation_block_name/reservationSubBlocks/reservation_sub_block_name.
Type : string
Required : Yes
host
Required : Yes
Description : The name of the host, formatted as RFC1035 or a resource ID number.
Location : path
Type : string
project
Location : path
Type : string
Required : Yes
Description : The project ID for this request.
zone
Required : Yes
Type : string
Location : path
Description : The name of the zone for this request, formatted as RFC1035.
Parameter Order :
Description : Retrieves information about the specified host.
Path : projects/{project}/zones/{zone}/{association}/hosts/{host}
HTTP Method : GET
Scopes :
▼ ▲ compute.projectViews.get
Description : Returns the specified global ProjectViews resource, with a regional context. This regional API endpoint reads resource metadata from regional read-only replicas. Because changes are copied to these regional replicas asynchronously, for real-time resource reads or any write operations (creating, updating, or deleting resources), use the global [projects.get](https://cloud.google.com/compute/docs/reference/rest/v1/projects/get) endpoint.
HTTP Method : GET
Path : projects/{project}/regions/{region}/projectViews
Scopes :
Parameter Order :
Apiversion : 2026-12-01-preview
Parameters :
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. This is part of the URL path.
Location : path
region
Description : Required. Name of the region for this request. This is part of the URL path.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Type : string
Flat Path : projects/{project}/regions/{region}/projectViews
▼ ▲ compute.regionInstances.bulkInsert
Apiversion : 2026-12-01-preview
Parameter Order :
Parameters :
region
Type : string
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Description : The name of the region for 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
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])?))
Description : Project ID for this request.
Location : path
Flat Path : projects/{project}/regions/{region}/instances/bulkInsert
Description : Creates multiple instances in a given region. Count specifies the number of instances to create.
HTTP Method : POST
Path : projects/{project}/regions/{region}/instances/bulkInsert
Scopes :
▼ ▲ compute.globalAddresses.get
Scopes :
Apiversion : 2026-12-01-preview
Description : Returns the specified address resource.
Parameter Order :
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.
Type : string
Location : path
address
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Type : string
Description : Name of the address resource to return.
HTTP Method : GET
Flat Path : projects/{project}/global/addresses/{address}
Path : projects/{project}/global/addresses/{address}
▼ ▲ compute.globalAddresses.delete
HTTP Method : DELETE
Scopes :
Description : Deletes the specified address resource.
Flat Path : projects/{project}/global/addresses/{address}
Path : projects/{project}/global/addresses/{address}
Parameters :
address
Location : path
Type : string
Description : Name of the address resource to delete.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
requestId
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).
Location : query
project
Type : string
Location : path
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.
Apiversion : 2026-12-01-preview
Parameter Order :
▼ ▲ compute.globalAddresses.move
Description : Moves the specified address resource from one project to another project.
HTTP Method : POST
Path : projects/{project}/global/addresses/{address}/move
Apiversion : 2026-12-01-preview
Parameters :
project
Required : Yes
Type : string
Description : Source project ID which the Address is moved from.
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
requestId
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).
Location : query
address
Description : Name of the address resource to move.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Type : string
Parameter Order :
Scopes :
Flat Path : projects/{project}/global/addresses/{address}/move
▼ ▲ compute.globalAddresses.setLabels
Flat Path : projects/{project}/global/addresses/{resource}/setLabels
Scopes :
Parameter Order :
HTTP Method : POST
Apiversion : 2026-12-01-preview
Parameters :
resource
Type : string
Pattern : [a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name or id of the resource for this request.
Required : Yes
Location : path
project
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])?))
Type : string
Required : Yes
Location : path
Description : Sets the labels on a GlobalAddress. To learn more about labels, read theLabeling Resources documentation.
Path : projects/{project}/global/addresses/{resource}/setLabels
▼ ▲ compute.globalAddresses.testIamPermissions
Path : projects/{project}/global/addresses/{resource}/testIamPermissions
Description : Returns permissions that a caller has on the specified resource.
Parameters :
resource
Type : string
Location : path
Description : Name or id of the resource for this request.
Pattern : [a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
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])?))
Location : path
Description : Project ID for this request.
Type : string
Parameter Order :
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/global/addresses/{resource}/testIamPermissions
HTTP Method : POST
Scopes :
▼ ▲ compute.globalAddresses.insert
Scopes :
Parameter Order : project
Path : projects/{project}/global/addresses
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/global/addresses
Parameters :
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
Type : string
Location : query
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).
HTTP Method : POST
Description : Creates an address resource in the specified project by using the data included in the request.
▼ ▲ compute.globalAddresses.list
Scopes :
Flat Path : projects/{project}/global/addresses
HTTP Method : GET
Path : projects/{project}/global/addresses
Description : Retrieves a list of global addresses.
Parameter Order : project
Parameters :
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.
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
Type : string
Location : path
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])?))
Required : Yes
maxResults
Format : uint32
Minimum : 0
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
Location : query
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
Apiversion : 2026-12-01-preview
▼ ▲ compute.routes.delete
Path : projects/{project}/global/routes/{route}
Parameters :
route
Required : Yes
Type : string
Location : path
Description : Name of the Route resource to delete.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
project
Description : Project ID for this request.
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])?))
Required : Yes
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).
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/global/routes/{route}
Scopes :
Description : Deletes the specified Route resource.
Parameter Order :
HTTP Method : DELETE
▼ ▲ compute.routes.list
Flat Path : projects/{project}/global/routes
HTTP Method : GET
Apiversion : 2026-12-01-preview
Parameters :
maxResults
Location : query
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`)
Type : integer
Default : 500
Minimum : 0
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.
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.
Type : string
Location : query
project
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])?))
Description : Project ID for this request.
Location : path
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.
Type : string
Location : query
Scopes :
Description : Retrieves the list of Route resources available to the specified project.
Path : projects/{project}/global/routes
Parameter Order : project
▼ ▲ compute.routes.get
Parameter Order :
Path : projects/{project}/global/routes/{route}
HTTP Method : GET
Parameters :
route
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Type : string
Description : Name of the Route resource to return.
Required : Yes
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
Type : string
Description : Project ID for this request.
Required : Yes
Scopes :
Apiversion : 2026-12-01-preview
Description : Returns the specified Route resource.
Flat Path : projects/{project}/global/routes/{route}
▼ ▲ compute.routes.insert
Scopes :
HTTP Method : POST
Description : Creates a Route resource in the specified project using the data included in the request.
Path : projects/{project}/global/routes
Apiversion : 2026-12-01-preview
Parameter Order : project
Parameters :
project
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])?))
Description : Project ID for this request.
Location : path
Required : Yes
requestId
Type : string
Location : query
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).
Flat Path : projects/{project}/global/routes
▼ ▲ compute.routes.testIamPermissions
Path : projects/{project}/global/routes/{resource}/testIamPermissions
Description : Returns permissions that a caller has on the specified resource.
Parameters :
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
resource
Location : path
Required : Yes
Description : Name or id of the resource for this request.
Type : string
Pattern : [a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Apiversion : 2026-12-01-preview
Scopes :
Flat Path : projects/{project}/global/routes/{resource}/testIamPermissions
Parameter Order :
HTTP Method : POST
▼ ▲ compute.publicDelegatedPrefixes.aggregatedList
Parameters :
project
Description : Name of the project scoping 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])?))
Required : Yes
Location : path
Type : string
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.
Type : string
Location : query
includeAllScopes
Location : query
Description : Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
Type : boolean
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
maxResults
Format : uint32
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
Location : query
Type : integer
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
serviceProjectNumber
Description : The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.
Format : int64
Type : string
Location : query
Apiversion : 2026-12-01-preview
Description : Lists all PublicDelegatedPrefix resources owned by the specific project across all scopes. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.
HTTP Method : GET
Scopes :
Parameter Order : project
Path : projects/{project}/aggregated/publicDelegatedPrefixes
Flat Path : projects/{project}/aggregated/publicDelegatedPrefixes
▼ ▲ compute.publicDelegatedPrefixes.delete
Path : projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix}
Parameter Order :
HTTP Method : DELETE
Parameters :
project
Location : path
Description : Project ID for this request.
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])?))
Required : Yes
region
Description : Name of the region of this request.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
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).
Type : string
Location : query
publicDelegatedPrefix
Location : path
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Description : Name of the PublicDelegatedPrefix resource to delete.
Flat Path : projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix}
Description : Deletes the specified PublicDelegatedPrefix in the given region.
Apiversion : 2026-12-01-preview
Scopes :
▼ ▲ compute.publicDelegatedPrefixes.get
Parameter Order :
Flat Path : projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix}
HTTP Method : GET
Description : Returns the specified PublicDelegatedPrefix resource in the given region.
Path : projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix}
Apiversion : 2026-12-01-preview
Parameters :
project
Location : path
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])?))
Required : Yes
publicDelegatedPrefix
Required : Yes
Type : string
Description : Name of the PublicDelegatedPrefix resource to return.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
region
Type : string
Description : Name of the region of this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Location : path
Scopes :
▼ ▲ compute.publicDelegatedPrefixes.withdraw
HTTP Method : POST
Flat Path : projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix}/withdraw
Scopes :
Path : projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix}/withdraw
Description : Withdraws the specified PublicDelegatedPrefix in the given region.
Parameter Order :
Apiversion : 2026-12-01-preview
Parameters :
project
Type : string
Required : Yes
Location : path
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])?))
requestId
Location : query
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
region
Location : path
Description : The name of theregion where the public delegated prefix is located. It should comply with RFC1035.
Type : string
Required : Yes
publicDelegatedPrefix
Required : Yes
Type : string
Location : path
Description : The name of the public delegated prefix. It should comply with RFC1035.
▼ ▲ compute.publicDelegatedPrefixes.insert
Flat Path : projects/{project}/regions/{region}/publicDelegatedPrefixes
Apiversion : 2026-12-01-preview
Description : Creates a PublicDelegatedPrefix in the specified project in the given region using the parameters that are included in the request.
Parameters :
region
Type : string
Required : Yes
Description : Name of the region of this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
requestId
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).
Location : query
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
Type : string
Required : Yes
Description : Project ID for this request.
Path : projects/{project}/regions/{region}/publicDelegatedPrefixes
HTTP Method : POST
Parameter Order :
Scopes :
▼ ▲ compute.publicDelegatedPrefixes.list
HTTP Method : GET
Flat Path : projects/{project}/regions/{region}/publicDelegatedPrefixes
Path : projects/{project}/regions/{region}/publicDelegatedPrefixes
Scopes :
Apiversion : 2026-12-01-preview
Description : Lists the PublicDelegatedPrefixes for a project in the given region.
Parameters :
filter
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.
Location : query
maxResults
Format : uint32
Default : 500
Minimum : 0
Type : integer
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`)
Location : query
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
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.
region
Location : path
Description : Name of the region of this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Required : Yes
project
Required : Yes
Description : Project ID for this request.
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])?))
Parameter Order :
▼ ▲ compute.publicDelegatedPrefixes.announce
Flat Path : projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix}/announce
Parameter Order :
Path : projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix}/announce
Apiversion : 2026-12-01-preview
Parameters :
project
Description : Project ID for this request.
Location : path
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])?))
Type : string
publicDelegatedPrefix
Type : string
Description : The name of the public delegated prefix. It should comply with RFC1035.
Required : Yes
Location : path
region
Description : The name of theregion where the public delegated prefix is located. It should comply with RFC1035.
Required : Yes
Type : string
Location : path
requestId
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).
Location : query
HTTP Method : POST
Description : Announces the specified PublicDelegatedPrefix in the given region.
Scopes :
▼ ▲ compute.publicDelegatedPrefixes.patch
Scopes :
HTTP Method : PATCH
Flat Path : projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix}
Description : Patches the specified PublicDelegatedPrefix resource with the data included in the request. This method supportsPATCH semantics and usesJSON merge patch format and processing rules.
Parameter Order :
Path : projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix}
Apiversion : 2026-12-01-preview
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).
Location : query
Type : string
publicDelegatedPrefix
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Description : Name of the PublicDelegatedPrefix resource to patch.
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
Description : Project ID for this request.
Type : string
Location : path
region
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Description : Name of the region for this request.
Required : Yes
▼ ▲ compute.licenses.getIamPolicy
Flat Path : projects/{project}/global/licenses/{resource}/getIamPolicy
Parameters :
optionsRequestedPolicyVersion
Description : Requested IAM Policy version.
Format : int32
Location : query
Type : integer
project
Required : Yes
Type : string
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])?))
resource
Required : Yes
Location : path
Description : Name or id of the resource for this request.
Type : string
Pattern : [a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Gets the access control policy for a resource. May be empty if no such policy or resource exists. *Caution* This resource is intended for use only by third-party partners who are creatingCloud Marketplace images.
Parameter Order :
Apiversion : 2026-12-01-preview
Scopes :
Path : projects/{project}/global/licenses/{resource}/getIamPolicy
HTTP Method : GET
▼ ▲ compute.licenses.update
Parameter Order :
Description : Updates a License resource in the specified project. *Caution* This resource is intended for use only by third-party partners who are creatingCloud Marketplace images.
Path : projects/{project}/global/licenses/{license}
HTTP Method : PATCH
Parameters :
updateMask
Format : google-fieldmask
Location : query
Type : string
Description : update_mask indicates fields to be updated as part of this request.
license
Description : The license name for this request.
Location : path
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
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
Location : path
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])?))
Required : Yes
Type : string
Flat Path : projects/{project}/global/licenses/{license}
Apiversion : 2026-12-01-preview
Scopes :
▼ ▲ compute.licenses.get
Apiversion : 2026-12-01-preview
Parameters :
project
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])?))
Description : Project ID for this request.
Required : Yes
license
Type : string
Location : path
Description : Name of the License resource to return.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Flat Path : projects/{project}/global/licenses/{license}
Scopes :
Path : projects/{project}/global/licenses/{license}
Parameter Order :
HTTP Method : GET
Description : Returns the specified License resource. *Caution* This resource is intended for use only by third-party partners who are creatingCloud Marketplace images.
▼ ▲ compute.licenses.list
Path : projects/{project}/global/licenses
Parameters :
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
filter
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.
Type : string
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.
Type : string
Location : query
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])?))
Type : string
Description : Project ID for this request.
Required : Yes
Location : path
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`)
Format : uint32
Default : 500
Location : query
Minimum : 0
Type : integer
Apiversion : 2026-12-01-preview
Parameter Order : project
Flat Path : projects/{project}/global/licenses
HTTP Method : GET
Description : Retrieves the list of licenses available in the specified project. This method does not get any licenses that belong to other projects, including licenses attached to publicly-available images, like Debian 9. If you want to get a list of publicly-available licenses, use this method to make a request to the respective image project, such as debian-cloud orwindows-cloud. *Caution* This resource is intended for use only by third-party partners who are creatingCloud Marketplace images.
Scopes :
▼ ▲ compute.licenses.delete
Scopes :
HTTP Method : DELETE
Parameters :
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).
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.
Type : string
Location : path
license
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Description : Name of the license resource to delete.
Required : Yes
Apiversion : 2026-12-01-preview
Description : Deletes the specified license. *Caution* This resource is intended for use only by third-party partners who are creatingCloud Marketplace images.
Flat Path : projects/{project}/global/licenses/{license}
Path : projects/{project}/global/licenses/{license}
Parameter Order :
▼ ▲ compute.licenses.testIamPermissions
Path : projects/{project}/global/licenses/{resource}/testIamPermissions
HTTP Method : POST
Flat Path : projects/{project}/global/licenses/{resource}/testIamPermissions
Apiversion : 2026-12-01-preview
Parameters :
project
Required : Yes
Type : string
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])?))
resource
Required : Yes
Description : Name or id of the resource for this request.
Pattern : [a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Location : path
Description : Returns permissions that a caller has on the specified resource. *Caution* This resource is intended for use only by third-party partners who are creatingCloud Marketplace images.
Scopes :
Parameter Order :
▼ ▲ compute.licenses.insert
Scopes :
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).
Location : query
Type : string
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])?))
Description : Project ID for this request.
Required : Yes
Type : string
Flat Path : projects/{project}/global/licenses
Apiversion : 2026-12-01-preview
Path : projects/{project}/global/licenses
Description : Create a License resource in the specified project. *Caution* This resource is intended for use only by third-party partners who are creatingCloud Marketplace images.
Parameter Order : project
HTTP Method : POST
▼ ▲ compute.licenses.setIamPolicy
HTTP Method : POST
Scopes :
Path : projects/{project}/global/licenses/{resource}/setIamPolicy
Flat Path : projects/{project}/global/licenses/{resource}/setIamPolicy
Description : Sets the access control policy on the specified resource. Replaces any existing policy. *Caution* This resource is intended for use only by third-party partners who are creatingCloud Marketplace images.
Parameters :
project
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])?))
Description : Project ID for this request.
Required : Yes
resource
Pattern : [a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Type : string
Location : path
Description : Name or id of the resource for this request.
Parameter Order :
Apiversion : 2026-12-01-preview
▼ ▲ compute.resourcePolicies.setIamPolicy
Description : Sets the access control policy on the specified resource. Replaces any existing policy.
Path : projects/{project}/regions/{region}/resourcePolicies/{resource}/setIamPolicy
Flat Path : projects/{project}/regions/{region}/resourcePolicies/{resource}/setIamPolicy
Apiversion : 2026-12-01-preview
Parameters :
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Location : path
Type : string
Description : The name of the region for 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])?))
Location : path
Description : Project ID for this request.
Type : string
Required : Yes
resource
Required : Yes
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Description : Name or id of the resource for this request.
Scopes :
HTTP Method : POST
Parameter Order :
▼ ▲ compute.resourcePolicies.aggregatedList
Apiversion : 2026-12-01-preview
Parameters :
includeAllScopes
Description : Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
Type : boolean
Location : query
serviceProjectNumber
Location : query
Format : int64
Type : string
Description : The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.
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.
Type : string
Location : query
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])?))
Location : path
Description : Project ID for this request.
Type : string
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.
Location : query
Type : string
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
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`)
Format : uint32
Location : query
Minimum : 0
Default : 500
Type : integer
Scopes :
Parameter Order : project
Flat Path : projects/{project}/aggregated/resourcePolicies
Description : Retrieves an aggregated list of resource policies. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.
HTTP Method : GET
Path : projects/{project}/aggregated/resourcePolicies
▼ ▲ compute.resourcePolicies.list
Scopes :
Path : projects/{project}/regions/{region}/resourcePolicies
Parameters :
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.
orderBy
Type : string
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.
filter
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.
Type : string
project
Description : Project ID for this request.
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])?))
Location : path
maxResults
Format : uint32
Location : query
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`)
Minimum : 0
Default : 500
Type : integer
region
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Location : path
Description : Name of the region for this request.
Description : A list all the resource policies that have been configured for the specified project in specified region.
Apiversion : 2026-12-01-preview
Parameter Order :
Flat Path : projects/{project}/regions/{region}/resourcePolicies
HTTP Method : GET
▼ ▲ compute.resourcePolicies.insert
Scopes :
HTTP Method : POST
Description : Creates a new resource policy.
Path : projects/{project}/regions/{region}/resourcePolicies
Apiversion : 2026-12-01-preview
Parameters :
region
Required : Yes
Description : Name of the region for this request.
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
project
Location : path
Required : Yes
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])?))
Type : string
requestId
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).
Location : query
Flat Path : projects/{project}/regions/{region}/resourcePolicies
Parameter Order :
▼ ▲ compute.resourcePolicies.testIamPermissions
Apiversion : 2026-12-01-preview
Parameters :
region
Location : path
Type : string
Description : The name of the region for this request.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
resource
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Location : path
Description : Name or id of the resource for this request.
Required : Yes
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
Flat Path : projects/{project}/regions/{region}/resourcePolicies/{resource}/testIamPermissions
Parameter Order :
Description : Returns permissions that a caller has on the specified resource.
HTTP Method : POST
Path : projects/{project}/regions/{region}/resourcePolicies/{resource}/testIamPermissions
Scopes :
▼ ▲ compute.resourcePolicies.patch
Path : projects/{project}/regions/{region}/resourcePolicies/{resourcePolicy}
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/regions/{region}/resourcePolicies/{resourcePolicy}
Parameters :
updateMask
Format : google-fieldmask
Description : update_mask indicates fields to be updated as part of this request.
Type : string
Location : query
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
resourcePolicy
Location : path
Required : Yes
Type : string
Description : Id of the resource policy to patch.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
region
Type : string
Location : path
Description : Name of the region for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
project
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])?))
Location : path
Required : Yes
HTTP Method : PATCH
Scopes :
Description : Modify the specified resource policy.
Parameter Order :
▼ ▲ compute.resourcePolicies.get
Parameters :
resourcePolicy
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the resource policy to retrieve.
Type : string
Required : Yes
project
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])?))
Location : path
Description : Project ID for this request.
region
Type : string
Location : path
Description : Name of the region for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Flat Path : projects/{project}/regions/{region}/resourcePolicies/{resourcePolicy}
Apiversion : 2026-12-01-preview
Parameter Order :
Path : projects/{project}/regions/{region}/resourcePolicies/{resourcePolicy}
Scopes :
Description : Retrieves all information of the specified resource policy.
HTTP Method : GET
▼ ▲ compute.resourcePolicies.getIamPolicy
Apiversion : 2026-12-01-preview
Parameters :
project
Type : string
Location : path
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])?))
Required : Yes
region
Required : Yes
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : The name of the region for this request.
resource
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Description : Name or id of the resource for this request.
Location : path
Required : Yes
optionsRequestedPolicyVersion
Type : integer
Location : query
Format : int32
Description : Requested IAM Policy version.
Scopes :
Flat Path : projects/{project}/regions/{region}/resourcePolicies/{resource}/getIamPolicy
HTTP Method : GET
Path : projects/{project}/regions/{region}/resourcePolicies/{resource}/getIamPolicy
Description : Gets the access control policy for a resource. May be empty if no such policy or resource exists.
Parameter Order :
▼ ▲ compute.resourcePolicies.delete
Scopes :
Description : Deletes the specified resource policy.
HTTP Method : DELETE
Path : projects/{project}/regions/{region}/resourcePolicies/{resourcePolicy}
Apiversion : 2026-12-01-preview
Parameter Order :
Flat Path : projects/{project}/regions/{region}/resourcePolicies/{resourcePolicy}
Parameters :
region
Description : Name of the region for this request.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Location : path
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
resourcePolicy
Required : Yes
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the resource policy to delete.
Location : path
▼ ▲ compute.machineTypes.aggregatedList
Scopes :
Path : projects/{project}/aggregated/machineTypes
HTTP Method : GET
Description : Retrieves an aggregated list of machine types. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.
Parameter Order : project
Parameters :
maxResults
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`)
Location : query
Default : 500
Minimum : 0
Type : integer
includeAllScopes
Description : Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
Location : query
Type : boolean
orderBy
Type : string
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.
serviceProjectNumber
Type : string
Location : query
Format : int64
Description : The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.
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])?))
Description : Project ID for this request.
Type : string
Required : Yes
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.
Location : query
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
Flat Path : projects/{project}/aggregated/machineTypes
Apiversion : 2026-12-01-preview
▼ ▲ compute.machineTypes.list
Path : projects/{project}/zones/{zone}/machineTypes
HTTP Method : GET
Scopes :
Flat Path : projects/{project}/zones/{zone}/machineTypes
Description : Retrieves a list of machine types available to the specified project.
Apiversion : 2026-12-01-preview
Parameter Order :
Parameters :
zone
Location : path
Type : string
Description : The name of the zone for this request.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
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
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`)
Location : query
Type : integer
Format : uint32
Minimum : 0
Default : 500
project
Required : Yes
Description : Project ID for this request.
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
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.
Location : query
Type : string
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.
▼ ▲ compute.machineTypes.get
Flat Path : projects/{project}/zones/{zone}/machineTypes/{machineType}
HTTP Method : GET
Path : projects/{project}/zones/{zone}/machineTypes/{machineType}
Scopes :
Apiversion : 2026-12-01-preview
Parameters :
machineType
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Description : Name of the machine type to return.
Type : string
Required : Yes
zone
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : The name of the zone for this request.
Required : Yes
Location : path
Type : string
project
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])?))
Location : path
Type : string
Required : Yes
Description : Returns the specified machine type.
Parameter Order :
▼ ▲ compute.targetHttpProxies.setUrlMap
HTTP Method : POST
Scopes :
Description : Changes the URL map for TargetHttpProxy.
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/targetHttpProxies/{targetHttpProxy}/setUrlMap
Parameters :
project
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])?))
Description : Project ID for this request.
targetHttpProxy
Required : Yes
Description : Name of the TargetHttpProxy to set a URL map for.
Location : path
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
requestId
Type : string
Location : query
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 :
Path : projects/{project}/targetHttpProxies/{targetHttpProxy}/setUrlMap
▼ ▲ compute.targetHttpProxies.aggregatedList
Description : Retrieves the list of all TargetHttpProxy resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.
Parameter Order : project
Apiversion : 2026-12-01-preview
Parameters :
includeAllScopes
Description : Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
Location : query
Type : boolean
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
serviceProjectNumber
Format : int64
Type : string
Description : The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.
Location : query
maxResults
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`)
Minimum : 0
Default : 500
Location : query
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
project
Location : path
Type : string
Description : Name of the project scoping 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])?))
Required : Yes
orderBy
Type : string
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.
HTTP Method : GET
Flat Path : projects/{project}/aggregated/targetHttpProxies
Scopes :
Path : projects/{project}/aggregated/targetHttpProxies
▼ ▲ compute.targetHttpProxies.delete
Flat Path : projects/{project}/global/targetHttpProxies/{targetHttpProxy}
HTTP Method : DELETE
Scopes :
Description : Deletes the specified TargetHttpProxy resource.
Path : projects/{project}/global/targetHttpProxies/{targetHttpProxy}
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])?))
Description : Project ID for this request.
Type : string
Required : Yes
Location : path
targetHttpProxy
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Description : Name of the TargetHttpProxy resource to delete.
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
Apiversion : 2026-12-01-preview
▼ ▲ compute.targetHttpProxies.get
Path : projects/{project}/global/targetHttpProxies/{targetHttpProxy}
Parameter Order :
Scopes :
Flat Path : projects/{project}/global/targetHttpProxies/{targetHttpProxy}
Apiversion : 2026-12-01-preview
Parameters :
project
Description : Project ID for this request.
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])?))
Location : path
targetHttpProxy
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Location : path
Description : Name of the TargetHttpProxy resource to return.
HTTP Method : GET
Description : Returns the specified TargetHttpProxy resource.
▼ ▲ compute.targetHttpProxies.list
Description : Retrieves the list of TargetHttpProxy resources available to the specified project.
Path : projects/{project}/global/targetHttpProxies
Scopes :
Parameters :
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.
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.
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
maxResults
Location : query
Type : integer
Default : 500
Minimum : 0
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`)
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.
Type : string
Location : query
Apiversion : 2026-12-01-preview
HTTP Method : GET
Parameter Order : project
Flat Path : projects/{project}/global/targetHttpProxies
▼ ▲ compute.targetHttpProxies.patch
HTTP Method : PATCH
Description : Patches the specified TargetHttpProxy resource with the data included in the request. This method supports PATCH semantics and usesJSON merge patch format and processing rules.
Path : projects/{project}/global/targetHttpProxies/{targetHttpProxy}
Flat Path : projects/{project}/global/targetHttpProxies/{targetHttpProxy}
Apiversion : 2026-12-01-preview
Parameters :
requestId
Type : string
Location : query
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).
project
Location : path
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 : Project ID for this request.
targetHttpProxy
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Description : Name of the TargetHttpProxy resource to patch.
Scopes :
Parameter Order :
▼ ▲ compute.targetHttpProxies.insert
Apiversion : 2026-12-01-preview
Parameter Order : project
Path : projects/{project}/global/targetHttpProxies
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
project
Required : Yes
Type : string
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])?))
Flat Path : projects/{project}/global/targetHttpProxies
Description : Creates a TargetHttpProxy resource in the specified project using the data included in the request.
Scopes :
HTTP Method : POST
▼ ▲ compute.regionTargetHttpProxies.list
Parameters :
region
Type : string
Location : path
Description : Name of the region scoping this request.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
pageToken
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.
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.
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])?))
maxResults
Location : query
Format : uint32
Default : 500
Minimum : 0
Type : integer
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
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
Scopes :
Apiversion : 2026-12-01-preview
Parameter Order :
Description : Retrieves the list of TargetHttpProxy resources available to the specified project in the specified region.
Flat Path : projects/{project}/regions/{region}/targetHttpProxies
Path : projects/{project}/regions/{region}/targetHttpProxies
HTTP Method : GET
▼ ▲ compute.regionTargetHttpProxies.setUrlMap
Path : projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}/setUrlMap
Scopes :
HTTP Method : POST
Apiversion : 2026-12-01-preview
Description : Changes the URL map for TargetHttpProxy.
Parameters :
requestId
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).
Location : query
targetHttpProxy
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Location : path
Description : Name of the TargetHttpProxy to set a URL map for.
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])?))
Type : string
Location : path
Description : Project ID for this request.
Required : Yes
region
Description : Name of the region scoping this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Required : Yes
Location : path
Flat Path : projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}/setUrlMap
Parameter Order :
▼ ▲ compute.regionTargetHttpProxies.insert
Scopes :
Path : projects/{project}/regions/{region}/targetHttpProxies
Parameter Order :
Parameters :
project
Type : string
Required : Yes
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])?))
region
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Description : Name of the region scoping this request.
Required : Yes
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).
Apiversion : 2026-12-01-preview
HTTP Method : POST
Flat Path : projects/{project}/regions/{region}/targetHttpProxies
Description : Creates a TargetHttpProxy resource in the specified project and region using the data included in the request.
▼ ▲ compute.regionTargetHttpProxies.get
Description : Returns the specified TargetHttpProxy resource in the specified region.
Flat Path : projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}
Apiversion : 2026-12-01-preview
Parameter Order :
Parameters :
region
Required : Yes
Type : string
Description : Name of the region scoping this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
project
Required : Yes
Description : Project ID for this request.
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])?))
Location : path
targetHttpProxy
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Description : Name of the TargetHttpProxy resource to return.
Location : path
Type : string
HTTP Method : GET
Scopes :
Path : projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}
▼ ▲ compute.regionTargetHttpProxies.delete
Apiversion : 2026-12-01-preview
Parameters :
requestId
Location : query
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
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Description : Name of the region scoping this request.
Type : string
Required : Yes
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 : Project ID for this request.
Location : path
targetHttpProxy
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Description : Name of the TargetHttpProxy resource to delete.
Type : string
Location : path
Path : projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}
Flat Path : projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}
Parameter Order :
Description : Deletes the specified TargetHttpProxy resource.
HTTP Method : DELETE
Scopes :
▼ ▲ compute.regionDisks.createSnapshot
Parameter Order :
Path : projects/{project}/regions/{region}/disks/{disk}/createSnapshot
HTTP Method : POST
Flat Path : projects/{project}/regions/{region}/disks/{disk}/createSnapshot
Description : Creates a snapshot of a specified persistent disk. For regular snapshot creation, consider using snapshots.insert instead, as that method supports more features, such as creating snapshots in a project different from the source disk project.
Scopes :
Parameters :
disk
Description : Name of the regional persistent disk to snapshot.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
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])?))
Location : path
Type : string
Description : Project ID for this request.
Required : Yes
requestId
Type : string
Location : query
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).
region
Required : Yes
Description : Name of the region for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Location : path
Apiversion : 2026-12-01-preview
▼ ▲ compute.regionDisks.stopGroupAsyncReplication
Apiversion : 2026-12-01-preview
Parameter Order :
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).
Location : query
Type : string
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])?))
Type : string
Required : Yes
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Description : The name of the region for this request. This must be the region of the primary or secondary disks in the consistency group.
Type : string
Required : Yes
HTTP Method : POST
Scopes :
Path : projects/{project}/regions/{region}/disks/stopGroupAsyncReplication
Flat Path : projects/{project}/regions/{region}/disks/stopGroupAsyncReplication
Description : Stops asynchronous replication for a consistency group of disks. Can be invoked either in the primary or secondary scope.
▼ ▲ compute.regionDisks.get
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.
region
Location : path
Type : string
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Name of the region for this request.
disk
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the regional persistent disk to return.
Type : string
Location : path
Description : Returns a specified regional persistent disk.
Apiversion : 2026-12-01-preview
Parameter Order :
Scopes :
Flat Path : projects/{project}/regions/{region}/disks/{disk}
Path : projects/{project}/regions/{region}/disks/{disk}
HTTP Method : GET
▼ ▲ compute.regionDisks.startAsyncReplication
Path : projects/{project}/regions/{region}/disks/{disk}/startAsyncReplication
Parameters :
disk
Description : The name of the persistent disk.
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Required : Yes
project
Description : Project ID for this request.
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])?))
Location : path
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).
region
Required : Yes
Type : string
Description : The name of the region for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Description : Starts asynchronous replication. Must be invoked on the primary disk.
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/regions/{region}/disks/{disk}/startAsyncReplication
Parameter Order :
Scopes :
HTTP Method : POST
▼ ▲ compute.regionDisks.list
Scopes :
Path : projects/{project}/regions/{region}/disks
HTTP Method : GET
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])?))
Location : path
Type : string
Description : Project ID for this request.
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.
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Description : Name of the region for this request.
Type : string
Required : Yes
maxResults
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`)
Default : 500
Minimum : 0
Location : query
Type : integer
orderBy
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.
Location : query
filter
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.
Type : string
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/regions/{region}/disks
Description : Retrieves the list of persistent disks contained within the specified region.
Parameter Order :
▼ ▲ compute.regionDisks.removeResourcePolicies
Parameter Order :
HTTP Method : POST
Apiversion : 2026-12-01-preview
Scopes :
Path : projects/{project}/regions/{region}/disks/{disk}/removeResourcePolicies
Parameters :
disk
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Required : Yes
Description : The disk name for this request.
Location : path
requestId
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).
Location : query
region
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : The name of the region for this request.
Type : string
Required : Yes
project
Type : string
Location : path
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.
Flat Path : projects/{project}/regions/{region}/disks/{disk}/removeResourcePolicies
Description : Removes resource policies from a regional disk.
▼ ▲ compute.regionDisks.bulkInsert
Description : Bulk create a set of disks.
Parameter Order :
Apiversion : 2026-12-01-preview
Path : projects/{project}/regions/{region}/disks/bulkInsert
Scopes :
Parameters :
region
Description : The name of the region for this request.
Location : path
Required : Yes
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
project
Location : path
Type : string
Required : Yes
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])?))
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
HTTP Method : POST
Flat Path : projects/{project}/regions/{region}/disks/bulkInsert
▼ ▲ compute.regionDisks.updateKmsKey
Parameters :
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 : Project ID for this request.
Location : path
region
Location : path
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : The name of the region for this request.
Required : Yes
disk
Type : string
Required : Yes
Description : Name of the Disk resource, should conform to RFC1035.
Location : path
requestId
Location : query
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
Description : Rotates the customer-managed encryption key to the latest version for the specified persistent disk.
Scopes :
Path : projects/{project}/regions/{region}/disks/{disk}/updateKmsKey
Apiversion : 2026-12-01-preview
Parameter Order :
Flat Path : projects/{project}/regions/{region}/disks/{disk}/updateKmsKey
HTTP Method : POST
▼ ▲ compute.regionDisks.update
Description : Update the specified disk with the data included in the request. Update is performed only on selected fields included as part of update-mask.
Parameter Order :
Apiversion : 2026-12-01-preview
Parameters :
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : The name of the region for this request.
Required : Yes
Type : string
Location : path
paths
Location : query
Repeated : Yes
Type : string
updateMask
Type : string
Description : update_mask indicates fields to be updated as part of this request.
Format : google-fieldmask
Location : query
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])?))
Type : string
Required : Yes
Location : path
Description : Project ID for this request.
requestId
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).
Location : query
disk
Location : path
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Description : The disk name for this request.
HTTP Method : PATCH
Scopes :
Path : projects/{project}/regions/{region}/disks/{disk}
Flat Path : projects/{project}/regions/{region}/disks/{disk}
▼ ▲ compute.regionDisks.testIamPermissions
Parameters :
region
Type : string
Description : The name of the region for this request.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
project
Description : Project ID for this request.
Type : string
Location : path
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])?))
resource
Description : Name or id of the resource for this request.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Type : string
Apiversion : 2026-12-01-preview
Description : Returns permissions that a caller has on the specified resource.
Parameter Order :
Flat Path : projects/{project}/regions/{region}/disks/{resource}/testIamPermissions
Path : projects/{project}/regions/{region}/disks/{resource}/testIamPermissions
HTTP Method : POST
Scopes :
▼ ▲ compute.regionDisks.resize
Parameter Order :
HTTP Method : POST
Flat Path : projects/{project}/regions/{region}/disks/{disk}/resize
Scopes :
Description : Resizes the specified regional persistent disk.
Parameters :
disk
Description : Name of the regional persistent disk.
Required : Yes
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
requestId
Location : query
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
project
Required : Yes
Description : The project ID for this request.
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])?))
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Type : string
Description : Name of the region for this request.
Required : Yes
Apiversion : 2026-12-01-preview
Path : projects/{project}/regions/{region}/disks/{disk}/resize
▼ ▲ compute.regionDisks.getIamPolicy
Path : projects/{project}/regions/{region}/disks/{resource}/getIamPolicy
HTTP Method : GET
Flat Path : projects/{project}/regions/{region}/disks/{resource}/getIamPolicy
Scopes :
Parameter Order :
Apiversion : 2026-12-01-preview
Description : Gets the access control policy for a resource. May be empty if no such policy or resource exists.
Parameters :
resource
Required : Yes
Description : Name or id of the resource for this request.
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
region
Location : path
Required : Yes
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : The name of the region for this request.
project
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])?))
Location : path
Required : Yes
Description : Project ID for this request.
optionsRequestedPolicyVersion
Location : query
Type : integer
Format : int32
Description : Requested IAM Policy version.
▼ ▲ compute.regionDisks.setLabels
HTTP Method : POST
Flat Path : projects/{project}/regions/{region}/disks/{resource}/setLabels
Scopes :
Parameter Order :
Description : Sets the labels on the target regional disk.
Path : projects/{project}/regions/{region}/disks/{resource}/setLabels
Apiversion : 2026-12-01-preview
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
Type : string
Description : Project ID for this request.
Required : Yes
region
Description : The region for this request.
Required : Yes
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
resource
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 resource for this request.
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).
Type : string
Location : query
▼ ▲ compute.regionDisks.stopAsyncReplication
Scopes :
Description : Stops asynchronous replication. Can be invoked either on the primary or on the secondary disk.
Flat Path : projects/{project}/regions/{region}/disks/{disk}/stopAsyncReplication
HTTP Method : POST
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
Description : Project ID for this request.
Location : path
region
Required : Yes
Description : The name of the region for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
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
disk
Location : path
Description : The name of the persistent disk.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Required : Yes
Path : projects/{project}/regions/{region}/disks/{disk}/stopAsyncReplication
Apiversion : 2026-12-01-preview
Parameter Order :
▼ ▲ compute.regionDisks.setIamPolicy
Description : Sets the access control policy on the specified resource. Replaces any existing policy.
Path : projects/{project}/regions/{region}/disks/{resource}/setIamPolicy
Flat Path : projects/{project}/regions/{region}/disks/{resource}/setIamPolicy
Parameters :
resource
Required : Yes
Type : string
Description : Name or id of the resource for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
region
Location : path
Description : The name of the region for this request.
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
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.
Required : Yes
Type : string
Location : path
Apiversion : 2026-12-01-preview
HTTP Method : POST
Scopes :
Parameter Order :
▼ ▲ compute.regionDisks.addResourcePolicies
Parameter Order :
Flat Path : projects/{project}/regions/{region}/disks/{disk}/addResourcePolicies
Description : Adds existing resource policies to a regional disk. You can only add one policy which will be applied to this disk for scheduling snapshot creation.
Scopes :
Path : projects/{project}/regions/{region}/disks/{disk}/addResourcePolicies
HTTP Method : POST
Parameters :
region
Required : Yes
Description : The name of the region for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Type : string
requestId
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).
Location : query
project
Description : Project ID for this request.
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])?))
Location : path
Type : string
disk
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Type : string
Description : The disk name for this request.
Apiversion : 2026-12-01-preview
▼ ▲ compute.regionDisks.insert
Parameters :
region
Description : Name of the region for this request.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
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])?))
Type : string
Required : Yes
Location : path
Description : Project ID for this request.
requestId
Location : query
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
sourceImage
Type : string
Location : query
Description : Source image to restore onto a disk. This field is optional.
Description : Creates a persistent regional disk in the specified project using the data included in the request.
Apiversion : 2026-12-01-preview
Parameter Order :
Flat Path : projects/{project}/regions/{region}/disks
Scopes :
Path : projects/{project}/regions/{region}/disks
HTTP Method : POST
▼ ▲ compute.regionDisks.delete
Parameters :
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])?))
Required : Yes
Type : string
Description : Project ID for 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
region
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Required : Yes
Description : Name of the region for this request.
disk
Required : Yes
Description : Name of the regional persistent disk to delete.
Type : string
Pattern : \S{1,66}
Location : path
Apiversion : 2026-12-01-preview
Path : projects/{project}/regions/{region}/disks/{disk}
Scopes :
Description : Deletes the specified regional persistent disk. Deleting a regional disk removes all the replicas of its data permanently and is irreversible. However, deleting a disk does not delete anysnapshots previously made from the disk. You must separatelydelete snapshots.
Parameter Order :
HTTP Method : DELETE
Flat Path : projects/{project}/regions/{region}/disks/{disk}
▼ ▲ compute.advice.calendarMode
HTTP Method : POST
Parameters :
region
Required : Yes
Type : string
Description : Name of the region for this request.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
project
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])?))
Required : Yes
Description : Project ID for this request.
Description : Advise how, where and when to create the requested amount of instances with specified accelerators, within the specified time and location limits. The method recommends creating future reservations for the requested resources.
Scopes :
Flat Path : projects/{project}/regions/{region}/advice/calendarMode
Parameter Order :
Path : projects/{project}/regions/{region}/advice/calendarMode
Apiversion : 2026-12-01-preview
▼ ▲ compute.advice.capacityHistory
Apiversion : 2026-12-01-preview
Parameters :
region
Description : Name of the region for this request.
Type : string
Required : Yes
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
project
Description : Project ID for this request.
Location : path
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])?))
Required : Yes
Parameter Order :
Path : projects/{project}/regions/{region}/advice/capacityHistory
Flat Path : projects/{project}/regions/{region}/advice/capacityHistory
HTTP Method : POST
Scopes :
Description : Gets the capacity history.
▼ ▲ compute.advice.capacity
Flat Path : projects/{project}/regions/{region}/advice/capacity
Path : projects/{project}/regions/{region}/advice/capacity
Apiversion : 2026-12-01-preview
Parameters :
project
Location : path
Description : Project ID for this request.
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])?))
Required : Yes
region
Location : path
Required : Yes
Description : Name of the region for this request.
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
HTTP Method : POST
Description : Advice on making real-time decisions (such as choosing zone or machine types) during deployment to maximize your chances of obtaining capacity.
Scopes :
Parameter Order :
▼ ▲ compute.firewallPolicies.list
Path : locations/global/firewallPolicies
Apiversion : 2026-12-01-preview
Flat Path : locations/global/firewallPolicies
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`)
Format : uint32
Location : query
Minimum : 0
Default : 500
Type : integer
filter
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.
Location : query
parentId
Description : Parent ID for this request. The ID can be either be "folders/[FOLDER_ID]" if the parent is a folder or "organizations/[ORGANIZATION_ID]" if the parent is an organization.
Type : string
Location : query
orderBy
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.
Location : query
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.
Description : Lists all the policies that have been configured for the specified folder or organization.
HTTP Method : GET
Scopes :
▼ ▲ compute.firewallPolicies.setIamPolicy
HTTP Method : POST
Parameter Order : resource
Path : locations/global/firewallPolicies/{resource}/setIamPolicy
Scopes :
Flat Path : locations/global/firewallPolicies/{resource}/setIamPolicy
Description : Sets the access control policy on the specified resource. Replaces any existing policy.
Parameters :
resource
Required : Yes
Description : Name or id of the resource for this request.
Type : string
Location : path
Pattern : (firewallPolicies/)?[0-9]{0,20}
Apiversion : 2026-12-01-preview
▼ ▲ compute.firewallPolicies.getRule
Parameters :
firewallPolicy
Pattern : (firewallPolicies/)?[0-9]{0,20}
Description : Name of the firewall policy to which the queried rule belongs.
Required : Yes
Location : path
Type : string
priority
Description : The priority of the rule to get from the firewall policy.
Type : integer
Format : int32
Location : query
Parameter Order : firewallPolicy
Apiversion : 2026-12-01-preview
Scopes :
Path : locations/global/firewallPolicies/{firewallPolicy}/getRule
Description : Gets a rule of the specified priority.
Flat Path : locations/global/firewallPolicies/{firewallPolicy}/getRule
HTTP Method : GET
▼ ▲ compute.firewallPolicies.delete
Apiversion : 2026-12-01-preview
Scopes :
Parameters :
requestId
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).
Location : query
firewallPolicy
Pattern : (firewallPolicies/)?[0-9]{0,20}
Description : Name of the firewall policy to delete.
Required : Yes
Location : path
Type : string
Flat Path : locations/global/firewallPolicies/{firewallPolicy}
Path : locations/global/firewallPolicies/{firewallPolicy}
Parameter Order : firewallPolicy
HTTP Method : DELETE
Description : Deletes the specified policy.
▼ ▲ compute.firewallPolicies.getIamPolicy
Path : locations/global/firewallPolicies/{resource}/getIamPolicy
Apiversion : 2026-12-01-preview
Parameters :
optionsRequestedPolicyVersion
Type : integer
Location : query
Format : int32
Description : Requested IAM Policy version.
resource
Required : Yes
Pattern : (firewallPolicies/)?[0-9]{0,20}
Location : path
Description : Name or id of the resource for this request.
Type : string
HTTP Method : GET
Description : Gets the access control policy for a resource. May be empty if no such policy or resource exists.
Flat Path : locations/global/firewallPolicies/{resource}/getIamPolicy
Parameter Order : resource
Scopes :
▼ ▲ compute.firewallPolicies.patchRule
HTTP Method : POST
Path : locations/global/firewallPolicies/{firewallPolicy}/patchRule
Flat Path : locations/global/firewallPolicies/{firewallPolicy}/patchRule
Parameter Order : firewallPolicy
Description : Patches a rule of the specified priority.
Apiversion : 2026-12-01-preview
Scopes :
Parameters :
firewallPolicy
Location : path
Pattern : (firewallPolicies/)?[0-9]{0,20}
Description : Name of the firewall policy to update.
Required : Yes
Type : string
priority
Location : query
Type : integer
Description : The priority of the rule to patch.
Format : int32
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).
▼ ▲ compute.firewallPolicies.insert
Scopes :
HTTP Method : POST
Parameters :
parentId
Description : Parent ID for this request. The ID can be either be "folders/[FOLDER_ID]" if the parent is a folder or "organizations/[ORGANIZATION_ID]" if the parent is an organization.
Location : query
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).
Type : string
Location : query
Path : locations/global/firewallPolicies
Flat Path : locations/global/firewallPolicies
Apiversion : 2026-12-01-preview
Description : Creates a new policy in the specified project using the data included in the request.
▼ ▲ compute.firewallPolicies.get
Parameters :
firewallPolicy
Location : path
Pattern : (firewallPolicies/)?[0-9]{0,20}
Type : string
Description : Name of the firewall policy to get.
Required : Yes
Parameter Order : firewallPolicy
Description : Returns the specified firewall policy.
Apiversion : 2026-12-01-preview
Scopes :
Flat Path : locations/global/firewallPolicies/{firewallPolicy}
HTTP Method : GET
Path : locations/global/firewallPolicies/{firewallPolicy}
▼ ▲ compute.firewallPolicies.testIamPermissions
Flat Path : locations/global/firewallPolicies/{resource}/testIamPermissions
HTTP Method : POST
Parameters :
resource
Location : path
Pattern : (firewallPolicies/)?[0-9]{0,20}
Required : Yes
Description : Name or id of the resource for this request.
Type : string
Parameter Order : resource
Apiversion : 2026-12-01-preview
Scopes :
Path : locations/global/firewallPolicies/{resource}/testIamPermissions
Description : Returns permissions that a caller has on the specified resource.
▼ ▲ compute.firewallPolicies.listAssociations
Apiversion : 2026-12-01-preview
Parameters :
includeInheritedPolicies
Type : boolean
Location : query
Description : If set to "true", the response will contain a list of all associations for the containing folders and the containing organization of the target. The parameter has no effect if the target is an organization.
targetResource
Type : string
Location : query
Description : The target resource to list associations. It is an organization, or a folder.
Flat Path : locations/global/firewallPolicies/listAssociations
Description : Lists associations of a specified target, i.e., organization or folder.
Scopes :
HTTP Method : GET
Path : locations/global/firewallPolicies/listAssociations
▼ ▲ compute.firewallPolicies.move
Parameters :
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).
firewallPolicy
Type : string
Description : Name of the firewall policy to update.
Required : Yes
Pattern : (firewallPolicies/)?[0-9]{0,20}
Location : path
parentId
Location : query
Type : string
Description : The new parent of the firewall policy. The ID can be either be "folders/[FOLDER_ID]" if the parent is a folder or "organizations/[ORGANIZATION_ID]" if the parent is an organization.
Apiversion : 2026-12-01-preview
Scopes :
Flat Path : locations/global/firewallPolicies/{firewallPolicy}/move
Description : Moves the specified firewall policy.
Path : locations/global/firewallPolicies/{firewallPolicy}/move
HTTP Method : POST
Parameter Order : firewallPolicy
▼ ▲ compute.firewallPolicies.getAssociation
Description : Gets an association with the specified name.
Parameter Order : firewallPolicy
Scopes :
HTTP Method : GET
Parameters :
firewallPolicy
Description : Name of the firewall policy to which the queried rule belongs.
Required : Yes
Type : string
Pattern : (firewallPolicies/)?[0-9]{0,20}
Location : path
name
Description : The name of the association to get from the firewall policy.
Type : string
Location : query
Apiversion : 2026-12-01-preview
Flat Path : locations/global/firewallPolicies/{firewallPolicy}/getAssociation
Path : locations/global/firewallPolicies/{firewallPolicy}/getAssociation
▼ ▲ compute.firewallPolicies.addAssociation
Description : Inserts an association for the specified firewall policy.
Path : locations/global/firewallPolicies/{firewallPolicy}/addAssociation
HTTP Method : POST
Flat Path : locations/global/firewallPolicies/{firewallPolicy}/addAssociation
Scopes :
Parameter Order : firewallPolicy
Parameters :
replaceExistingAssociation
Description : Indicates whether or not to replace it if an association of the attachment already exists. This is false by default, in which case an error will be returned if an association already exists.
Location : query
Type : boolean
firewallPolicy
Required : Yes
Pattern : (firewallPolicies/)?[0-9]{0,20}
Location : path
Description : Name of the firewall policy to update.
Type : string
requestId
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).
Location : query
Apiversion : 2026-12-01-preview
▼ ▲ compute.firewallPolicies.cloneRules
HTTP Method : POST
Flat Path : locations/global/firewallPolicies/{firewallPolicy}/cloneRules
Description : Copies rules to the specified firewall policy.
Scopes :
Parameter Order : firewallPolicy
Apiversion : 2026-12-01-preview
Path : locations/global/firewallPolicies/{firewallPolicy}/cloneRules
Parameters :
sourceFirewallPolicy
Location : query
Description : The firewall policy from which to copy rules.
Type : string
firewallPolicy
Required : Yes
Type : string
Description : Name of the firewall policy to update.
Pattern : (firewallPolicies/)?[0-9]{0,20}
Location : path
requestId
Type : string
Location : query
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).
▼ ▲ compute.firewallPolicies.removeAssociation
Flat Path : locations/global/firewallPolicies/{firewallPolicy}/removeAssociation
Apiversion : 2026-12-01-preview
Path : locations/global/firewallPolicies/{firewallPolicy}/removeAssociation
Description : Removes an association for the specified firewall policy.
Parameter Order : firewallPolicy
Parameters :
requestId
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).
Location : query
name
Location : query
Description : Name for the attachment that will be removed.
Type : string
firewallPolicy
Pattern : (firewallPolicies/)?[0-9]{0,20}
Required : Yes
Type : string
Location : path
Description : Name of the firewall policy to update.
HTTP Method : POST
Scopes :
▼ ▲ compute.firewallPolicies.addRule
HTTP Method : POST
Flat Path : locations/global/firewallPolicies/{firewallPolicy}/addRule
Description : Inserts a rule into a firewall policy.
Parameter Order : firewallPolicy
Scopes :
Path : locations/global/firewallPolicies/{firewallPolicy}/addRule
Apiversion : 2026-12-01-preview
Parameters :
firewallPolicy
Pattern : (firewallPolicies/)?[0-9]{0,20}
Location : path
Type : string
Required : Yes
Description : Name of the firewall policy to update.
requestId
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).
Location : query
▼ ▲ compute.firewallPolicies.removeRule
Flat Path : locations/global/firewallPolicies/{firewallPolicy}/removeRule
HTTP Method : POST
Path : locations/global/firewallPolicies/{firewallPolicy}/removeRule
Apiversion : 2026-12-01-preview
Scopes :
Description : Deletes a rule of the specified priority.
Parameters :
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).
priority
Description : The priority of the rule to remove from the firewall policy.
Type : integer
Location : query
Format : int32
firewallPolicy
Required : Yes
Description : Name of the firewall policy to update.
Pattern : (firewallPolicies/)?[0-9]{0,20}
Type : string
Location : path
Parameter Order : firewallPolicy
▼ ▲ compute.firewallPolicies.patch
Parameter Order : firewallPolicy
HTTP Method : PATCH
Scopes :
Path : locations/global/firewallPolicies/{firewallPolicy}
Description : Patches the specified policy with the data included in the request.
Apiversion : 2026-12-01-preview
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).
Location : query
Type : string
firewallPolicy
Required : Yes
Type : string
Pattern : (firewallPolicies/)?[0-9]{0,20}
Description : Name of the firewall policy to update.
Location : path
Flat Path : locations/global/firewallPolicies/{firewallPolicy}
▼ ▲ compute.interconnectLocations.get
Apiversion : 2026-12-01-preview
Parameters :
interconnectLocation
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the interconnect location to return.
Type : string
Required : Yes
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
Path : projects/{project}/global/interconnectLocations/{interconnectLocation}
Flat Path : projects/{project}/global/interconnectLocations/{interconnectLocation}
Scopes :
Parameter Order :
HTTP Method : GET
Description : Returns the details for the specified interconnect location. Gets a list of available interconnect locations by making a list() request.
▼ ▲ compute.interconnectLocations.list
Flat Path : projects/{project}/global/interconnectLocations
HTTP Method : GET
Parameter Order : project
Scopes :
Description : Retrieves the list of interconnect locations available to the specified project.
Path : projects/{project}/global/interconnectLocations
Apiversion : 2026-12-01-preview
Parameters :
maxResults
Minimum : 0
Default : 500
Format : uint32
Type : integer
Location : query
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`)
project
Required : Yes
Type : string
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])?))
filter
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.
Type : string
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
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
▼ ▲ compute.regionAutoscalers.get
Parameter Order :
Scopes :
Description : Returns the specified autoscaler.
HTTP Method : GET
Parameters :
autoscaler
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Location : path
Description : Name of the autoscaler to return.
region
Type : string
Description : Name of the region scoping this request.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
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])?))
Type : string
Required : Yes
Location : path
Description : Project ID for this request.
Flat Path : projects/{project}/regions/{region}/autoscalers/{autoscaler}
Apiversion : 2026-12-01-preview
Path : projects/{project}/regions/{region}/autoscalers/{autoscaler}
▼ ▲ compute.regionAutoscalers.insert
Scopes :
Path : projects/{project}/regions/{region}/autoscalers
HTTP Method : POST
Parameters :
requestId
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).
Location : query
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.
Type : string
Location : path
region
Description : Name of the region scoping this request.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Type : string
Apiversion : 2026-12-01-preview
Parameter Order :
Description : Creates an autoscaler in the specified project using the data included in the request.
Flat Path : projects/{project}/regions/{region}/autoscalers
▼ ▲ compute.regionAutoscalers.patch
Path : projects/{project}/regions/{region}/autoscalers
Scopes :
Parameter Order :
HTTP Method : PATCH
Parameters :
autoscaler
Location : query
Description : Name of the autoscaler to patch.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
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
Description : Project ID for this request.
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).
Type : string
Location : query
region
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Name of the region scoping this request.
Required : Yes
Description : Updates an autoscaler in the specified project using the data included in the request. This method supportsPATCH semantics and uses theJSON merge patch format and processing rules.
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/regions/{region}/autoscalers
▼ ▲ compute.regionAutoscalers.update
Scopes :
HTTP Method : PUT
Parameter Order :
Path : projects/{project}/regions/{region}/autoscalers
Description : Updates an autoscaler in the specified project using the data included in the request.
Parameters :
requestId
Type : string
Location : query
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).
project
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])?))
Location : path
Required : Yes
Description : Project ID for this request.
autoscaler
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the autoscaler to update.
Location : query
Type : string
region
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Type : string
Description : Name of the region scoping this request.
Flat Path : projects/{project}/regions/{region}/autoscalers
Apiversion : 2026-12-01-preview
▼ ▲ compute.regionAutoscalers.list
Apiversion : 2026-12-01-preview
Description : Retrieves a list of autoscalers contained within the specified region.
Scopes :
Parameters :
region
Description : Name of the region scoping this request.
Location : path
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
maxResults
Type : integer
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`)
Minimum : 0
Location : query
Default : 500
Format : uint32
project
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])?))
Required : Yes
Description : Project ID for this request.
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.
filter
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.
Location : query
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.
Type : string
Location : query
HTTP Method : GET
Flat Path : projects/{project}/regions/{region}/autoscalers
Parameter Order :
Path : projects/{project}/regions/{region}/autoscalers
▼ ▲ compute.regionAutoscalers.testIamPermissions
Parameters :
region
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Description : The name of the region for 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])?))
Type : string
Description : Project ID for this request.
Required : Yes
Location : path
resource
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Required : Yes
Description : Name or id of the resource for this request.
Apiversion : 2026-12-01-preview
Path : projects/{project}/regions/{region}/autoscalers/{resource}/testIamPermissions
Description : Returns permissions that a caller has on the specified resource.
Flat Path : projects/{project}/regions/{region}/autoscalers/{resource}/testIamPermissions
Scopes :
Parameter Order :
HTTP Method : POST
▼ ▲ compute.regionAutoscalers.delete
Path : projects/{project}/regions/{region}/autoscalers/{autoscaler}
Apiversion : 2026-12-01-preview
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])?))
Type : string
Required : Yes
Location : path
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).
autoscaler
Description : Name of the autoscaler to delete.
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
region
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Description : Name of the region scoping this request.
Required : Yes
HTTP Method : DELETE
Description : Deletes the specified autoscaler.
Scopes :
Parameter Order :
Flat Path : projects/{project}/regions/{region}/autoscalers/{autoscaler}
▼ ▲ compute.networkEdgeSecurityServices.get
Scopes :
Parameter Order :
Flat Path : projects/{project}/regions/{region}/networkEdgeSecurityServices/{networkEdgeSecurityService}
HTTP Method : GET
Parameters :
project
Location : path
Type : string
Description : Project ID for this request.
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])?))
networkEdgeSecurityService
Description : Name of the network edge security service to get.
Location : path
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
region
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Required : Yes
Description : Name of the region scoping this request.
Description : Gets a specified NetworkEdgeSecurityService.
Apiversion : 2026-12-01-preview
Path : projects/{project}/regions/{region}/networkEdgeSecurityServices/{networkEdgeSecurityService}
▼ ▲ compute.networkEdgeSecurityServices.patch
HTTP Method : PATCH
Flat Path : projects/{project}/regions/{region}/networkEdgeSecurityServices/{networkEdgeSecurityService}
Parameter Order :
Path : projects/{project}/regions/{region}/networkEdgeSecurityServices/{networkEdgeSecurityService}
Apiversion : 2026-12-01-preview
Description : Patches the specified policy with the data included in the request.
Scopes :
Parameters :
paths
Repeated : Yes
Type : string
Location : query
updateMask
Description : Indicates fields to be updated as part of this request.
Location : query
Format : google-fieldmask
Type : string
networkEdgeSecurityService
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Description : Name of the network edge security service to update.
region
Location : path
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Name of the region scoping this request.
Required : Yes
requestId
Location : query
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
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])?))
Type : string
Description : Project ID for this request.
Required : Yes
Location : path
▼ ▲ compute.networkEdgeSecurityServices.insert
HTTP Method : POST
Parameter Order :
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
region
Required : Yes
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Description : Name of the region scoping this request.
validateOnly
Location : query
Type : boolean
Description : If true, the request will not be committed.
project
Required : Yes
Description : Project ID for this request.
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])?))
Location : path
Flat Path : projects/{project}/regions/{region}/networkEdgeSecurityServices
Apiversion : 2026-12-01-preview
Path : projects/{project}/regions/{region}/networkEdgeSecurityServices
Description : Creates a new service in the specified project using the data included in the request.
Scopes :
▼ ▲ compute.networkEdgeSecurityServices.aggregatedList
Path : projects/{project}/aggregated/networkEdgeSecurityServices
Parameter Order : project
Parameters :
project
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])?))
Description : Name of the project scoping this request.
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
Minimum : 0
Format : uint32
Type : integer
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`)
Location : query
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
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.
serviceProjectNumber
Format : int64
Type : string
Description : The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.
Location : query
includeAllScopes
Location : query
Description : Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
Type : boolean
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/aggregated/networkEdgeSecurityServices
HTTP Method : GET
Scopes :
Description : Retrieves the list of all NetworkEdgeSecurityService resources available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.
▼ ▲ compute.networkEdgeSecurityServices.delete
HTTP Method : DELETE
Path : projects/{project}/regions/{region}/networkEdgeSecurityServices/{networkEdgeSecurityService}
Flat Path : projects/{project}/regions/{region}/networkEdgeSecurityServices/{networkEdgeSecurityService}
Parameter Order :
Scopes :
Apiversion : 2026-12-01-preview
Description : Deletes the specified service.
Parameters :
region
Location : path
Type : string
Required : Yes
Description : Name of the region scoping this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
networkEdgeSecurityService
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the network edge security service to delete.
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).
project
Location : path
Description : Project ID for this request.
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])?))
Required : Yes
▼ ▲ compute.vpnTunnels.setLabels
Parameter Order :
HTTP Method : POST
Flat Path : projects/{project}/regions/{region}/vpnTunnels/{resource}/setLabels
Path : projects/{project}/regions/{region}/vpnTunnels/{resource}/setLabels
Description : Sets the labels on a VpnTunnel. To learn more about labels, read theLabeling Resources documentation.
Parameters :
project
Required : Yes
Description : Project ID for this request.
Location : path
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).
Type : string
Location : query
region
Location : path
Description : The region for this request.
Type : string
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
resource
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Description : Name or id of the resource for this request.
Type : string
Scopes :
Apiversion : 2026-12-01-preview
▼ ▲ compute.vpnTunnels.insert
Description : Creates a VpnTunnel resource in the specified project and region using the data included in the request.
Scopes :
Path : projects/{project}/regions/{region}/vpnTunnels
Parameters :
region
Required : Yes
Description : Name of the region for this request.
Location : path
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
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).
project
Type : string
Location : path
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.
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/regions/{region}/vpnTunnels
HTTP Method : POST
Parameter Order :
▼ ▲ compute.vpnTunnels.list
HTTP Method : GET
Description : Retrieves a list of VpnTunnel resources contained in the specified project and region.
Parameter Order :
Scopes :
Parameters :
maxResults
Location : query
Default : 500
Format : uint32
Minimum : 0
Type : integer
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`)
region
Location : path
Type : string
Required : Yes
Description : Name of the region for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
project
Required : Yes
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])?))
Type : string
Location : path
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.
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.
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.
Flat Path : projects/{project}/regions/{region}/vpnTunnels
Apiversion : 2026-12-01-preview
Path : projects/{project}/regions/{region}/vpnTunnels
▼ ▲ compute.vpnTunnels.aggregatedList
Scopes :
Parameter Order : project
Apiversion : 2026-12-01-preview
Description : Retrieves an aggregated list of VPN tunnels. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.
Parameters :
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.
includeAllScopes
Type : boolean
Location : query
Description : Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
maxResults
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`)
Format : uint32
Default : 500
Location : query
Type : integer
project
Required : Yes
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])?))
Type : string
Location : path
pageToken
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.
Type : string
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
serviceProjectNumber
Type : string
Format : int64
Description : The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.
Location : query
HTTP Method : GET
Path : projects/{project}/aggregated/vpnTunnels
Flat Path : projects/{project}/aggregated/vpnTunnels
▼ ▲ compute.vpnTunnels.delete
HTTP Method : DELETE
Flat Path : projects/{project}/regions/{region}/vpnTunnels/{vpnTunnel}
Parameter Order :
Apiversion : 2026-12-01-preview
Path : projects/{project}/regions/{region}/vpnTunnels/{vpnTunnel}
Description : Deletes the specified VpnTunnel resource.
Parameters :
vpnTunnel
Description : Name of the VpnTunnel resource to delete.
Location : path
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
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
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Description : Name of the region for this request.
Required : Yes
Location : path
requestId
Type : string
Location : query
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).
Scopes :
▼ ▲ compute.vpnTunnels.get
Scopes :
Parameters :
region
Type : string
Required : Yes
Description : Name of the region for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
vpnTunnel
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Description : Name of the VpnTunnel resource to return.
project
Description : Project ID for this request.
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])?))
Type : string
Location : path
Apiversion : 2026-12-01-preview
Path : projects/{project}/regions/{region}/vpnTunnels/{vpnTunnel}
Description : Returns the specified VpnTunnel resource.
Flat Path : projects/{project}/regions/{region}/vpnTunnels/{vpnTunnel}
Parameter Order :
HTTP Method : GET
▼ ▲ compute.zones.list
HTTP Method : GET
Description : Retrieves the list of Zone resources available to the specified project.
Flat Path : projects/{project}/zones
Parameter Order : project
Apiversion : 2026-12-01-preview
Scopes :
Path : projects/{project}/zones
Parameters :
project
Type : string
Description : Project ID for this request.
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])?))
Location : path
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.
maxResults
Default : 500
Minimum : 0
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`)
Location : query
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
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.
Location : query
Type : string
▼ ▲ compute.zones.get
HTTP Method : GET
Path : projects/{project}/zones/{zone}
Flat Path : projects/{project}/zones/{zone}
Scopes :
Apiversion : 2026-12-01-preview
Description : Returns the specified Zone resource.
Parameters :
zone
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the zone resource to return.
Required : Yes
Type : string
Location : path
project
Description : Project ID for this request.
Location : path
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])?))
Parameter Order :
▼ ▲ compute.instanceTemplates.delete
Scopes :
HTTP Method : DELETE
Parameter Order :
Path : projects/{project}/global/instanceTemplates/{instanceTemplate}
Parameters :
instanceTemplate
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Description : The name of the instance template to delete.
Required : Yes
Location : path
requestId
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).
Location : query
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])?))
Type : string
Description : Project ID for this request.
Required : Yes
Location : path
Description : Deletes the specified instance template. Deleting an instance template is permanent and cannot be undone. It is not possible to delete templates that are already in use by a managed instance group.
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/global/instanceTemplates/{instanceTemplate}
▼ ▲ compute.instanceTemplates.testIamPermissions
Parameters :
resource
Pattern : [a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Required : Yes
Description : Name or id of the resource for this request.
Type : string
project
Location : path
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])?))
Type : string
Required : Yes
Apiversion : 2026-12-01-preview
Path : projects/{project}/global/instanceTemplates/{resource}/testIamPermissions
Parameter Order :
Scopes :
Description : Returns permissions that a caller has on the specified resource.
HTTP Method : POST
Flat Path : projects/{project}/global/instanceTemplates/{resource}/testIamPermissions
▼ ▲ compute.instanceTemplates.list
HTTP Method : GET
Path : projects/{project}/global/instanceTemplates
Parameter Order : project
Apiversion : 2026-12-01-preview
Scopes :
Flat Path : projects/{project}/global/instanceTemplates
Parameters :
maxResults
Location : query
Format : uint32
Type : integer
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`)
Minimum : 0
Default : 500
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])?))
Type : string
Required : Yes
orderBy
Type : string
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.
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.
Type : string
Location : query
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.
Description : Retrieves a list of instance templates that are contained within the specified project.
▼ ▲ compute.instanceTemplates.setIamPolicy
Parameter Order :
Scopes :
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/global/instanceTemplates/{resource}/setIamPolicy
Description : Sets the access control policy on the specified resource. Replaces any existing policy.
Parameters :
resource
Type : string
Location : path
Required : Yes
Pattern : [a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name or id of the resource for this request.
project
Description : Project ID for this request.
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])?))
Location : path
HTTP Method : POST
Path : projects/{project}/global/instanceTemplates/{resource}/setIamPolicy
▼ ▲ compute.instanceTemplates.getIamPolicy
Description : Gets the access control policy for a resource. May be empty if no such policy or resource exists.
Parameter Order :
Flat Path : projects/{project}/global/instanceTemplates/{resource}/getIamPolicy
HTTP Method : GET
Scopes :
Path : projects/{project}/global/instanceTemplates/{resource}/getIamPolicy
Apiversion : 2026-12-01-preview
Parameters :
optionsRequestedPolicyVersion
Description : Requested IAM Policy version.
Format : int32
Type : integer
Location : query
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
Type : string
Description : Project ID for this request.
Required : Yes
resource
Description : Name or id of the resource for this request.
Location : path
Type : string
Pattern : [a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
▼ ▲ compute.instanceTemplates.insert
Parameters :
requestId
Location : query
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
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])?))
Type : string
Required : Yes
Description : Project ID for this request.
Location : path
Parameter Order : project
Flat Path : projects/{project}/global/instanceTemplates
Apiversion : 2026-12-01-preview
Description : Creates an instance template in the specified project using the data that is included in the request. If you are creating a new template to update an existing instance group, your new instance template must use the same network or, if applicable, the same subnetwork as the original template.
Path : projects/{project}/global/instanceTemplates
Scopes :
HTTP Method : POST
▼ ▲ compute.instanceTemplates.aggregatedList
Path : projects/{project}/aggregated/instanceTemplates
Description : Retrieves the list of all InstanceTemplates resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.
Scopes :
Apiversion : 2026-12-01-preview
Parameter Order : project
Parameters :
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
includeAllScopes
Location : query
Type : boolean
Description : Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
project
Required : Yes
Type : string
Description : Name of the project scoping 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])?))
Location : path
serviceProjectNumber
Type : string
Format : int64
Description : The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.
Location : query
filter
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.
Type : string
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.
Type : string
Location : query
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
Minimum : 0
Type : integer
Location : query
Format : uint32
HTTP Method : GET
Flat Path : projects/{project}/aggregated/instanceTemplates
▼ ▲ compute.instanceTemplates.get
Description : Returns the specified instance template.
Flat Path : projects/{project}/global/instanceTemplates/{instanceTemplate}
Parameters :
instanceTemplate
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : The name of the instance template.
Required : Yes
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
Apiversion : 2026-12-01-preview
Scopes :
Path : projects/{project}/global/instanceTemplates/{instanceTemplate}
HTTP Method : GET
Parameter Order :
▼ ▲ compute.backendBuckets.getIamPolicy
HTTP Method : GET
Parameter Order :
Scopes :
Description : Gets the access control policy for a resource. May be empty if no such policy or resource exists.
Flat Path : projects/{project}/global/backendBuckets/{resource}/getIamPolicy
Apiversion : 2026-12-01-preview
Path : projects/{project}/global/backendBuckets/{resource}/getIamPolicy
Parameters :
resource
Location : path
Description : Name or id of the resource for this request.
Required : Yes
Pattern : [a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
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])?))
optionsRequestedPolicyVersion
Type : integer
Location : query
Description : Requested IAM Policy version.
Format : int32
▼ ▲ compute.backendBuckets.update
Description : Updates the specified BackendBucket resource with the data included in the request.
HTTP Method : PUT
Parameter Order :
Scopes :
Flat Path : projects/{project}/global/backendBuckets/{backendBucket}
Apiversion : 2026-12-01-preview
Parameters :
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
Required : Yes
Description : Project ID for this request.
requestId
Type : string
Location : query
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).
backendBucket
Required : Yes
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the BackendBucket resource to update.
Path : projects/{project}/global/backendBuckets/{backendBucket}
▼ ▲ compute.backendBuckets.deleteSignedUrlKey
Scopes :
Flat Path : projects/{project}/global/backendBuckets/{backendBucket}/deleteSignedUrlKey
Parameter Order :
Parameters :
keyName
Required : Yes
Type : string
Location : query
Description : The name of the Signed URL Key to delete.
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])?))
Type : string
Required : Yes
backendBucket
Required : Yes
Description : Name of the BackendBucket resource to which the Signed URL Key should be added. The name should conform to RFC1035.
Type : string
Location : path
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).
Apiversion : 2026-12-01-preview
Description : Deletes a key for validating requests with signed URLs for this backend bucket.
Path : projects/{project}/global/backendBuckets/{backendBucket}/deleteSignedUrlKey
HTTP Method : POST
▼ ▲ compute.backendBuckets.addSignedUrlKey
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/global/backendBuckets/{backendBucket}/addSignedUrlKey
Parameters :
requestId
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).
Location : query
backendBucket
Description : Name of the BackendBucket resource to which the Signed URL Key should be added. The name should conform to RFC1035.
Required : Yes
Type : string
Location : path
project
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])?))
Location : path
Description : Project ID for this request.
Scopes :
Path : projects/{project}/global/backendBuckets/{backendBucket}/addSignedUrlKey
Description : Adds a key for validating requests with signed URLs for this backend bucket.
HTTP Method : POST
Parameter Order :
▼ ▲ compute.backendBuckets.aggregatedList
HTTP Method : GET
Description : Retrieves the list of all BackendBucket resources, regional and global, available to the specified project. To prevent failure, it is recommended that you set the `returnPartialSuccess` parameter to `true`.
Flat Path : projects/{project}/aggregated/backendBuckets
Parameter Order : project
Parameters :
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.
serviceProjectNumber
Type : string
Format : int64
Description : The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.
Location : query
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
Minimum : 0
Location : query
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
Type : integer
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.
includeAllScopes
Description : Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
Type : boolean
Location : query
project
Location : path
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])?))
Description : Name of the project scoping this request.
Required : Yes
Apiversion : 2026-12-01-preview
Scopes :
Path : projects/{project}/aggregated/backendBuckets
▼ ▲ compute.backendBuckets.patch
Apiversion : 2026-12-01-preview
Description : Updates the specified BackendBucket resource with the data included in the request. This method supportsPATCH semantics and uses theJSON merge patch format and processing rules.
Parameters :
project
Location : path
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])?))
Type : string
Required : Yes
backendBucket
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Type : string
Required : Yes
Description : Name of the BackendBucket resource to patch.
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
Path : projects/{project}/global/backendBuckets/{backendBucket}
Scopes :
Flat Path : projects/{project}/global/backendBuckets/{backendBucket}
HTTP Method : PATCH
Parameter Order :
▼ ▲ compute.backendBuckets.setIamPolicy
HTTP Method : POST
Flat Path : projects/{project}/global/backendBuckets/{resource}/setIamPolicy
Path : projects/{project}/global/backendBuckets/{resource}/setIamPolicy
Description : Sets the access control policy on the specified resource. Replaces any existing policy.
Scopes :
Apiversion : 2026-12-01-preview
Parameters :
project
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])?))
Location : path
resource
Location : path
Pattern : [a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Description : Name or id of the resource for this request.
Required : Yes
Parameter Order :
▼ ▲ compute.backendBuckets.setEdgeSecurityPolicy
Path : projects/{project}/global/backendBuckets/{backendBucket}/setEdgeSecurityPolicy
Parameter Order :
Scopes :
HTTP Method : POST
Flat Path : projects/{project}/global/backendBuckets/{backendBucket}/setEdgeSecurityPolicy
Apiversion : 2026-12-01-preview
Description : Sets the edge security policy for the specified backend bucket.
Parameters :
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 : Project ID for this request.
Location : path
requestId
Location : query
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
backendBucket
Type : string
Location : path
Required : Yes
Description : Name of the BackendBucket resource to which the security policy should be set. The name should conform to RFC1035.
▼ ▲ compute.backendBuckets.delete
Apiversion : 2026-12-01-preview
Parameters :
backendBucket
Location : path
Required : Yes
Description : Name of the BackendBucket resource to delete.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
project
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])?))
Required : Yes
Description : Project ID for 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
Path : projects/{project}/global/backendBuckets/{backendBucket}
Flat Path : projects/{project}/global/backendBuckets/{backendBucket}
Parameter Order :
Scopes :
Description : Deletes the specified BackendBucket resource.
HTTP Method : DELETE
▼ ▲ compute.backendBuckets.listUsable
HTTP Method : GET
Parameter Order : project
Description : Retrieves a list of all usable backend buckets in the specified project.
Path : projects/{project}/global/backendBuckets/listUsable
Scopes :
Parameters :
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
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.
filter
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.
Location : query
pageToken
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.
Type : string
maxResults
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`)
Default : 500
Type : integer
Minimum : 0
Location : query
Flat Path : projects/{project}/global/backendBuckets/listUsable
Apiversion : 2026-12-01-preview
▼ ▲ compute.backendBuckets.testIamPermissions
Path : projects/{project}/global/backendBuckets/{resource}/testIamPermissions
Flat Path : projects/{project}/global/backendBuckets/{resource}/testIamPermissions
Parameter Order :
HTTP Method : POST
Description : Returns permissions that a caller has on the specified resource.
Apiversion : 2026-12-01-preview
Parameters :
project
Required : Yes
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])?))
Type : string
Location : path
resource
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Description : Name or id of the resource for this request.
Scopes :
▼ ▲ compute.backendBuckets.insert
Scopes :
HTTP Method : POST
Parameter Order : project
Description : Creates a BackendBucket resource in the specified project using the data included in the request.
Path : projects/{project}/global/backendBuckets
Flat Path : projects/{project}/global/backendBuckets
Apiversion : 2026-12-01-preview
Parameters :
project
Type : string
Required : Yes
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])?))
Location : path
requestId
Type : string
Location : query
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).
▼ ▲ compute.backendBuckets.list
HTTP Method : GET
Scopes :
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])?))
Description : Project ID for this request.
Location : path
Type : string
Required : Yes
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
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.
Type : string
Location : query
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
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
Minimum : 0
Type : integer
Location : query
Format : uint32
Parameter Order : project
Description : Retrieves the list of BackendBucket resources available to the specified project.
Path : projects/{project}/global/backendBuckets
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/global/backendBuckets
▼ ▲ compute.backendBuckets.get
Parameters :
backendBucket
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the BackendBucket resource to return.
Required : Yes
Type : string
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])?))
Required : Yes
Type : string
Description : Project ID for this request.
Scopes :
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/global/backendBuckets/{backendBucket}
Parameter Order :
HTTP Method : GET
Description : Returns the specified BackendBucket resource.
Path : projects/{project}/global/backendBuckets/{backendBucket}
▼ ▲ compute.interconnectAttachmentGroups.get
Flat Path : projects/{project}/global/interconnectAttachmentGroups/{interconnectAttachmentGroup}
Description : Returns the specified InterconnectAttachmentGroup resource in the given scope.
Parameters :
interconnectAttachmentGroup
Type : string
Required : Yes
Description : Name of the InterconnectAttachmentGroup resource to return.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
project
Location : path
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])?))
Description : Project ID for this request.
Required : Yes
Scopes :
Path : projects/{project}/global/interconnectAttachmentGroups/{interconnectAttachmentGroup}
Apiversion : 2026-12-01-preview
HTTP Method : GET
Parameter Order :
▼ ▲ compute.interconnectAttachmentGroups.delete
Scopes :
Apiversion : 2026-12-01-preview
Parameters :
requestId
Type : string
Location : query
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). end_interface: MixerMutationRequestBuilder
interconnectAttachmentGroup
Location : path
Required : Yes
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the InterconnectAttachmentGroup resource to delete.
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])?))
Type : string
Description : Project ID for this request.
Location : path
Parameter Order :
Description : Deletes the specified InterconnectAttachmentGroup in the given scope
Path : projects/{project}/global/interconnectAttachmentGroups/{interconnectAttachmentGroup}
Flat Path : projects/{project}/global/interconnectAttachmentGroups/{interconnectAttachmentGroup}
HTTP Method : DELETE
▼ ▲ compute.interconnectAttachmentGroups.getIamPolicy
Apiversion : 2026-12-01-preview
Scopes :
Parameters :
project
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])?))
Location : path
optionsRequestedPolicyVersion
Location : query
Format : int32
Description : Requested IAM Policy version.
Type : integer
resource
Required : Yes
Pattern : [a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name or id of the resource for this request.
Type : string
Location : path
Path : projects/{project}/global/interconnectAttachmentGroups/{resource}/getIamPolicy
Parameter Order :
Description : Gets the access control policy for a resource. May be empty if no such policy or resource exists.
HTTP Method : GET
Flat Path : projects/{project}/global/interconnectAttachmentGroups/{resource}/getIamPolicy
▼ ▲ compute.interconnectAttachmentGroups.insert
Path : projects/{project}/global/interconnectAttachmentGroups
HTTP Method : POST
Description : Creates a InterconnectAttachmentGroup in the specified project in the given scope using the parameters that are included in the request.
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/global/interconnectAttachmentGroups
Parameters :
project
Description : Project ID for this request.
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])?))
Location : path
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). end_interface: MixerMutationRequestBuilder
Scopes :
Parameter Order : project
▼ ▲ compute.interconnectAttachmentGroups.patch
Parameters :
updateMask
Type : string
Location : query
Format : google-fieldmask
Description : The list of fields to update.
requestId
Location : query
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). end_interface: MixerMutationRequestBuilder
Type : string
project
Type : string
Required : Yes
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])?))
Location : path
interconnectAttachmentGroup
Description : Name of the InterconnectAttachmentGroup resource to patch.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Location : path
Type : string
Parameter Order :
Apiversion : 2026-12-01-preview
Path : projects/{project}/global/interconnectAttachmentGroups/{interconnectAttachmentGroup}
Scopes :
Description : Patches the specified InterconnectAttachmentGroup resource with the data included in the request. This method supports PATCH semantics and usesJSON merge patch format and processing rules.
Flat Path : projects/{project}/global/interconnectAttachmentGroups/{interconnectAttachmentGroup}
HTTP Method : PATCH
▼ ▲ compute.interconnectAttachmentGroups.getOperationalStatus
Path : projects/{project}/global/interconnectAttachmentGroups/{interconnectAttachmentGroup}/getOperationalStatus
Scopes :
HTTP Method : GET
Parameters :
project
Location : path
Type : string
Description : Project ID for this request.
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])?))
interconnectAttachmentGroup
Required : Yes
Description : Name of the interconnectAttachmentGroup resource to query.
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Apiversion : 2026-12-01-preview
Description : Returns the InterconnectAttachmentStatuses for the specified InterconnectAttachmentGroup resource.
Parameter Order :
Flat Path : projects/{project}/global/interconnectAttachmentGroups/{interconnectAttachmentGroup}/getOperationalStatus
▼ ▲ compute.interconnectAttachmentGroups.list
HTTP Method : GET
Flat Path : projects/{project}/global/interconnectAttachmentGroups
Path : projects/{project}/global/interconnectAttachmentGroups
Description : Lists the InterconnectAttachmentGroups for a project in the given scope.
Parameters :
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
Location : path
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])?))
Description : Project ID for this request.
Required : Yes
orderBy
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.
Location : query
filter
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.
Type : string
maxResults
Location : query
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`)
Default : 500
Type : integer
Minimum : 0
Scopes :
Parameter Order : project
Apiversion : 2026-12-01-preview
▼ ▲ compute.interconnectAttachmentGroups.setIamPolicy
Flat Path : projects/{project}/global/interconnectAttachmentGroups/{resource}/setIamPolicy
Scopes :
HTTP Method : POST
Path : projects/{project}/global/interconnectAttachmentGroups/{resource}/setIamPolicy
Parameters :
project
Description : Project ID for this request.
Location : path
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])?))
Required : Yes
resource
Location : path
Type : string
Pattern : [a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Description : Name or id of the resource for this request.
Apiversion : 2026-12-01-preview
Parameter Order :
Description : Sets the access control policy on the specified resource. Replaces any existing policy.
▼ ▲ compute.interconnectAttachmentGroups.testIamPermissions
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/global/interconnectAttachmentGroups/{resource}/testIamPermissions
Parameters :
resource
Description : Name or id of the resource for this request.
Type : string
Pattern : [a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Required : Yes
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
Path : projects/{project}/global/interconnectAttachmentGroups/{resource}/testIamPermissions
Scopes :
Description : Returns permissions that a caller has on the specified resource.
HTTP Method : POST
Parameter Order :
▼ ▲ compute.wireGroups.insert
Scopes :
Parameters :
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])?))
Description : Project ID for this request.
Required : Yes
Type : string
validateOnly
Type : boolean
Location : query
Description : [Input Only] Validate the new configuration, but don't create it.
crossSiteNetwork
Type : string
Required : Yes
Location : path
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). end_interface: MixerMutationRequestBuilder
Path : projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}/wireGroups
Apiversion : 2026-12-01-preview
Description : Creates a wire group in the specified project in the given scope using the parameters that are included in the request.
HTTP Method : POST
Flat Path : projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}/wireGroups
Parameter Order :
▼ ▲ compute.wireGroups.get
HTTP Method : GET
Path : projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}/wireGroups/{wireGroup}
Scopes :
Parameter Order :
Flat Path : projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}/wireGroups/{wireGroup}
Apiversion : 2026-12-01-preview
Description : Gets the specified wire group resource in the given scope.
Parameters :
project
Description : Project ID for this request.
Location : path
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])?))
Type : string
wireGroup
Location : path
Description : Name of the wire group resource to return.
Type : string
Required : Yes
crossSiteNetwork
Required : Yes
Location : path
Type : string
▼ ▲ compute.wireGroups.delete
Parameter Order :
HTTP Method : DELETE
Flat Path : projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}/wireGroups/{wireGroup}
Description : Deletes the specified wire group in the given scope.
Scopes :
Path : projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}/wireGroups/{wireGroup}
Parameters :
wireGroup
Type : string
Location : path
Required : Yes
Description : Name of the wire group resource to delete.
crossSiteNetwork
Location : path
Type : string
Required : Yes
requestId
Type : string
Location : query
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). end_interface: MixerMutationRequestBuilder
project
Description : Project ID for this request.
Location : path
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])?))
Apiversion : 2026-12-01-preview
▼ ▲ compute.wireGroups.list
HTTP Method : GET
Flat Path : projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}/wireGroups
Path : projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}/wireGroups
Scopes :
Apiversion : 2026-12-01-preview
Parameter Order :
Description : Lists the wire groups for a project in the given scope.
Parameters :
orderBy
Type : string
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.
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
crossSiteNetwork
Location : path
Required : Yes
Type : string
pageToken
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.
Type : string
maxResults
Format : uint32
Type : integer
Minimum : 0
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`)
filter
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.
Type : string
▼ ▲ compute.wireGroups.patch
Parameters :
crossSiteNetwork
Location : path
Required : Yes
Type : string
updateMask
Type : string
Format : google-fieldmask
Location : query
Description : update_mask indicates fields to be updated as part of this request.
requestId
Location : query
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). end_interface: MixerMutationRequestBuilder
Type : string
wireGroup
Required : Yes
Type : string
Location : path
Description : Name of the WireGroups resource to patch.
validateOnly
Description : [Input Only] Validate the new configuration, but don't update it.
Location : query
Type : boolean
project
Description : Project ID for this request.
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])?))
Location : path
Path : projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}/wireGroups/{wireGroup}
Scopes :
Apiversion : 2026-12-01-preview
Parameter Order :
Flat Path : projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}/wireGroups/{wireGroup}
Description : Updates the specified wire group resource with the data included in the request. This method supportsPATCH semantics and usesJSON merge patch format and processing rules.
HTTP Method : PATCH
▼ ▲ compute.regionHealthAggregationPolicies.delete
Description : Deletes the specified HealthAggregationPolicy in the given region.
Parameters :
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Description : Name of the region scoping this request.
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])?))
Location : path
Description : Project ID for this request.
Type : string
Required : Yes
healthAggregationPolicy
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Description : Name of the HealthAggregationPolicy resource to delete.
Type : string
Required : Yes
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 :
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/regions/{region}/healthAggregationPolicies/{healthAggregationPolicy}
Scopes :
Path : projects/{project}/regions/{region}/healthAggregationPolicies/{healthAggregationPolicy}
HTTP Method : DELETE
▼ ▲ compute.regionHealthAggregationPolicies.get
HTTP Method : GET
Path : projects/{project}/regions/{region}/healthAggregationPolicies/{healthAggregationPolicy}
Flat Path : projects/{project}/regions/{region}/healthAggregationPolicies/{healthAggregationPolicy}
Apiversion : 2026-12-01-preview
Parameters :
healthAggregationPolicy
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Required : Yes
Description : Name of the HealthAggregationPolicy resource to return.
region
Required : Yes
Type : string
Description : Name of the region scoping this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
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])?))
Description : Project ID for this request.
Required : Yes
Type : string
Parameter Order :
Scopes :
Description : Returns the specified HealthAggregationPolicy resource in the given region.
▼ ▲ compute.regionHealthAggregationPolicies.testIamPermissions
Description : Returns permissions that a caller has on the specified resource.
Scopes :
Flat Path : projects/{project}/regions/{region}/healthAggregationPolicies/{resource}/testIamPermissions
HTTP Method : POST
Path : projects/{project}/regions/{region}/healthAggregationPolicies/{resource}/testIamPermissions
Parameter Order :
Apiversion : 2026-12-01-preview
Parameters :
resource
Description : Name or id of the resource for this request.
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Location : path
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
Required : Yes
Description : Project ID for this request.
region
Required : Yes
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : The name of the region for this request.
Location : path
▼ ▲ compute.regionHealthAggregationPolicies.list
Path : projects/{project}/regions/{region}/healthAggregationPolicies
HTTP Method : GET
Parameter Order :
Description : Lists the HealthAggregationPolicies for a project in the given region.
Apiversion : 2026-12-01-preview
Scopes :
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.
Type : string
Location : query
region
Required : Yes
Description : Name of the region scoping this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Location : path
project
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])?))
Required : Yes
Location : path
Type : string
maxResults
Minimum : 0
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`)
Format : uint32
Type : integer
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
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
Flat Path : projects/{project}/regions/{region}/healthAggregationPolicies
▼ ▲ compute.regionHealthAggregationPolicies.insert
Parameter Order :
Apiversion : 2026-12-01-preview
Parameters :
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])?))
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).
region
Type : string
Location : path
Required : Yes
Description : Name of the region scoping this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Scopes :
HTTP Method : POST
Flat Path : projects/{project}/regions/{region}/healthAggregationPolicies
Description : Create a HealthAggregationPolicy in the specified project in the given region using the parameters that are included in the request.
Path : projects/{project}/regions/{region}/healthAggregationPolicies
▼ ▲ compute.regionHealthAggregationPolicies.patch
HTTP Method : PATCH
Description : Updates the specified regional HealthAggregationPolicy resource with the data included in the request. This method supportsPATCH semantics and uses theJSON merge patch format and processing rules.
Path : projects/{project}/regions/{region}/healthAggregationPolicies/{healthAggregationPolicy}
Flat Path : projects/{project}/regions/{region}/healthAggregationPolicies/{healthAggregationPolicy}
Scopes :
Apiversion : 2026-12-01-preview
Parameter Order :
Parameters :
region
Description : Name of the region scoping this request.
Required : Yes
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
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])?))
Type : string
Required : Yes
Location : path
Description : Project ID for this request.
healthAggregationPolicy
Type : string
Required : Yes
Location : path
Description : Name of the HealthAggregationPolicy to update. The name must be 1-63 characters long, and comply with RFC1035.
▼ ▲ compute.regionHealthAggregationPolicies.aggregatedList
Apiversion : 2026-12-01-preview
Scopes :
Parameters :
project
Location : path
Type : string
Description : Name of the project scoping 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])?))
Required : Yes
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
orderBy
Type : string
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.
includeAllScopes
Description : Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
Location : query
Type : boolean
maxResults
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`)
Minimum : 0
Type : integer
Location : query
Format : uint32
filter
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.
Location : query
serviceProjectNumber
Location : query
Format : int64
Type : string
Description : The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.
Parameter Order : project
Path : projects/{project}/aggregated/healthAggregationPolicies
HTTP Method : GET
Flat Path : projects/{project}/aggregated/healthAggregationPolicies
Description : Retrieves the list of all HealthAggregationPolicy resources, regional and global, available to the specified project. To prevent failure, it is recommended that you set the `returnPartialSuccess` parameter to `true`.
▼ ▲ compute.zoneOperations.get
Path : projects/{project}/zones/{zone}/operations/{operation}
Description : Retrieves the specified zone-specific Operations resource.
HTTP Method : GET
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.
Type : string
Required : Yes
operation
Description : Name of the Operations resource to return, or its unique numeric identifier.
Location : path
Type : string
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
zone
Location : path
Required : Yes
Description : Name of the zone for this request.
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/zones/{zone}/operations/{operation}
Parameter Order :
Scopes :
▼ ▲ compute.zoneOperations.delete
Apiversion : 2026-12-01-preview
Parameter Order :
Parameters :
zone
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Name of the zone for this request.
Required : Yes
Type : string
project
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])?))
Description : Project ID for this request.
Required : Yes
operation
Location : path
Description : Name of the Operations resource to delete, or its unique numeric identifier.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Required : Yes
Path : projects/{project}/zones/{zone}/operations/{operation}
Flat Path : projects/{project}/zones/{zone}/operations/{operation}
Scopes :
HTTP Method : DELETE
Description : Deletes the specified zone-specific Operations resource.
▼ ▲ compute.zoneOperations.list
HTTP Method : GET
Scopes :
Description : Retrieves a list of Operation resources contained within the specified zone.
Flat Path : projects/{project}/zones/{zone}/operations
Path : projects/{project}/zones/{zone}/operations
Parameter Order :
Parameters :
project
Location : path
Type : string
Description : Project ID for this request.
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])?))
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.
Type : string
Location : query
maxResults
Default : 500
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`)
Location : query
Format : uint32
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.
zone
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Name of the zone for request.
Type : string
Location : path
Required : Yes
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.
Apiversion : 2026-12-01-preview
▼ ▲ compute.zoneOperations.wait
Apiversion : 2026-12-01-preview
Path : projects/{project}/zones/{zone}/operations/{operation}/wait
Parameters :
zone
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Location : path
Description : Name of the zone for this request.
operation
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the Operations resource to return, or its unique numeric identifier.
Type : string
Location : path
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
Scopes :
Parameter Order :
Description : Waits for the specified Operation resource to return as `DONE` or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource. This method waits for no more than the 2 minutes and then returns the current state of the operation, which might be `DONE` or still in progress. This method is called on a best-effort basis. Specifically: - In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. - If the default deadline is reached, there is no guarantee that the operation is actually done when the method returns. Be prepared to retry if the operation is not `DONE`.
HTTP Method : POST
Flat Path : projects/{project}/zones/{zone}/operations/{operation}/wait
▼ ▲ compute.regionSslPolicies.testIamPermissions
Apiversion : 2026-12-01-preview
Description : Returns permissions that a caller has on the specified resource.
Parameters :
region
Location : path
Description : The name of the region for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Required : Yes
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])?))
Description : Project ID for this request.
Required : Yes
Type : string
resource
Location : path
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Description : Name or id of the resource for this request.
Parameter Order :
Path : projects/{project}/regions/{region}/sslPolicies/{resource}/testIamPermissions
HTTP Method : POST
Flat Path : projects/{project}/regions/{region}/sslPolicies/{resource}/testIamPermissions
Scopes :
▼ ▲ compute.regionSslPolicies.delete
Description : Deletes the specified SSL policy. The SSL policy resource can be deleted only if it is not in use by any TargetHttpsProxy or TargetSslProxy resources.
Parameters :
sslPolicy
Location : path
Description : Name of the SSL policy to delete. The name must be 1-63 characters long, and comply with RFC1035.
Type : string
Required : Yes
project
Location : path
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 : Project ID for this request.
region
Type : string
Location : path
Required : Yes
Description : Name of the region scoping this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
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).
Apiversion : 2026-12-01-preview
Scopes :
Parameter Order :
Path : projects/{project}/regions/{region}/sslPolicies/{sslPolicy}
Flat Path : projects/{project}/regions/{region}/sslPolicies/{sslPolicy}
HTTP Method : DELETE
▼ ▲ compute.regionSslPolicies.list
HTTP Method : GET
Flat Path : projects/{project}/regions/{region}/sslPolicies
Description : Lists all the SSL policies that have been configured for the specified project and region.
Apiversion : 2026-12-01-preview
Parameters :
region
Required : Yes
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Name of the region scoping this request.
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
Required : Yes
Type : string
Location : path
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])?))
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`)
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.
Location : query
Type : string
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.
Scopes :
Parameter Order :
Path : projects/{project}/regions/{region}/sslPolicies
▼ ▲ compute.regionSslPolicies.listAvailableFeatures
HTTP Method : GET
Description : Lists all features that can be specified in the SSL policy when using custom profile.
Parameter Order :
Scopes :
Flat Path : projects/{project}/regions/{region}/sslPolicies/listAvailableFeatures
Apiversion : 2026-12-01-preview
Path : projects/{project}/regions/{region}/sslPolicies/listAvailableFeatures
Parameters :
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.
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])?))
Description : Project ID for this request.
Type : string
Required : Yes
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
maxResults
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
Location : query
Type : integer
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.
region
Location : path
Description : Name of the region scoping this request.
Required : Yes
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
▼ ▲ compute.regionSslPolicies.insert
HTTP Method : POST
Path : projects/{project}/regions/{region}/sslPolicies
Parameter Order :
Description : Creates a new policy in the specified project and region using the data included in the request.
Parameters :
requestId
Location : query
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
project
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])?))
Description : Project ID for this request.
Location : path
Required : Yes
region
Description : Name of the region scoping this request.
Required : Yes
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Scopes :
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/regions/{region}/sslPolicies
▼ ▲ compute.regionSslPolicies.getIamPolicy
HTTP Method : GET
Parameter Order :
Description : Gets the access control policy for a resource. May be empty if no such policy or resource exists.
Flat Path : projects/{project}/regions/{region}/sslPolicies/{resource}/getIamPolicy
Scopes :
Apiversion : 2026-12-01-preview
Path : projects/{project}/regions/{region}/sslPolicies/{resource}/getIamPolicy
Parameters :
optionsRequestedPolicyVersion
Type : integer
Format : int32
Location : query
Description : Requested IAM Policy version.
resource
Required : Yes
Description : Name or id of the resource for this request.
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
region
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : The name of the region for this request.
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])?))
Required : Yes
Type : string
Location : path
Description : Project ID for this request.
▼ ▲ compute.regionSslPolicies.get
Flat Path : projects/{project}/regions/{region}/sslPolicies/{sslPolicy}
Scopes :
Parameter Order :
HTTP Method : GET
Path : projects/{project}/regions/{region}/sslPolicies/{sslPolicy}
Apiversion : 2026-12-01-preview
Parameters :
sslPolicy
Location : path
Type : string
Description : Name of the SSL policy to update. The name must be 1-63 characters long, and comply with RFC1035.
Required : Yes
project
Required : Yes
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])?))
Type : string
Location : path
region
Required : Yes
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Name of the region scoping this request.
Location : path
Description : Lists all of the ordered rules present in a single specified policy.
▼ ▲ compute.regionSslPolicies.setIamPolicy
HTTP Method : POST
Description : Sets the access control policy on the specified resource. Replaces any existing policy.
Parameter Order :
Flat Path : projects/{project}/regions/{region}/sslPolicies/{resource}/setIamPolicy
Apiversion : 2026-12-01-preview
Scopes :
Parameters :
resource
Description : Name or id of the resource for this request.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Type : string
region
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : The name of the region for this request.
Type : string
Required : Yes
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
Type : string
Description : Project ID for this request.
Required : Yes
Path : projects/{project}/regions/{region}/sslPolicies/{resource}/setIamPolicy
▼ ▲ compute.regionSslPolicies.patch
Flat Path : projects/{project}/regions/{region}/sslPolicies/{sslPolicy}
HTTP Method : PATCH
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
Description : Project ID for this request.
Location : path
Type : string
sslPolicy
Description : Name of the SSL policy to update. The name must be 1-63 characters long, and comply with RFC1035.
Type : string
Location : path
Required : Yes
region
Type : string
Location : path
Description : Name of the region scoping this request.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
requestId
Type : string
Location : query
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).
Path : projects/{project}/regions/{region}/sslPolicies/{sslPolicy}
Scopes :
Apiversion : 2026-12-01-preview
Description : Patches the specified SSL policy with the data included in the request.
Parameter Order :
▼ ▲ compute.licenseCodes.testIamPermissions
Path : projects/{project}/global/licenseCodes/{resource}/testIamPermissions
Parameter Order :
Description : Returns permissions that a caller has on the specified resource. *Caution* This resource is intended for use only by third-party partners who are creatingCloud Marketplace images.
HTTP Method : POST
Parameters :
project
Description : Project ID for this request.
Required : Yes
Location : path
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])?))
resource
Location : path
Required : Yes
Type : string
Pattern : [a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name or id of the resource for this request.
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/global/licenseCodes/{resource}/testIamPermissions
Scopes :
▼ ▲ compute.licenseCodes.setIamPolicy
Parameter Order :
Description : Sets the access control policy on the specified resource. Replaces any existing policy. *Caution* This resource is intended for use only by third-party partners who are creatingCloud Marketplace images.
Parameters :
project
Required : Yes
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])?))
Type : string
Location : path
resource
Pattern : [a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name or id of the resource for this request.
Location : path
Type : string
Required : Yes
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/global/licenseCodes/{resource}/setIamPolicy
HTTP Method : POST
Scopes :
Path : projects/{project}/global/licenseCodes/{resource}/setIamPolicy
▼ ▲ compute.licenseCodes.getIamPolicy
Apiversion : 2026-12-01-preview
Parameters :
resource
Location : path
Description : Name or id of the resource for this request.
Required : Yes
Type : string
Pattern : [a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
optionsRequestedPolicyVersion
Description : Requested IAM Policy version.
Format : int32
Location : query
Type : integer
project
Type : string
Required : Yes
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])?))
Flat Path : projects/{project}/global/licenseCodes/{resource}/getIamPolicy
Scopes :
Description : Gets the access control policy for a resource. May be empty if no such policy or resource exists. *Caution* This resource is intended for use only by third-party partners who are creatingCloud Marketplace images.
HTTP Method : GET
Parameter Order :
Path : projects/{project}/global/licenseCodes/{resource}/getIamPolicy
▼ ▲ compute.licenseCodes.get
Path : projects/{project}/global/licenseCodes/{licenseCode}
HTTP Method : GET
Parameter Order :
Description : Return a specified license code. License codes are mirrored across all projects that have permissions to read the License Code. *Caution* This resource is intended for use only by third-party partners who are creatingCloud Marketplace images.
Apiversion : 2026-12-01-preview
Parameters :
licenseCode
Location : path
Pattern : [0-9]{0,61}?
Type : string
Description : Number corresponding to the License code resource to return.
Required : Yes
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])?))
Location : path
Description : Project ID for this request.
Type : string
Flat Path : projects/{project}/global/licenseCodes/{licenseCode}
Scopes :
▼ ▲ compute.interconnects.setLabels
Flat Path : projects/{project}/global/interconnects/{resource}/setLabels
Parameters :
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])?))
Description : Project ID for this request.
Type : string
Required : Yes
resource
Description : Name or id of the resource for this request.
Location : path
Type : string
Pattern : [a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Apiversion : 2026-12-01-preview
Scopes :
Parameter Order :
Description : Sets the labels on an Interconnect. To learn more about labels, read the Labeling Resources documentation.
HTTP Method : POST
Path : projects/{project}/global/interconnects/{resource}/setLabels
▼ ▲ compute.interconnects.patch
Path : projects/{project}/global/interconnects/{interconnect}
Scopes :
HTTP Method : PATCH
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
project
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])?))
Location : path
Required : Yes
interconnect
Description : Name of the interconnect to update.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Required : Yes
Location : path
Apiversion : 2026-12-01-preview
Description : Updates the specified Interconnect with the data included in the request. This method supportsPATCH semantics and uses theJSON merge patch format and processing rules.
Parameter Order :
Flat Path : projects/{project}/global/interconnects/{interconnect}
▼ ▲ compute.interconnects.getMacsecConfig
Parameter Order :
Scopes :
Description : Returns the interconnectMacsecConfig for the specified Interconnect.
Path : projects/{project}/global/interconnects/{interconnect}/getMacsecConfig
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/global/interconnects/{interconnect}/getMacsecConfig
Parameters :
interconnect
Required : Yes
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the interconnect resource to query.
project
Location : path
Description : Project ID for this request.
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])?))
HTTP Method : GET
▼ ▲ compute.interconnects.list
HTTP Method : GET
Parameter Order : project
Description : Retrieves the list of Interconnects available to the specified project.
Scopes :
Flat Path : projects/{project}/global/interconnects
Path : projects/{project}/global/interconnects
Apiversion : 2026-12-01-preview
Parameters :
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.
maxResults
Location : query
Format : uint32
Default : 500
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`)
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.
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.
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])?))
Description : Project ID for this request.
Type : string
Required : Yes
▼ ▲ compute.interconnects.setName
Path : projects/{project}/global/interconnects/{interconnect}/setName
HTTP Method : POST
Description : Sets name of an interconnect.
Scopes :
Parameter Order :
Flat Path : projects/{project}/global/interconnects/{interconnect}/setName
Apiversion : 2026-12-01-preview
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).
Location : query
Type : string
project
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])?))
Location : path
interconnect
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the interconnect to update.
Type : string
Required : Yes
Location : path
▼ ▲ compute.interconnects.insert
Parameters :
project
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])?))
Required : Yes
Location : path
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).
Type : string
Location : query
Scopes :
Parameter Order : project
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/global/interconnects
Path : projects/{project}/global/interconnects
Description : Creates an Interconnect in the specified project using the data included in the request.
HTTP Method : POST
▼ ▲ compute.interconnects.delete
Scopes :
Description : Deletes the specified Interconnect.
Apiversion : 2026-12-01-preview
Parameter Order :
Parameters :
interconnect
Description : Name of the interconnect to delete.
Required : Yes
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
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).
project
Type : string
Location : path
Description : Project ID for this request.
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])?))
HTTP Method : DELETE
Flat Path : projects/{project}/global/interconnects/{interconnect}
Path : projects/{project}/global/interconnects/{interconnect}
▼ ▲ compute.interconnects.getDiagnostics
HTTP Method : GET
Description : Returns the interconnectDiagnostics for the specified Interconnect. In the event of a global outage, do not use this API to make decisions about where to redirect your network traffic. Unlike a VLAN attachment, which is regional, a Cloud Interconnect connection is a global resource. A global outage can prevent this API from functioning properly.
Path : projects/{project}/global/interconnects/{interconnect}/getDiagnostics
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/global/interconnects/{interconnect}/getDiagnostics
Parameters :
interconnect
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Required : Yes
Description : Name of the interconnect resource to query.
Location : path
project
Location : path
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])?))
Type : string
Required : Yes
Scopes :
Parameter Order :
▼ ▲ compute.interconnects.get
HTTP Method : GET
Parameter Order :
Flat Path : projects/{project}/global/interconnects/{interconnect}
Description : Returns the specified Interconnect. Get a list of available Interconnects by making a list() request.
Scopes :
Path : projects/{project}/global/interconnects/{interconnect}
Apiversion : 2026-12-01-preview
Parameters :
interconnect
Required : Yes
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the interconnect to return.
project
Description : Project ID for this request.
Type : string
Location : path
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])?))
▼ ▲ compute.regionNotificationEndpoints.aggregatedList
Flat Path : projects/{project}/aggregated/notificationEndpoints
Description : Retrieves the list of all NotificationEndpoint resources, regional and global, available to the specified project.
HTTP Method : GET
Parameters :
orderBy
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.
Location : query
includeAllScopes
Location : query
Type : boolean
Description : Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
project
Location : path
Required : Yes
Type : string
Description : Name of the project scoping 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])?))
serviceProjectNumber
Location : query
Type : string
Description : The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.
Format : int64
maxResults
Format : uint32
Type : integer
Default : 500
Minimum : 0
Location : query
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`)
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.
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.
Scopes :
Path : projects/{project}/aggregated/notificationEndpoints
Apiversion : 2026-12-01-preview
Parameter Order : project
▼ ▲ compute.regionNotificationEndpoints.list
Apiversion : 2026-12-01-preview
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])?))
Required : Yes
Location : path
Type : string
Description : Project ID for this request.
region
Description : Name of the region scoping this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Required : Yes
Type : string
orderBy
Type : string
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.
filter
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.
Location : query
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
maxResults
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`)
Location : query
Format : uint32
Default : 500
Type : integer
Flat Path : projects/{project}/regions/{region}/notificationEndpoints
Scopes :
HTTP Method : GET
Path : projects/{project}/regions/{region}/notificationEndpoints
Description : Lists the NotificationEndpoints for a project in the given region.
▼ ▲ compute.regionNotificationEndpoints.testIamPermissions
Apiversion : 2026-12-01-preview
Parameter Order :
Parameters :
project
Location : path
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.
Type : string
region
Required : Yes
Description : The name of the region for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Location : path
resource
Type : string
Description : Name or id of the resource for this request.
Location : path
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Path : projects/{project}/regions/{region}/notificationEndpoints/{resource}/testIamPermissions
Flat Path : projects/{project}/regions/{region}/notificationEndpoints/{resource}/testIamPermissions
Scopes :
Description : Returns permissions that a caller has on the specified resource.
HTTP Method : POST
▼ ▲ compute.regionNotificationEndpoints.get
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/regions/{region}/notificationEndpoints/{notificationEndpoint}
Parameter Order :
Parameters :
notificationEndpoint
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Description : Name of the NotificationEndpoint resource to return.
Location : path
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Name of the region scoping this request.
Required : Yes
Type : string
Location : path
project
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])?))
Description : Project ID for this request.
Location : path
Scopes :
Path : projects/{project}/regions/{region}/notificationEndpoints/{notificationEndpoint}
Description : Returns the specified NotificationEndpoint resource in the given region.
HTTP Method : GET
▼ ▲ compute.regionNotificationEndpoints.insert
Parameter Order :
Description : Create a NotificationEndpoint in the specified project in the given region using the parameters that are included in the request.
Apiversion : 2026-12-01-preview
Scopes :
Parameters :
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Required : Yes
Description : Name of the region scoping this request.
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).
Type : string
Location : query
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])?))
Location : path
Type : string
Description : Project ID for this request.
Path : projects/{project}/regions/{region}/notificationEndpoints
Flat Path : projects/{project}/regions/{region}/notificationEndpoints
HTTP Method : POST
▼ ▲ compute.regionNotificationEndpoints.delete
Parameters :
notificationEndpoint
Description : Name of the NotificationEndpoint resource to delete.
Required : Yes
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
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
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Location : path
Description : Name of the region scoping this request.
Required : Yes
project
Description : Project ID for this request.
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])?))
Location : path
Description : Deletes the specified NotificationEndpoint in the given region
Apiversion : 2026-12-01-preview
Path : projects/{project}/regions/{region}/notificationEndpoints/{notificationEndpoint}
Flat Path : projects/{project}/regions/{region}/notificationEndpoints/{notificationEndpoint}
Parameter Order :
HTTP Method : DELETE
Scopes :
▼ ▲ compute.imageViews.list
Description : Returns a list of global ImageView resources, with a regional context.
Parameter Order :
Path : projects/{project}/regions/{region}/imageViews
Apiversion : 2026-12-01-preview
Parameters :
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.
maxResults
Type : integer
Format : uint32
Location : query
Minimum : 0
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`)
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.
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
project
Location : path
Description : Required. Project ID for this request.
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])?))
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Required. Name of the region for this request.
Type : string
Required : Yes
Location : path
HTTP Method : GET
Scopes :
Flat Path : projects/{project}/regions/{region}/imageViews
▼ ▲ compute.imageViews.get
Description : Returns the specified global ImageView resource, with a regional context.
Parameters :
region
Description : Required. Name of the region for this request.
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Location : path
resourceId
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Required : Yes
Location : path
Description : Name of the image resource to return.
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])?))
Type : string
Description : Required. Project ID for this request.
Required : Yes
Location : path
Path : projects/{project}/regions/{region}/imageViews/{resourceId}
Apiversion : 2026-12-01-preview
Parameter Order :
Scopes :
HTTP Method : GET
Flat Path : projects/{project}/regions/{region}/imageViews/{resourceId}
▼ ▲ compute.forwardingRules.setLabels
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
Description : Project ID for this request.
Type : string
Required : Yes
resource
Description : Name or id of the resource for this request.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Type : string
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : The region for this request.
Location : path
Required : Yes
Type : string
requestId
Type : string
Location : query
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).
Path : projects/{project}/regions/{region}/forwardingRules/{resource}/setLabels
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/regions/{region}/forwardingRules/{resource}/setLabels
Scopes :
Description : Sets the labels on the specified resource. To learn more about labels, read the Labeling Resources documentation.
HTTP Method : POST
▼ ▲ compute.forwardingRules.aggregatedList
Parameters :
includeAllScopes
Location : query
Description : Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
Type : boolean
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
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.
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
Location : path
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])?))
Type : string
Required : Yes
maxResults
Default : 500
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`)
Location : query
Type : integer
Format : uint32
serviceProjectNumber
Type : string
Format : int64
Location : query
Description : The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.
Apiversion : 2026-12-01-preview
Path : projects/{project}/aggregated/forwardingRules
Description : Retrieves an aggregated list of forwarding rules. To prevent failure, it is recommended that you set the `returnPartialSuccess` parameter to `true`.
Parameter Order : project
Flat Path : projects/{project}/aggregated/forwardingRules
Scopes :
HTTP Method : GET
▼ ▲ compute.forwardingRules.list
Scopes :
Path : projects/{project}/regions/{region}/forwardingRules
Description : Retrieves a list of ForwardingRule resources available to the specified project and region.
Flat Path : projects/{project}/regions/{region}/forwardingRules
Parameter Order :
HTTP Method : GET
Parameters :
region
Description : Name of the region scoping this request.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Location : path
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
Required : Yes
Description : Project ID for this request.
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])?))
Location : path
filter
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.
Type : string
orderBy
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.
Location : query
maxResults
Type : integer
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
Minimum : 0
Format : uint32
Location : query
Apiversion : 2026-12-01-preview
▼ ▲ compute.forwardingRules.delete
HTTP Method : DELETE
Path : projects/{project}/regions/{region}/forwardingRules/{forwardingRule}
Flat Path : projects/{project}/regions/{region}/forwardingRules/{forwardingRule}
Apiversion : 2026-12-01-preview
Parameter Order :
Scopes :
Parameters :
requestId
Location : query
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
forwardingRule
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Description : Name of the ForwardingRule resource to delete.
Location : path
Type : string
region
Type : string
Location : path
Description : Name of the region scoping this request.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
project
Required : Yes
Description : Project ID for this request.
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])?))
Description : Deletes the specified ForwardingRule resource.
▼ ▲ compute.forwardingRules.setTarget
Parameter Order :
Scopes :
Flat Path : projects/{project}/regions/{region}/forwardingRules/{forwardingRule}/setTarget
Apiversion : 2026-12-01-preview
Parameters :
project
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])?))
Type : string
Location : path
Required : Yes
forwardingRule
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Type : string
Location : path
Description : Name of the ForwardingRule resource in which target is to be set.
requestId
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).
Location : query
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Location : path
Required : Yes
Description : Name of the region scoping this request.
Description : Changes target URL for forwarding rule. The new target should be of the same type as the old target.
HTTP Method : POST
Path : projects/{project}/regions/{region}/forwardingRules/{forwardingRule}/setTarget
▼ ▲ compute.forwardingRules.insert
Flat Path : projects/{project}/regions/{region}/forwardingRules
HTTP Method : POST
Scopes :
Parameters :
requestId
Type : string
Location : query
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).
region
Location : path
Required : Yes
Type : string
Description : Name of the region scoping this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
project
Description : Project ID for this request.
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])?))
Location : path
Type : string
Description : Creates a ForwardingRule resource in the specified project and region using the data included in the request.
Path : projects/{project}/regions/{region}/forwardingRules
Apiversion : 2026-12-01-preview
Parameter Order :
▼ ▲ compute.forwardingRules.get
HTTP Method : GET
Flat Path : projects/{project}/regions/{region}/forwardingRules/{forwardingRule}
Description : Returns the specified ForwardingRule resource.
Parameter Order :
Apiversion : 2026-12-01-preview
Scopes :
Parameters :
project
Type : string
Required : Yes
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])?))
view
Location : query
Type : string
Enum Descriptions :
Enum :
forwardingRule
Type : string
Location : path
Required : Yes
Description : Name of the ForwardingRule resource to return.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
region
Location : path
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Name of the region scoping this request.
Required : Yes
Path : projects/{project}/regions/{region}/forwardingRules/{forwardingRule}
▼ ▲ compute.forwardingRules.patch
Apiversion : 2026-12-01-preview
Parameters :
region
Description : Name of the region scoping this request.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Type : string
project
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])?))
Location : path
Required : Yes
Type : string
forwardingRule
Description : Name of the ForwardingRule resource to patch.
Required : Yes
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
requestId
Type : string
Location : query
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 :
Scopes :
Flat Path : projects/{project}/regions/{region}/forwardingRules/{forwardingRule}
Path : projects/{project}/regions/{region}/forwardingRules/{forwardingRule}
HTTP Method : PATCH
Description : Updates the specified forwarding rule with the data included in the request. This method supportsPATCH semantics and uses theJSON merge patch format and processing rules. Currently, you can only patch the network_tier field.
▼ ▲ compute.organizationSecurityPolicies.addRule
Flat Path : locations/global/securityPolicies/{securityPolicy}/addRule
HTTP Method : POST
Path : locations/global/securityPolicies/{securityPolicy}/addRule
Description : Inserts a rule into a security policy. Use this API to modify Cloud Armor policies. Previously, alpha and beta versions of this API were used to modify firewall policies. This usage is now disabled for most organizations. Use firewallPolicies.addRule instead.
Scopes :
Parameter Order : securityPolicy
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).
Location : query
Type : string
securityPolicy
Location : path
Type : string
Pattern : (securityPolicies/)?[0-9]{0,20}
Description : Name of the security policy to update.
Required : Yes
Apiversion : 2026-12-01-preview
▼ ▲ compute.organizationSecurityPolicies.get
Parameter Order : securityPolicy
Scopes :
Description : List all of the ordered rules present in a single specified policy. Use this API to read Cloud Armor policies. Previously, alpha and beta versions of this API were used to read firewall policies. This usage is now disabled for most organizations. Use firewallPolicies.get instead.
Parameters :
securityPolicy
Required : Yes
Description : Name of the security policy to get.
Type : string
Location : path
Pattern : (securityPolicies/)?[0-9]{0,20}
Apiversion : 2026-12-01-preview
Path : locations/global/securityPolicies/{securityPolicy}
HTTP Method : GET
Flat Path : locations/global/securityPolicies/{securityPolicy}
▼ ▲ compute.organizationSecurityPolicies.copyRules
Description : Copies rules to the specified security policy. Use this API to modify Cloud Armor policies. Previously, alpha and beta versions of this API were used to modify firewall policies. This usage is now disabled for most organizations. Use firewallPolicies.cloneRules instead.
Flat Path : locations/global/securityPolicies/{securityPolicy}/copyRules
HTTP Method : POST
Parameter Order : securityPolicy
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
securityPolicy
Type : string
Location : path
Required : Yes
Description : Name of the security policy to update.
Pattern : (securityPolicies/)?[0-9]{0,20}
sourceSecurityPolicy
Location : query
Description : The security policy from which to copy rules.
Type : string
Apiversion : 2026-12-01-preview
Scopes :
Path : locations/global/securityPolicies/{securityPolicy}/copyRules
▼ ▲ compute.organizationSecurityPolicies.listAssociations
HTTP Method : GET
Scopes :
Path : locations/global/securityPolicies/listAssociations
Description : Lists associations of a specified target, i.e., organization or folder. Use this API to read Cloud Armor policies. Previously, alpha and beta versions of this API were used to read firewall policies. This usage is now disabled for most organizations. Use firewallPolicies.listAssociations instead.
Flat Path : locations/global/securityPolicies/listAssociations
Apiversion : 2026-12-01-preview
Parameters :
targetResource
Location : query
Description : The target resource to list associations. It is an organization, or a folder.
Type : string
▼ ▲ compute.organizationSecurityPolicies.move
Scopes :
Flat Path : locations/global/securityPolicies/{securityPolicy}/move
Description : Moves the specified security policy. Use this API to modify Cloud Armor policies. Previously, alpha and beta versions of this API were used to modify firewall policies. This usage is now disabled for most organizations. Use firewallPolicies.move instead.
Parameters :
parentId
Description : The new parent of the security policy.
Location : query
Type : string
requestId
Location : query
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
securityPolicy
Location : path
Pattern : (securityPolicies/)?[0-9]{0,20}
Type : string
Description : Name of the security policy to update.
Required : Yes
Apiversion : 2026-12-01-preview
Parameter Order : securityPolicy
HTTP Method : POST
Path : locations/global/securityPolicies/{securityPolicy}/move
▼ ▲ compute.organizationSecurityPolicies.patchRule
Scopes :
Flat Path : locations/global/securityPolicies/{securityPolicy}/patchRule
HTTP Method : POST
Path : locations/global/securityPolicies/{securityPolicy}/patchRule
Apiversion : 2026-12-01-preview
Parameter Order : securityPolicy
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
priority
Location : query
Description : The priority of the rule to patch.
Type : integer
Format : int32
securityPolicy
Required : Yes
Description : Name of the security policy to update.
Type : string
Location : path
Pattern : (securityPolicies/)?[0-9]{0,20}
Description : Patches a rule at the specified priority. Use this API to modify Cloud Armor policies. Previously, alpha and beta versions of this API were used to modify firewall policies. This usage is now disabled for most organizations. Use firewallPolicies.patchRule instead.
▼ ▲ compute.organizationSecurityPolicies.patch
Path : locations/global/securityPolicies/{securityPolicy}
HTTP Method : PATCH
Description : Patches the specified policy with the data included in the request. Use this API to modify Cloud Armor policies. Previously, alpha and beta versions of this API were used to modify firewall policies. This usage is now disabled for most organizations. Use firewallPolicies.patch instead.
Scopes :
Parameters :
requestId
Location : query
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
securityPolicy
Type : string
Pattern : (securityPolicies/)?[0-9]{0,20}
Required : Yes
Location : path
Description : Name of the security policy to update.
Apiversion : 2026-12-01-preview
Flat Path : locations/global/securityPolicies/{securityPolicy}
Parameter Order : securityPolicy
▼ ▲ compute.organizationSecurityPolicies.removeRule
HTTP Method : POST
Path : locations/global/securityPolicies/{securityPolicy}/removeRule
Scopes :
Flat Path : locations/global/securityPolicies/{securityPolicy}/removeRule
Description : Deletes a rule at the specified priority. Use this API to modify Cloud Armor policies. Previously, alpha and beta versions of this API were used to modify firewall policies. This usage is now disabled for most organizations. Use firewallPolicies.removeRule instead.
Parameter Order : securityPolicy
Apiversion : 2026-12-01-preview
Parameters :
requestId
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).
Location : query
priority
Description : The priority of the rule to remove from the security policy.
Format : int32
Location : query
Type : integer
securityPolicy
Required : Yes
Description : Name of the security policy to update.
Location : path
Pattern : (securityPolicies/)?[0-9]{0,20}
Type : string
▼ ▲ compute.organizationSecurityPolicies.removeAssociation
HTTP Method : POST
Path : locations/global/securityPolicies/{securityPolicy}/removeAssociation
Description : Removes an association for the specified security policy. Use this API to modify Cloud Armor policies. Previously, alpha and beta versions of this API were used to modify firewall policies. This usage is now disabled for most organizations. Use firewallPolicies.removeAssociation instead.
Scopes :
Flat Path : locations/global/securityPolicies/{securityPolicy}/removeAssociation
Parameter Order : securityPolicy
Parameters :
securityPolicy
Location : path
Description : Name of the security policy to update.
Type : string
Required : Yes
Pattern : (securityPolicies/)?[0-9]{0,20}
name
Type : string
Location : query
Description : Name for the attachment that will be removed.
requestId
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).
Location : query
Apiversion : 2026-12-01-preview
▼ ▲ compute.organizationSecurityPolicies.addAssociation
Description : Inserts an association for the specified security policy. This has billing implications. Projects in the hierarchy with effective hierarchical security policies will be automatically enrolled into Cloud Armor Enterprise if not already enrolled. Use this API to modify Cloud Armor policies. Previously, alpha and beta versions of this API were used to modify firewall policies. This usage is now disabled for most organizations. Use firewallPolicies.addAssociation instead.
Path : locations/global/securityPolicies/{securityPolicy}/addAssociation
HTTP Method : POST
Parameter Order : securityPolicy
Flat Path : locations/global/securityPolicies/{securityPolicy}/addAssociation
Parameters :
requestId
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).
Location : query
replaceExistingAssociation
Type : boolean
Description : Indicates whether or not to replace it if an association of the attachment already exists. This is false by default, in which case an error will be returned if an association already exists.
Location : query
securityPolicy
Description : Name of the security policy to update.
Required : Yes
Pattern : (securityPolicies/)?[0-9]{0,20}
Location : path
Type : string
Scopes :
Apiversion : 2026-12-01-preview
▼ ▲ compute.organizationSecurityPolicies.delete
Description : Deletes the specified policy. Use this API to remove Cloud Armor policies. Previously, alpha and beta versions of this API were used to remove firewall policies. This usage is now disabled for most organizations. Use firewallPolicies.delete instead.
Scopes :
Parameters :
securityPolicy
Required : Yes
Pattern : (securityPolicies/)?[0-9]{0,20}
Description : Name of the security policy to delete.
Type : string
Location : path
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).
Apiversion : 2026-12-01-preview
HTTP Method : DELETE
Flat Path : locations/global/securityPolicies/{securityPolicy}
Path : locations/global/securityPolicies/{securityPolicy}
Parameter Order : securityPolicy
▼ ▲ compute.organizationSecurityPolicies.listPreconfiguredExpressionSets
Description : Gets the current list of preconfigured Web Application Firewall (WAF) expressions.
Scopes :
Path : locations/global/securityPolicies/listPreconfiguredExpressionSets
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`)
Type : integer
Location : query
Default : 500
Minimum : 0
Format : uint32
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.
Type : string
Location : query
parentId
Location : query
Description : Parent ID for this request.
Type : string
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
filter
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.
Type : string
Apiversion : 2026-12-01-preview
HTTP Method : GET
Flat Path : locations/global/securityPolicies/listPreconfiguredExpressionSets
▼ ▲ compute.organizationSecurityPolicies.list
Scopes :
Description : List all the policies that have been configured for the specified organization. Use this API to read Cloud Armor policies. Previously, alpha and beta versions of this API were used to read firewall policies. This usage is now disabled for most organizations. Use firewallPolicies.list instead.
Flat Path : locations/global/securityPolicies
HTTP Method : GET
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.
Type : string
Location : query
maxResults
Default : 500
Minimum : 0
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`)
Type : integer
Location : query
parentId
Location : query
Type : string
Description : Parent ID for this request.
filter
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.
Type : string
orderBy
Type : string
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.
Apiversion : 2026-12-01-preview
Path : locations/global/securityPolicies
▼ ▲ compute.organizationSecurityPolicies.getAssociation
Path : locations/global/securityPolicies/{securityPolicy}/getAssociation
Parameter Order : securityPolicy
Apiversion : 2026-12-01-preview
Scopes :
Parameters :
securityPolicy
Pattern : (securityPolicies/)?[0-9]{0,20}
Required : Yes
Type : string
Location : path
Description : Name of the security policy to which the queried rule belongs.
name
Location : query
Type : string
Description : The name of the association to get from the security policy.
HTTP Method : GET
Flat Path : locations/global/securityPolicies/{securityPolicy}/getAssociation
Description : Gets an association with the specified name. Use this API to read Cloud Armor policies. Previously, alpha and beta versions of this API were used to read firewall policies. This usage is now disabled for most organizations. Use firewallPolicies.getAssociation instead.
▼ ▲ compute.organizationSecurityPolicies.getRule
HTTP Method : GET
Description : Gets a rule at the specified priority. Use this API to read Cloud Armor policies. Previously, alpha and beta versions of this API were used to read firewall policies. This usage is now disabled for most organizations. Use firewallPolicies.getRule instead.
Parameter Order : securityPolicy
Path : locations/global/securityPolicies/{securityPolicy}/getRule
Parameters :
securityPolicy
Type : string
Pattern : (securityPolicies/)?[0-9]{0,20}
Location : path
Description : Name of the security policy to which the queried rule belongs.
Required : Yes
priority
Location : query
Type : integer
Description : The priority of the rule to get from the security policy.
Format : int32
Scopes :
Apiversion : 2026-12-01-preview
Flat Path : locations/global/securityPolicies/{securityPolicy}/getRule
▼ ▲ compute.organizationSecurityPolicies.insert
Description : Creates a new policy in the specified organization using the data included in the request. Use this API to add Cloud Armor policies. Previously, alpha and beta versions of this API were used to add firewall policies. This usage is now disabled for most organizations. Use firewallPolicies.insert instead.
Parameters :
requestId
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).
Location : query
parentId
Type : string
Location : query
Description : Parent ID for this request. The ID can be either be "folders/[FOLDER_ID]" if the parent is a folder or "organizations/[ORGANIZATION_ID]" if the parent is an organization.
Path : locations/global/securityPolicies
Apiversion : 2026-12-01-preview
Scopes :
HTTP Method : POST
Flat Path : locations/global/securityPolicies
▼ ▲ compute.globalOrganizationOperations.list
Scopes :
HTTP Method : GET
Description : Retrieves a list of Operation resources contained within the specified organization.
Flat Path : locations/global/operations
Path : locations/global/operations
Apiversion : 2026-12-01-preview
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
parentId
Description : Parent ID for this request.
Type : string
Location : query
maxResults
Type : integer
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`)
Location : query
Minimum : 0
Default : 500
Format : uint32
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.
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
▼ ▲ compute.globalOrganizationOperations.get
Parameters :
parentId
Location : query
Type : string
Description : Parent ID for this request. Not used. Parent is derived from resource_id.
operation
Location : path
Description : Name of the Operations resource to return. Parent is derived from this field.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Required : Yes
Apiversion : 2026-12-01-preview
Scopes :
Flat Path : locations/global/operations/{operation}
Description : Retrieves the specified Operations resource. Gets a list of operations by making a `list()` request.
Parameter Order : operation
HTTP Method : GET
Path : locations/global/operations/{operation}
▼ ▲ compute.globalOrganizationOperations.delete
Path : locations/global/operations/{operation}
Parameters :
operation
Required : Yes
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the Operations resource to delete, or its unique numeric identifier.
Location : path
parentId
Description : Parent ID for this request.
Type : string
Location : query
Apiversion : 2026-12-01-preview
Description : Deletes the specified Operations resource.
HTTP Method : DELETE
Scopes :
Parameter Order : operation
Flat Path : locations/global/operations/{operation}
▼ ▲ compute.regionBackendServices.getIamPolicy
Scopes :
Flat Path : projects/{project}/regions/{region}/backendServices/{resource}/getIamPolicy
Parameter Order :
HTTP Method : GET
Apiversion : 2026-12-01-preview
Parameters :
region
Location : path
Description : The name of the region for this request.
Type : string
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
resource
Type : string
Location : path
Required : Yes
Description : Name or id of the resource for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
optionsRequestedPolicyVersion
Format : int32
Description : Requested IAM Policy version.
Location : query
Type : integer
project
Required : Yes
Type : string
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])?))
Description : Gets the access control policy for a resource. May be empty if no such policy or resource exists.
Path : projects/{project}/regions/{region}/backendServices/{resource}/getIamPolicy
▼ ▲ compute.regionBackendServices.update
HTTP Method : PUT
Description : Updates the specified regional BackendService resource with the data included in the request. For more information, see Backend services overview.
Path : projects/{project}/regions/{region}/backendServices/{backendService}
Scopes :
Parameter Order :
Flat Path : projects/{project}/regions/{region}/backendServices/{backendService}
Apiversion : 2026-12-01-preview
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
region
Location : path
Description : Name of the region scoping this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Type : string
backendService
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Description : Name of the BackendService resource to update.
Location : path
requestId
Type : string
Location : query
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).
▼ ▲ compute.regionBackendServices.get
HTTP Method : GET
Path : projects/{project}/regions/{region}/backendServices/{backendService}
Flat Path : projects/{project}/regions/{region}/backendServices/{backendService}
Description : Returns the specified regional BackendService resource.
Scopes :
Parameter Order :
Apiversion : 2026-12-01-preview
Parameters :
backendService
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the BackendService resource to return.
Required : Yes
Type : string
Location : path
project
Description : Project ID for this request.
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])?))
Required : Yes
region
Type : string
Location : path
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Name of the region scoping this request.
▼ ▲ compute.regionBackendServices.delete
HTTP Method : DELETE
Description : Deletes the specified regional BackendService resource.
Parameter Order :
Scopes :
Path : projects/{project}/regions/{region}/backendServices/{backendService}
Parameters :
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Type : string
Description : Name of the region scoping this request.
Location : path
backendService
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Description : Name of the BackendService resource to delete.
Required : Yes
project
Required : Yes
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])?))
Location : path
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).
Type : string
Location : query
Flat Path : projects/{project}/regions/{region}/backendServices/{backendService}
Apiversion : 2026-12-01-preview
▼ ▲ compute.regionBackendServices.testIamPermissions
Parameters :
region
Description : The name of the region for this request.
Location : path
Type : string
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
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])?))
Required : Yes
Type : string
Description : Project ID for this request.
resource
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Type : string
Description : Name or id of the resource for this request.
Scopes :
Apiversion : 2026-12-01-preview
Description : Returns permissions that a caller has on the specified resource.
Parameter Order :
Flat Path : projects/{project}/regions/{region}/backendServices/{resource}/testIamPermissions
Path : projects/{project}/regions/{region}/backendServices/{resource}/testIamPermissions
HTTP Method : POST
▼ ▲ compute.regionBackendServices.insert
HTTP Method : POST
Parameter Order :
Flat Path : projects/{project}/regions/{region}/backendServices
Apiversion : 2026-12-01-preview
Parameters :
requestId
Type : string
Location : query
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).
project
Type : string
Required : Yes
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])?))
Location : path
region
Location : path
Type : string
Required : Yes
Description : Name of the region scoping this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Creates a regional BackendService resource in the specified project using the data included in the request. For more information, see Backend services overview.
Path : projects/{project}/regions/{region}/backendServices
Scopes :
▼ ▲ compute.regionBackendServices.patch
HTTP Method : PATCH
Parameter Order :
Scopes :
Flat Path : projects/{project}/regions/{region}/backendServices/{backendService}
Path : projects/{project}/regions/{region}/backendServices/{backendService}
Apiversion : 2026-12-01-preview
Description : Updates the specified regional BackendService resource with the data included in the request. For more information, see Understanding backend services This method supports PATCH semantics and uses the JSON merge patch format and processing rules.
Parameters :
project
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])?))
Location : path
Type : string
Required : Yes
region
Required : Yes
Description : Name of the region scoping this request.
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
requestId
Location : query
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
backendService
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Type : string
Required : Yes
Description : Name of the BackendService resource to patch.
▼ ▲ compute.regionBackendServices.getHealth
Path : projects/{project}/regions/{region}/backendServices/{backendService}/getHealth
Flat Path : projects/{project}/regions/{region}/backendServices/{backendService}/getHealth
HTTP Method : POST
Parameters :
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Location : path
Type : string
Description : Name of the region scoping this request.
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
backendService
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Description : Name of the BackendService resource for which to get health.
Type : string
Description : Gets the most recent health check results for this regional BackendService.
Apiversion : 2026-12-01-preview
Parameter Order :
Scopes :
▼ ▲ compute.regionBackendServices.listUsable
Apiversion : 2026-12-01-preview
Parameters :
region
Location : path
Type : string
Required : Yes
Description : Name of the region scoping this request. It must be a string that meets the requirements in RFC1035.
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.
maxResults
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`)
Default : 500
Minimum : 0
project
Location : path
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])?))
Description : Project ID for this request.
Required : Yes
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.
orderBy
Type : string
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.
Description : Retrieves a list of all usable backend services for Application Load Balancers and Proxy Network Load Balancers in the specified project in the given region. Backend services for external and internal passthrough Network Load Balancers are not included in the response.
Flat Path : projects/{project}/regions/{region}/backendServices/listUsable
Scopes :
HTTP Method : GET
Parameter Order :
Path : projects/{project}/regions/{region}/backendServices/listUsable
▼ ▲ compute.regionBackendServices.list
Description : Retrieves the list of regional BackendService resources available to the specified project in the given region.
Flat Path : projects/{project}/regions/{region}/backendServices
Scopes :
HTTP Method : GET
Parameter Order :
Parameters :
project
Description : Project ID for this request.
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
region
Required : Yes
Type : string
Description : Name of the region scoping this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
orderBy
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.
Location : query
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`)
Location : query
Format : uint32
Minimum : 0
Default : 500
Type : integer
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.
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.
Location : query
Type : string
Apiversion : 2026-12-01-preview
Path : projects/{project}/regions/{region}/backendServices
▼ ▲ compute.regionBackendServices.setSecurityPolicy
Parameters :
project
Description : Project ID for this request.
Location : path
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])?))
Type : string
region
Required : Yes
Type : string
Description : Name of the region scoping this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
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
backendService
Location : path
Description : Name of the BackendService resource to which the security policy should be set. The name should conform to RFC1035.
Required : Yes
Type : string
Apiversion : 2026-12-01-preview
Description : Sets the Google Cloud Armor security policy for the specified backend service. For more information, seeGoogle Cloud Armor Overview
Path : projects/{project}/regions/{region}/backendServices/{backendService}/setSecurityPolicy
Flat Path : projects/{project}/regions/{region}/backendServices/{backendService}/setSecurityPolicy
Parameter Order :
HTTP Method : POST
Scopes :
▼ ▲ compute.regionBackendServices.setIamPolicy
HTTP Method : POST
Parameter Order :
Description : Sets the access control policy on the specified resource. Replaces any existing policy.
Scopes :
Flat Path : projects/{project}/regions/{region}/backendServices/{resource}/setIamPolicy
Path : projects/{project}/regions/{region}/backendServices/{resource}/setIamPolicy
Apiversion : 2026-12-01-preview
Parameters :
resource
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Description : Name or id of the resource for this request.
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])?))
Type : string
Description : Project ID for this request.
Required : Yes
Location : path
region
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : The name of the region for this request.
Type : string
Location : path
▼ ▲ compute.regionUrlMaps.list
Description : Retrieves the list of UrlMap resources available to the specified project in the specified region.
Scopes :
Parameter Order :
HTTP Method : GET
Path : projects/{project}/regions/{region}/urlMaps
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/regions/{region}/urlMaps
Parameters :
filter
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.
Location : query
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.
region
Required : Yes
Description : Name of the region scoping this request.
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
orderBy
Type : string
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.
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])?))
Location : path
Description : Project ID for this request.
maxResults
Location : query
Type : integer
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
Minimum : 0
▼ ▲ compute.regionUrlMaps.delete
Apiversion : 2026-12-01-preview
Path : projects/{project}/regions/{region}/urlMaps/{urlMap}
Parameters :
urlMap
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the UrlMap resource to delete.
Required : Yes
requestId
Description : begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.
Type : string
Location : query
region
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Type : string
Description : Name of the region 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
Description : Deletes the specified UrlMap resource.
Parameter Order :
Scopes :
Flat Path : projects/{project}/regions/{region}/urlMaps/{urlMap}
HTTP Method : DELETE
▼ ▲ compute.regionUrlMaps.update
Scopes :
Apiversion : 2026-12-01-preview
Description : Updates the specified UrlMap resource with the data included in the request.
Flat Path : projects/{project}/regions/{region}/urlMaps/{urlMap}
Parameters :
requestId
Type : string
Description : begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.
Location : query
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Description : Name of the region scoping this request.
Location : path
Type : string
project
Required : Yes
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])?))
Location : path
Type : string
urlMap
Required : Yes
Description : Name of the UrlMap resource to update.
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Parameter Order :
Path : projects/{project}/regions/{region}/urlMaps/{urlMap}
HTTP Method : PUT
▼ ▲ compute.regionUrlMaps.patch
Scopes :
Apiversion : 2026-12-01-preview
Parameters :
region
Required : Yes
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Name of the region scoping this request.
Location : path
project
Type : string
Location : path
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])?))
Required : Yes
requestId
Description : begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.
Type : string
Location : query
urlMap
Location : path
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the UrlMap resource to patch.
Required : Yes
Path : projects/{project}/regions/{region}/urlMaps/{urlMap}
HTTP Method : PATCH
Description : Patches the specified UrlMap resource with the data included in the request. This method supportsPATCH semantics and usesJSON merge patch format and processing rules.
Flat Path : projects/{project}/regions/{region}/urlMaps/{urlMap}
Parameter Order :
▼ ▲ compute.regionUrlMaps.validate
HTTP Method : POST
Flat Path : projects/{project}/regions/{region}/urlMaps/{urlMap}/validate
Description : Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap.
Path : projects/{project}/regions/{region}/urlMaps/{urlMap}/validate
Scopes :
Parameter Order :
Parameters :
region
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Description : Name of the region scoping this request.
Required : Yes
project
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])?))
Location : path
Required : Yes
Description : Project ID for this request.
urlMap
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Required : Yes
Location : path
Description : Name of the UrlMap resource to be validated as.
Apiversion : 2026-12-01-preview
▼ ▲ compute.regionUrlMaps.get
Parameters :
project
Type : string
Required : Yes
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])?))
urlMap
Description : Name of the UrlMap resource to return.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Type : string
region
Type : string
Description : Name of the region scoping this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Location : path
Description : Returns the specified UrlMap resource.
Scopes :
Apiversion : 2026-12-01-preview
Path : projects/{project}/regions/{region}/urlMaps/{urlMap}
Flat Path : projects/{project}/regions/{region}/urlMaps/{urlMap}
Parameter Order :
HTTP Method : GET
▼ ▲ compute.regionUrlMaps.insert
Parameter Order :
Path : projects/{project}/regions/{region}/urlMaps
Description : Creates a UrlMap resource in the specified project using the data included in the request.
Flat Path : projects/{project}/regions/{region}/urlMaps
Apiversion : 2026-12-01-preview
Parameters :
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])?))
Type : string
Required : Yes
region
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Required : Yes
Description : Name of the region scoping this request.
requestId
Type : string
Location : query
Description : begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.
HTTP Method : POST
Scopes :
▼ ▲ compute.regionCommitments.list
Description : Retrieves a list of commitments contained within the specified region.
Path : projects/{project}/regions/{region}/commitments
HTTP Method : GET
Parameter Order :
Scopes :
Flat Path : projects/{project}/regions/{region}/commitments
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`)
Type : integer
Default : 500
Format : uint32
Minimum : 0
Location : query
region
Description : Name of the region for this request.
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
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.
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])?))
Required : Yes
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.
Location : query
Type : string
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
Apiversion : 2026-12-01-preview
▼ ▲ compute.regionCommitments.aggregatedList
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])?))
Description : Project ID for this request.
Required : Yes
Type : string
Location : path
includeAllScopes
Location : query
Description : Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
Type : boolean
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
Type : integer
Minimum : 0
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`)
Format : uint32
filter
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.
Type : string
serviceProjectNumber
Description : The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.
Type : string
Location : query
Format : int64
pageToken
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.
Type : string
Apiversion : 2026-12-01-preview
Path : projects/{project}/aggregated/commitments
Description : Retrieves an aggregated list of commitments by region. To prevent failure, it is recommended that you set the `returnPartialSuccess` parameter to `true`.
Parameter Order : project
Flat Path : projects/{project}/aggregated/commitments
Scopes :
HTTP Method : GET
▼ ▲ compute.regionCommitments.update
Parameter Order :
Flat Path : projects/{project}/regions/{region}/commitments/{commitment}
HTTP Method : PATCH
Scopes :
Description : Updates the specified commitment with the data included in the request. Update is performed only on selected fields included as part of update-mask. Only the following fields can be updated: auto_renew and plan.
Apiversion : 2026-12-01-preview
Parameters :
commitment
Required : Yes
Description : Name of the commitment that you want to update.
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
project
Required : Yes
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])?))
Location : path
Type : string
region
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Name of the region for this request.
Location : path
Type : string
updateMask
Type : string
Location : query
Format : google-fieldmask
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
paths
Repeated : Yes
Location : query
Type : string
Path : projects/{project}/regions/{region}/commitments/{commitment}
▼ ▲ compute.regionCommitments.get
HTTP Method : GET
Description : Returns the specified commitment resource.
Scopes :
Flat Path : projects/{project}/regions/{region}/commitments/{commitment}
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
Location : path
Description : Project ID for this request.
Type : string
commitment
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Description : Name of the commitment to return.
Location : path
region
Required : Yes
Description : Name of the region for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Location : path
Path : projects/{project}/regions/{region}/commitments/{commitment}
Apiversion : 2026-12-01-preview
Parameter Order :
▼ ▲ compute.regionCommitments.insert
Parameter Order :
HTTP Method : POST
Path : projects/{project}/regions/{region}/commitments
Scopes :
Description : Creates a commitment in the specified project using the data included in the request.
Flat Path : projects/{project}/regions/{region}/commitments
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
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Type : string
Description : Name of the region for this request.
Location : path
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])?))
Type : string
Description : Project ID for this request.
Location : path
Apiversion : 2026-12-01-preview
▼ ▲ compute.networkEndpointGroups.list
HTTP Method : GET
Scopes :
Parameter Order :
Flat Path : projects/{project}/zones/{zone}/networkEndpointGroups
Path : projects/{project}/zones/{zone}/networkEndpointGroups
Description : Retrieves the list of network endpoint groups that are located in the specified project and zone.
Apiversion : 2026-12-01-preview
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
maxResults
Minimum : 0
Format : uint32
Default : 500
Type : integer
Location : query
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`)
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
filter
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.
Location : query
zone
Location : path
Type : string
Required : Yes
Description : The name of thezone where the network endpoint group is located. It should comply with RFC1035.
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.
Type : string
Location : query
▼ ▲ compute.networkEndpointGroups.delete
Apiversion : 2026-12-01-preview
Parameters :
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
Required : Yes
Type : string
Description : The name of the zone where the network endpoint group is located. It should comply with RFC1035.
Location : path
networkEndpointGroup
Description : The name of the network endpoint group to delete. It should comply with RFC1035.
Required : Yes
Type : string
Location : path
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])?))
Type : string
Required : Yes
Flat Path : projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}
Description : Deletes the specified network endpoint group. The network endpoints in the NEG and the VM instances they belong to are not terminated when the NEG is deleted. Note that the NEG cannot be deleted if there are backend services referencing it.
Path : projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}
HTTP Method : DELETE
Scopes :
Parameter Order :
▼ ▲ compute.networkEndpointGroups.attachNetworkEndpoints
Parameter Order :
Path : projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints
Flat Path : projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints
Scopes :
HTTP Method : POST
Apiversion : 2026-12-01-preview
Parameters :
networkEndpointGroup
Description : The name of the network endpoint group where you are attaching network endpoints to. It should comply with RFC1035.
Location : path
Type : string
Required : Yes
requestId
Location : query
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
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
Type : string
Description : Project ID for this request.
Required : Yes
zone
Type : string
Location : path
Description : The name of the zone where the network endpoint group is located. It should comply with RFC1035.
Required : Yes
Description : Attach a list of network endpoints to the specified network endpoint group.
▼ ▲ compute.networkEndpointGroups.detachNetworkEndpoints
Scopes :
Path : projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints
HTTP Method : POST
Parameter Order :
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).
Location : query
Type : string
project
Description : Project ID for this request.
Required : Yes
Location : path
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])?))
zone
Required : Yes
Description : The name of the zone where the network endpoint group is located. It should comply with RFC1035.
Location : path
Type : string
networkEndpointGroup
Location : path
Type : string
Description : The name of the network endpoint group where you are removing network endpoints. It should comply with RFC1035.
Required : Yes
Apiversion : 2026-12-01-preview
Description : Detach a list of network endpoints from the specified network endpoint group.
Flat Path : projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints
▼ ▲ compute.networkEndpointGroups.testIamPermissions
Flat Path : projects/{project}/zones/{zone}/networkEndpointGroups/{resource}/testIamPermissions
HTTP Method : POST
Scopes :
Path : projects/{project}/zones/{zone}/networkEndpointGroups/{resource}/testIamPermissions
Parameter Order :
Description : Returns permissions that a caller has on the specified resource.
Apiversion : 2026-12-01-preview
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
Type : string
Required : Yes
Description : Project ID for this request.
resource
Description : Name or id of the resource for this request.
Required : Yes
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
zone
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Type : string
Description : The name of the zone for this request.
Required : Yes
▼ ▲ compute.networkEndpointGroups.insert
Apiversion : 2026-12-01-preview
Scopes :
Parameters :
requestId
Type : string
Location : query
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).
project
Description : Project ID for this request.
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])?))
Type : string
Location : path
zone
Required : Yes
Description : The name of the zone where you want to create the network endpoint group. It should comply with RFC1035.
Type : string
Location : path
Parameter Order :
Flat Path : projects/{project}/zones/{zone}/networkEndpointGroups
Path : projects/{project}/zones/{zone}/networkEndpointGroups
Description : Creates a network endpoint group in the specified project using the parameters that are included in the request. Note: Use the following APIs to manage network endpoint groups: - To manage NEGs with zonal scope (such as zonal NEGs, hybrid connectivity NEGs): zonal API - To manage NEGs with regional scope (such as regional internet NEGs, serverless NEGs, Private Service Connect NEGs): regional API - To manage NEGs with global scope (such as global internet NEGs):global API
HTTP Method : POST
▼ ▲ compute.networkEndpointGroups.listNetworkEndpoints
Flat Path : projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/listNetworkEndpoints
Scopes :
Parameters :
networkEndpointGroup
Description : The name of the network endpoint group from which you want to generate a list of included network endpoints. It should comply with RFC1035.
Location : path
Required : Yes
Type : string
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
filter
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.
Type : string
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
zone
Type : string
Required : Yes
Description : The name of the zone where the network endpoint group is located. It should comply with RFC1035.
Location : path
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.
Type : string
Location : query
maxResults
Location : query
Format : uint32
Type : integer
Minimum : 0
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`)
Apiversion : 2026-12-01-preview
Parameter Order :
HTTP Method : POST
Description : Lists the network endpoints in the specified network endpoint group.
Path : projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/listNetworkEndpoints
▼ ▲ compute.networkEndpointGroups.aggregatedList
Description : Retrieves the list of network endpoint groups and sorts them by zone. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.
Flat Path : projects/{project}/aggregated/networkEndpointGroups
Apiversion : 2026-12-01-preview
Path : projects/{project}/aggregated/networkEndpointGroups
Parameters :
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])?))
Description : Project ID for this request.
Required : Yes
Type : string
orderBy
Type : string
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.
maxResults
Type : integer
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`)
Minimum : 0
Format : uint32
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.
includeAllScopes
Description : Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
Location : query
Type : boolean
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.
Location : query
Type : string
serviceProjectNumber
Description : The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.
Location : query
Type : string
Format : int64
Parameter Order : project
HTTP Method : GET
Scopes :
▼ ▲ compute.networkEndpointGroups.get
Path : projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}
HTTP Method : GET
Description : Returns the specified network endpoint group.
Flat Path : projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}
Parameters :
project
Required : Yes
Description : Project ID for this request.
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])?))
Location : path
networkEndpointGroup
Required : Yes
Description : The name of the network endpoint group. It should comply with RFC1035.
Location : path
Type : string
zone
Location : path
Description : The name of the zone where the network endpoint group is located. It should comply with RFC1035.
Required : Yes
Type : string
Apiversion : 2026-12-01-preview
Scopes :
Parameter Order :
▼ ▲ compute.targetVpnGateways.delete
Parameter Order :
Scopes :
HTTP Method : DELETE
Description : Deletes the specified target VPN gateway.
Path : projects/{project}/regions/{region}/targetVpnGateways/{targetVpnGateway}
Flat Path : projects/{project}/regions/{region}/targetVpnGateways/{targetVpnGateway}
Parameters :
targetVpnGateway
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Description : Name of the target VPN gateway to delete.
Required : Yes
project
Required : Yes
Description : Project ID for this request.
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])?))
Location : path
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
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Description : Name of the region for this request.
Type : string
Required : Yes
Apiversion : 2026-12-01-preview
▼ ▲ compute.targetVpnGateways.insert
Path : projects/{project}/regions/{region}/targetVpnGateways
Flat Path : projects/{project}/regions/{region}/targetVpnGateways
Description : Creates a target VPN gateway in the specified project and region using the data included in the request.
HTTP Method : POST
Parameters :
project
Location : path
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])?))
Type : string
Required : Yes
region
Description : Name of the region for this request.
Type : string
Required : Yes
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
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).
Apiversion : 2026-12-01-preview
Parameter Order :
Scopes :
▼ ▲ compute.targetVpnGateways.setLabels
Parameter Order :
HTTP Method : POST
Scopes :
Flat Path : projects/{project}/regions/{region}/targetVpnGateways/{resource}/setLabels
Path : projects/{project}/regions/{region}/targetVpnGateways/{resource}/setLabels
Description : Sets the labels on a TargetVpnGateway. To learn more about labels, read theLabeling Resources documentation.
Apiversion : 2026-12-01-preview
Parameters :
region
Location : path
Description : The region for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Required : Yes
resource
Location : path
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Description : Name or id of the resource for this request.
requestId
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).
Location : query
project
Required : Yes
Description : Project ID for this request.
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])?))
▼ ▲ compute.targetVpnGateways.get
Parameters :
region
Location : path
Description : Name of the region for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Required : Yes
project
Description : Project ID for this request.
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])?))
Location : path
targetVpnGateway
Description : Name of the target VPN gateway to return.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Type : string
Description : Returns the specified target VPN gateway.
Path : projects/{project}/regions/{region}/targetVpnGateways/{targetVpnGateway}
Apiversion : 2026-12-01-preview
Scopes :
Flat Path : projects/{project}/regions/{region}/targetVpnGateways/{targetVpnGateway}
HTTP Method : GET
Parameter Order :
▼ ▲ compute.targetVpnGateways.list
Parameter Order :
Scopes :
HTTP Method : GET
Path : projects/{project}/regions/{region}/targetVpnGateways
Parameters :
filter
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.
Type : string
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
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.
Type : string
region
Location : path
Required : Yes
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Name of the region for 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])?))
Location : path
Type : string
Description : Project ID for this request.
Required : Yes
maxResults
Format : uint32
Minimum : 0
Default : 500
Type : integer
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`)
Location : query
Flat Path : projects/{project}/regions/{region}/targetVpnGateways
Description : Retrieves a list of target VPN gateways available to the specified project and region.
Apiversion : 2026-12-01-preview
▼ ▲ compute.targetVpnGateways.aggregatedList
Path : projects/{project}/aggregated/targetVpnGateways
HTTP Method : GET
Parameter Order : project
Flat Path : projects/{project}/aggregated/targetVpnGateways
Parameters :
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
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
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`)
Format : uint32
Type : integer
Location : query
Minimum : 0
Default : 500
includeAllScopes
Type : boolean
Location : query
Description : Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
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
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.
serviceProjectNumber
Format : int64
Type : string
Description : The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.
Location : query
Description : Retrieves an aggregated list of target VPN gateways. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.
Scopes :
Apiversion : 2026-12-01-preview
▼ ▲ compute.reservations.insert
Parameter Order :
HTTP Method : POST
Path : projects/{project}/zones/{zone}/reservations
Description : Creates a new reservation. For more information, readReserving zonal resources.
Scopes :
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/zones/{zone}/reservations
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
zone
Required : Yes
Type : string
Description : Name of the zone for this request.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
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
Type : string
Description : Project ID for this request.
Required : Yes
▼ ▲ compute.reservations.list
Parameters :
project
Description : Project ID for this request.
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])?))
Location : path
Type : string
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.
Type : string
Location : query
maxResults
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`)
Minimum : 0
Type : integer
Location : query
Format : uint32
filter
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.
Type : string
zone
Required : Yes
Description : Name of the zone for this request.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
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
Flat Path : projects/{project}/zones/{zone}/reservations
Apiversion : 2026-12-01-preview
Parameter Order :
Description : A list of all the reservations that have been configured for the specified project in specified zone.
Scopes :
Path : projects/{project}/zones/{zone}/reservations
HTTP Method : GET
▼ ▲ compute.reservations.performMaintenance
Parameters :
reservation
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Type : string
Description : The name of the reservation. Name should conform to RFC1035 or be a resource ID.
Location : path
project
Required : Yes
Description : Project ID for this request.
Location : path
Type : string
zone
Required : Yes
Description : Name of the zone for this request. Zone name should conform to RFC1035.
Location : path
Type : string
requestId
Location : query
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
Parameter Order :
Flat Path : projects/{project}/zones/{zone}/reservations/{reservation}/performMaintenance
Apiversion : 2026-12-01-preview
Path : projects/{project}/zones/{zone}/reservations/{reservation}/performMaintenance
Description : Perform maintenance on an extended reservation
Scopes :
HTTP Method : POST
▼ ▲ compute.reservations.delete
Parameter Order :
Scopes :
Flat Path : projects/{project}/zones/{zone}/reservations/{reservation}
Apiversion : 2026-12-01-preview
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
project
Required : Yes
Location : path
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])?))
Type : string
reservation
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Description : Name of the reservation to delete.
Location : path
zone
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Name of the zone for this request.
Required : Yes
Location : path
Type : string
HTTP Method : DELETE
Path : projects/{project}/zones/{zone}/reservations/{reservation}
Description : Deletes the specified reservation.
▼ ▲ compute.reservations.getIamPolicy
Scopes :
Flat Path : projects/{project}/zones/{zone}/reservations/{resource}/getIamPolicy
HTTP Method : GET
Parameter Order :
Description : Gets the access control policy for a resource. May be empty if no such policy or resource exists.
Path : projects/{project}/zones/{zone}/reservations/{resource}/getIamPolicy
Apiversion : 2026-12-01-preview
Parameters :
resource
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name or id of the resource for this request.
Required : Yes
Location : path
Type : string
optionsRequestedPolicyVersion
Type : integer
Description : Requested IAM Policy version.
Location : query
Format : int32
zone
Description : The name of the zone for this request.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Location : path
project
Description : Project ID for this request.
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])?))
Location : path
Type : string
▼ ▲ compute.reservations.update
Scopes :
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/zones/{zone}/reservations/{reservation}
Parameters :
paths
Repeated : Yes
Location : query
Type : string
requestId
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).
Location : query
updateMask
Description : Update_mask indicates fields to be updated as part of this request.
Type : string
Location : query
Format : google-fieldmask
zone
Type : string
Description : Name of the zone for this request.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
reservation
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Type : string
Description : Name of the reservation to update.
Required : Yes
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])?))
Description : Project ID for this request.
Type : string
Required : Yes
HTTP Method : PATCH
Parameter Order :
Path : projects/{project}/zones/{zone}/reservations/{reservation}
Description : Update share settings of the reservation.
▼ ▲ compute.reservations.aggregatedList
Parameters :
serviceProjectNumber
Format : int64
Description : The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.
Location : query
Type : string
project
Required : Yes
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])?))
Type : string
Location : path
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.
maxResults
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`)
Minimum : 0
Type : integer
Location : query
Format : uint32
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.
Type : string
Location : query
includeAllScopes
Description : Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
Location : query
Type : boolean
filter
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.
Type : string
Apiversion : 2026-12-01-preview
Scopes :
Flat Path : projects/{project}/aggregated/reservations
Parameter Order : project
Path : projects/{project}/aggregated/reservations
Description : Retrieves an aggregated list of reservations. To prevent failure, it is recommended that you set the `returnPartialSuccess` parameter to `true`.
HTTP Method : GET
▼ ▲ compute.reservations.setIamPolicy
Parameter Order :
HTTP Method : POST
Flat Path : projects/{project}/zones/{zone}/reservations/{resource}/setIamPolicy
Scopes :
Description : Sets the access control policy on the specified resource. Replaces any existing policy.
Path : projects/{project}/zones/{zone}/reservations/{resource}/setIamPolicy
Apiversion : 2026-12-01-preview
Parameters :
zone
Description : The name of the zone for this request.
Required : Yes
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
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
Type : string
Description : Project ID for this request.
Required : Yes
resource
Description : Name or id of the resource for this request.
Type : string
Location : path
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
▼ ▲ compute.reservations.resize
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/zones/{zone}/reservations/{reservation}/resize
Path : projects/{project}/zones/{zone}/reservations/{reservation}/resize
Parameters :
reservation
Location : path
Type : string
Description : Name of the reservation to update.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
project
Type : string
Description : Project ID for this request.
Location : path
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])?))
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
zone
Description : Name of the zone for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Location : path
Type : string
Scopes :
HTTP Method : POST
Description : Resizes the reservation (applicable to standalone reservations only). For more information, readModifying reservations.
Parameter Order :
▼ ▲ compute.reservations.testIamPermissions
Description : Returns permissions that a caller has on the specified resource.
Parameter Order :
Path : projects/{project}/zones/{zone}/reservations/{resource}/testIamPermissions
Parameters :
resource
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name or id of the resource for this request.
Type : string
Location : path
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])?))
Description : Project ID for this request.
Type : string
Required : Yes
zone
Type : string
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Description : The name of the zone for this request.
Flat Path : projects/{project}/zones/{zone}/reservations/{resource}/testIamPermissions
Apiversion : 2026-12-01-preview
HTTP Method : POST
Scopes :
▼ ▲ compute.reservations.get
Parameter Order :
HTTP Method : GET
Scopes :
Flat Path : projects/{project}/zones/{zone}/reservations/{reservation}
Apiversion : 2026-12-01-preview
Parameters :
zone
Type : string
Required : Yes
Description : Name of the zone for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
reservation
Location : path
Type : string
Description : Name of the reservation to retrieve.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
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
Type : string
Required : Yes
Description : Project ID for this request.
Description : Retrieves information about the specified reservation.
Path : projects/{project}/zones/{zone}/reservations/{reservation}
▼ ▲ compute.networkProfiles.list
HTTP Method : GET
Description : Retrieves a list of network profiles available to the specified project.
Path : projects/{project}/global/networkProfiles
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/global/networkProfiles
Scopes :
Parameters :
project
Description : Project ID for this request.
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])?))
Required : Yes
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
pageToken
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.
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.
maxResults
Type : integer
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`)
Location : query
Default : 500
Minimum : 0
Format : uint32
Parameter Order : project
▼ ▲ compute.networkProfiles.get
Path : projects/{project}/global/networkProfiles/{networkProfile}
Description : Returns the specified network profile.
HTTP Method : GET
Parameters :
project
Required : Yes
Description : Project ID for this request.
Location : path
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])?))
networkProfile
Description : Name of the network profile to return.
Type : string
Location : path
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Flat Path : projects/{project}/global/networkProfiles/{networkProfile}
Apiversion : 2026-12-01-preview
Parameter Order :
Scopes :
▼ ▲ compute.regionInstanceGroupManagerResizeRequests.insert
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
instanceGroupManager
Location : path
Description : Name of the managed instance group to which the resize request is scoped. Name should conform to RFC1035 or be a resource ID.
Type : string
Required : Yes
region
Location : path
Description : Name of the region scoping this request. Name should conform to RFC1035.
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
Type : string
Required : Yes
Description : Project ID for this request.
Flat Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests
Apiversion : 2026-12-01-preview
Description : Creates a new Resize Request that starts provisioning VMs immediately or queues VM creation.
Parameter Order :
Scopes :
Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests
HTTP Method : POST
▼ ▲ compute.regionInstanceGroupManagerResizeRequests.cancel
HTTP Method : POST
Parameters :
instanceGroupManager
Required : Yes
Description : The name of the managed instance group. Name should conform to RFC1035 or be a resource ID.
Location : path
Type : string
resizeRequest
Required : Yes
Description : The name of the resize request to cancel. Name should conform to RFC1035 or be a resource ID.
Type : string
Location : path
region
Description : The name of the region scoping this request. Name should conform to RFC1035.
Required : Yes
Type : string
Location : path
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).
project
Type : string
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
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.
Flat Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}/cancel
Parameter Order :
Apiversion : 2026-12-01-preview
Scopes :
Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}/cancel
▼ ▲ compute.regionInstanceGroupManagerResizeRequests.get
Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}
HTTP Method : GET
Scopes :
Parameter Order :
Flat Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}
Description : Returns all of the details about the specified resize request.
Apiversion : 2026-12-01-preview
Parameters :
project
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])?))
Description : Project ID for this request.
instanceGroupManager
Location : path
Required : Yes
Description : The name of the managed instance group. Name should conform to RFC1035 or be a resource ID.
Type : string
resizeRequest
Required : Yes
Description : The name of the resize request. Name should conform to RFC1035 or be a resource ID.
Type : string
Location : path
region
Type : string
Required : Yes
Description : The name of the region scoping this request. Name should conform to RFC1035.
Location : path
▼ ▲ compute.regionInstanceGroupManagerResizeRequests.delete
HTTP Method : 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.
Parameter Order :
Flat Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}
Apiversion : 2026-12-01-preview
Scopes :
Parameters :
resizeRequest
Required : Yes
Description : The name of the resize request to delete. Name should conform to RFC1035 or be a resource ID.
Location : path
Type : string
region
Description : The name of the region scoping this request. Name should conform to RFC1035.
Type : string
Location : path
Required : Yes
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
Type : string
Required : Yes
Description : The name of the managed instance group. Name should conform to RFC1035 or be a resource ID.
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
Description : Project ID for this request.
Type : string
Location : path
▼ ▲ compute.regionInstanceGroupManagerResizeRequests.list
Apiversion : 2026-12-01-preview
Parameters :
instanceGroupManager
Description : The name of the managed instance group. The name should conform to RFC1035.
Location : path
Type : string
Required : Yes
region
Location : path
Type : string
Description : Name of the region scoping this request. Name should conform to RFC1035.
Required : Yes
maxResults
Type : integer
Default : 500
Minimum : 0
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`)
Location : query
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.
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
filter
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.
Type : string
project
Required : Yes
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])?))
Location : path
Type : string
Description : Retrieves a list of Resize Requests that are contained in the managed instance group.
Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests
Flat Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests
Scopes :
Parameter Order :
HTTP Method : GET
▼ ▲ compute.crossSiteNetworks.delete
Description : Deletes the specified cross-site network in the given scope.
Path : projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}
HTTP Method : DELETE
Flat Path : projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}
Apiversion : 2026-12-01-preview
Parameter Order :
Parameters :
crossSiteNetwork
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Required : Yes
Description : Name of the cross-site network to delete.
Location : path
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
Description : Project ID for this request.
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). end_interface: MixerMutationRequestBuilder
Location : query
Type : string
Scopes :
▼ ▲ compute.crossSiteNetworks.insert
Flat Path : projects/{project}/global/crossSiteNetworks
Scopes :
Path : projects/{project}/global/crossSiteNetworks
Apiversion : 2026-12-01-preview
Parameters :
validateOnly
Description : [Input Only] Validate the new configuration, but don't create it.
Location : query
Type : boolean
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). end_interface: MixerMutationRequestBuilder
Type : string
Location : query
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])?))
Type : string
Description : Project ID for this request.
Location : path
HTTP Method : POST
Description : Creates a cross-site network in the specified project in the given scope using the parameters that are included in the request.
Parameter Order : project
▼ ▲ compute.crossSiteNetworks.list
Scopes :
HTTP Method : GET
Flat Path : projects/{project}/global/crossSiteNetworks
Apiversion : 2026-12-01-preview
Description : Lists the cross-site networks for a project in the given scope.
Parameters :
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.
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.
maxResults
Minimum : 0
Default : 500
Format : uint32
Type : integer
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`)
Location : query
orderBy
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.
Location : query
project
Location : path
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])?))
Required : Yes
Description : Project ID for this request.
Path : projects/{project}/global/crossSiteNetworks
Parameter Order : project
▼ ▲ compute.crossSiteNetworks.patch
HTTP Method : PATCH
Scopes :
Parameter Order :
Flat Path : projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}
Path : projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}
Description : Updates the specified cross-site network with the data included in the request. This method supportsPATCH semantics and uses theJSON merge patch format and processing rules.
Apiversion : 2026-12-01-preview
Parameters :
validateOnly
Description : [Input Only] Validate the new configuration, but don't update it.
Type : boolean
Location : query
crossSiteNetwork
Required : Yes
Type : string
Description : Name of the cross-site network to update.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
updateMask
Description : update_mask indicates fields to be updated as part of this request.
Location : query
Type : string
Format : google-fieldmask
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
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). end_interface: MixerMutationRequestBuilder
▼ ▲ compute.crossSiteNetworks.get
Path : projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}
Description : Returns the specified cross-site network in the given scope.
HTTP Method : GET
Parameter Order :
Scopes :
Parameters :
project
Location : path
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])?))
Required : Yes
crossSiteNetwork
Required : Yes
Type : string
Description : Name of the cross-site network to return.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Flat Path : projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}
Apiversion : 2026-12-01-preview
▼ ▲ compute.firewalls.update
Path : projects/{project}/global/firewalls/{firewall}
Parameter Order :
Flat Path : projects/{project}/global/firewalls/{firewall}
Description : Updates the specified firewall rule with the data included in the request. Note that all fields will be updated if using PUT, even fields that are not specified. To update individual fields, please use PATCH instead.
HTTP Method : PUT
Scopes :
Parameters :
project
Required : Yes
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])?))
Location : path
Type : string
firewall
Location : path
Type : string
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the firewall rule to update.
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).
Apiversion : 2026-12-01-preview
▼ ▲ compute.firewalls.patch
HTTP Method : PATCH
Flat Path : projects/{project}/global/firewalls/{firewall}
Description : Updates the specified firewall rule with the data included in the request. This method supportsPATCH semantics and uses theJSON merge patch format and processing rules.
Path : projects/{project}/global/firewalls/{firewall}
Parameter Order :
Apiversion : 2026-12-01-preview
Scopes :
Parameters :
firewall
Description : Name of the firewall rule to patch.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Required : Yes
project
Location : path
Required : Yes
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])?))
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
▼ ▲ compute.firewalls.get
Parameters :
project
Description : 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])?))
firewall
Type : string
Description : Name of the firewall rule to return.
Location : path
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/global/firewalls/{firewall}
Parameter Order :
Scopes :
Path : projects/{project}/global/firewalls/{firewall}
Description : Returns the specified firewall.
HTTP Method : GET
▼ ▲ compute.firewalls.delete
Parameters :
requestId
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).
Location : query
firewall
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Required : Yes
Description : Name of the firewall rule to delete.
project
Type : string
Required : Yes
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])?))
Location : path
Path : projects/{project}/global/firewalls/{firewall}
Parameter Order :
Apiversion : 2026-12-01-preview
Description : Deletes the specified firewall.
Flat Path : projects/{project}/global/firewalls/{firewall}
Scopes :
HTTP Method : DELETE
▼ ▲ compute.firewalls.testIamPermissions
Parameter Order :
Parameters :
resource
Pattern : [a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Description : Name or id of the resource for this request.
Type : string
Required : Yes
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])?))
Scopes :
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/global/firewalls/{resource}/testIamPermissions
Path : projects/{project}/global/firewalls/{resource}/testIamPermissions
Description : Returns permissions that a caller has on the specified resource.
HTTP Method : POST
▼ ▲ compute.firewalls.list
Apiversion : 2026-12-01-preview
Scopes :
Parameters :
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.
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
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.
project
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])?))
Required : Yes
Location : path
Description : Project ID for this request.
maxResults
Location : query
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`)
Type : integer
Default : 500
Minimum : 0
Description : Retrieves the list of firewall rules available to the specified project.
Path : projects/{project}/global/firewalls
Parameter Order : project
Flat Path : projects/{project}/global/firewalls
HTTP Method : GET
▼ ▲ compute.firewalls.insert
Path : projects/{project}/global/firewalls
Parameters :
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])?))
Description : Project ID for this request.
Type : string
Required : Yes
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).
Description : Creates a firewall rule in the specified project using the data included in the request.
Apiversion : 2026-12-01-preview
Parameter Order : project
Flat Path : projects/{project}/global/firewalls
Scopes :
HTTP Method : POST
▼ ▲ compute.regionInstantSnapshotGroups.get
Path : projects/{project}/regions/{region}/instantSnapshotGroups/{instantSnapshotGroup}
Flat Path : projects/{project}/regions/{region}/instantSnapshotGroups/{instantSnapshotGroup}
Scopes :
Apiversion : 2026-12-01-preview
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.
Type : string
Required : Yes
region
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Description : The name of the region for this request.
Type : string
instantSnapshotGroup
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the InstantSnapshotGroup resource to return.
Required : Yes
Location : path
Type : string
HTTP Method : GET
Parameter Order :
Description : returns the specified InstantSnapshotGroup resource in the specified region.
▼ ▲ compute.regionInstantSnapshotGroups.setIamPolicy
Scopes :
Parameters :
region
Location : path
Description : The name of the region for this request.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
project
Description : Project ID for this request.
Location : path
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])?))
Required : Yes
resource
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 resource for this request.
Type : string
Required : Yes
Flat Path : projects/{project}/regions/{region}/instantSnapshotGroups/{resource}/setIamPolicy
Parameter Order :
Apiversion : 2026-12-01-preview
HTTP Method : POST
Description : Sets the access control policy on the specified resource. Replaces any existing policy.
Path : projects/{project}/regions/{region}/instantSnapshotGroups/{resource}/setIamPolicy
▼ ▲ compute.regionInstantSnapshotGroups.delete
Flat Path : projects/{project}/regions/{region}/instantSnapshotGroups/{instantSnapshotGroup}
Parameters :
region
Required : Yes
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : The name of the region for this request.
Location : path
requestId
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).
Location : query
instantSnapshotGroup
Description : Name of the InstantSnapshotGroup resource to delete.
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])?))
Location : path
Description : Project ID for this request.
Required : Yes
Type : string
Apiversion : 2026-12-01-preview
Path : projects/{project}/regions/{region}/instantSnapshotGroups/{instantSnapshotGroup}
Description : deletes a Regional InstantSnapshotGroup resource
Parameter Order :
Scopes :
HTTP Method : DELETE
▼ ▲ compute.regionInstantSnapshotGroups.getIamPolicy
Parameter Order :
Flat Path : projects/{project}/regions/{region}/instantSnapshotGroups/{resource}/getIamPolicy
Scopes :
HTTP Method : GET
Description : Gets the access control policy for a resource. May be empty if no such policy or resource exists.
Apiversion : 2026-12-01-preview
Parameters :
project
Type : string
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])?))
Description : Project ID for this request.
optionsRequestedPolicyVersion
Location : query
Type : integer
Description : Requested IAM Policy version.
Format : int32
resource
Required : Yes
Description : Name or id of the resource for this request.
Location : path
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
region
Type : string
Description : The name of the region for this request.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Path : projects/{project}/regions/{region}/instantSnapshotGroups/{resource}/getIamPolicy
▼ ▲ compute.regionInstantSnapshotGroups.testIamPermissions
Parameter Order :
Flat Path : projects/{project}/regions/{region}/instantSnapshotGroups/{resource}/testIamPermissions
HTTP Method : POST
Apiversion : 2026-12-01-preview
Parameters :
resource
Location : path
Description : Name or id of the resource for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Type : string
region
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : The name of the region for this request.
Type : string
Required : Yes
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])?))
Location : path
Description : Project ID for this request.
Scopes :
Description : Returns permissions that a caller has on the specified resource.
Path : projects/{project}/regions/{region}/instantSnapshotGroups/{resource}/testIamPermissions
▼ ▲ compute.regionInstantSnapshotGroups.insert
HTTP Method : POST
Flat Path : projects/{project}/regions/{region}/instantSnapshotGroups
Scopes :
Path : projects/{project}/regions/{region}/instantSnapshotGroups
Parameter Order :
Apiversion : 2026-12-01-preview
Description : creates a Regional InstantSnapshotGroup resource
Parameters :
sourceConsistencyGroup
Location : query
Type : string
Description : begin_interface: MixerMutationRequestBuilder
region
Location : path
Description : Name of the region for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Required : Yes
project
Required : Yes
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])?))
Type : string
Location : path
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).
▼ ▲ compute.regionInstantSnapshotGroups.list
Scopes :
Flat Path : projects/{project}/regions/{region}/instantSnapshotGroups
Parameter Order :
Description : retrieves the list of InstantSnapshotGroup resources contained within the specified region.
Apiversion : 2026-12-01-preview
Parameters :
filter
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.
Location : query
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
maxResults
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`)
Type : integer
Minimum : 0
Default : 500
Location : query
region
Description : The name of the region for this request.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Required : Yes
pageToken
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.
Type : string
project
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])?))
Required : Yes
Location : path
Description : Project ID for this request.
HTTP Method : GET
Path : projects/{project}/regions/{region}/instantSnapshotGroups
▼ ▲ compute.acceleratorTypes.list
Scopes :
HTTP Method : GET
Description : Retrieves a list of accelerator types that are available to the specified project.
Flat Path : projects/{project}/zones/{zone}/acceleratorTypes
Parameter Order :
Parameters :
zone
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : The name of the zone for this request.
Type : string
Required : Yes
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.
maxResults
Location : query
Default : 500
Minimum : 0
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`)
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.
Required : Yes
Type : string
Location : path
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.
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
Path : projects/{project}/zones/{zone}/acceleratorTypes
Apiversion : 2026-12-01-preview
▼ ▲ compute.acceleratorTypes.aggregatedList
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/aggregated/acceleratorTypes
Parameters :
includeAllScopes
Description : Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
Type : boolean
Location : query
serviceProjectNumber
Location : query
Type : string
Description : The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.
Format : int64
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.
Type : string
Location : query
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
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
maxResults
Type : integer
Location : query
Format : uint32
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`)
Minimum : 0
filter
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.
Type : string
Description : Retrieves an aggregated list of accelerator types. To prevent failure, it is recommended that you set the `returnPartialSuccess` parameter to `true`.
Path : projects/{project}/aggregated/acceleratorTypes
Parameter Order : project
Scopes :
HTTP Method : GET
▼ ▲ compute.acceleratorTypes.get
Description : Returns the specified accelerator type.
Path : projects/{project}/zones/{zone}/acceleratorTypes/{acceleratorType}
Parameter Order :
Apiversion : 2026-12-01-preview
Parameters :
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])?))
Description : Project ID for this request.
Type : string
Required : Yes
acceleratorType
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Location : path
Description : Name of the accelerator type to return.
Type : string
zone
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Description : The name of the zone for this request.
Location : path
HTTP Method : GET
Flat Path : projects/{project}/zones/{zone}/acceleratorTypes/{acceleratorType}
Scopes :
▼ ▲ compute.regionTargetTcpProxies.insert
Apiversion : 2026-12-01-preview
Parameter Order :
Parameters :
project
Location : path
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])?))
Type : string
Required : Yes
requestId
Location : query
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
region
Required : Yes
Description : Name of the region scoping this request.
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Scopes :
Flat Path : projects/{project}/regions/{region}/targetTcpProxies
Description : Creates a TargetTcpProxy resource in the specified project and region using the data included in the request.
HTTP Method : POST
Path : projects/{project}/regions/{region}/targetTcpProxies
▼ ▲ compute.regionTargetTcpProxies.delete
Scopes :
Flat Path : projects/{project}/regions/{region}/targetTcpProxies/{targetTcpProxy}
Description : Deletes the specified TargetTcpProxy resource.
HTTP Method : DELETE
Path : projects/{project}/regions/{region}/targetTcpProxies/{targetTcpProxy}
Apiversion : 2026-12-01-preview
Parameter Order :
Parameters :
targetTcpProxy
Required : Yes
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the TargetTcpProxy resource to delete.
Location : path
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
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])?))
Description : Project ID for this request.
region
Type : string
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Description : Name of the region scoping this request.
▼ ▲ compute.regionTargetTcpProxies.get
HTTP Method : GET
Flat Path : projects/{project}/regions/{region}/targetTcpProxies/{targetTcpProxy}
Description : Returns the specified TargetTcpProxy resource.
Parameter Order :
Path : projects/{project}/regions/{region}/targetTcpProxies/{targetTcpProxy}
Scopes :
Apiversion : 2026-12-01-preview
Parameters :
region
Required : Yes
Description : Name of the region scoping this request.
Location : path
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
project
Location : path
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])?))
Description : Project ID for this request.
Required : Yes
targetTcpProxy
Required : Yes
Description : Name of the TargetTcpProxy resource to return.
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
▼ ▲ compute.regionTargetTcpProxies.list
HTTP Method : GET
Parameter Order :
Path : projects/{project}/regions/{region}/targetTcpProxies
Scopes :
Description : Retrieves a list of TargetTcpProxy resources available to the specified project in a given region.
Flat Path : projects/{project}/regions/{region}/targetTcpProxies
Apiversion : 2026-12-01-preview
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.
Type : string
Location : query
region
Type : string
Location : path
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Name of the region 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])?))
Location : path
Description : Project ID for this request.
Type : string
Required : Yes
maxResults
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`)
Minimum : 0
Format : uint32
Type : integer
Location : query
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
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.
Location : query
Type : string
▼ ▲ compute.instanceSettings.patch
Path : projects/{project}/zones/{zone}/instanceSettings
HTTP Method : PATCH
Parameters :
zone
Type : string
Description : The zone scoping this request. It should conform to RFC1035.
Location : path
Required : Yes
updateMask
Type : string
Format : google-fieldmask
Location : query
Description : update_mask indicates fields to be updated as part of this request.
project
Location : path
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])?))
Required : Yes
Type : string
requestId
Location : query
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
Scopes :
Parameter Order :
Apiversion : 2026-12-01-preview
Description : Patch Instance settings
Flat Path : projects/{project}/zones/{zone}/instanceSettings
▼ ▲ compute.instanceSettings.get
Path : projects/{project}/zones/{zone}/instanceSettings
Flat Path : projects/{project}/zones/{zone}/instanceSettings
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
Description : Project ID for this request.
Type : string
Location : path
zone
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Name of the zone for this request.
Type : string
Location : path
Apiversion : 2026-12-01-preview
Description : Get Instance settings.
HTTP Method : GET
Scopes :
Parameter Order :
▼ ▲ compute.externalVpnGateways.testIamPermissions
Description : Returns permissions that a caller has on the specified resource.
HTTP Method : POST
Parameter Order :
Parameters :
resource
Type : string
Location : path
Required : Yes
Pattern : [a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name or id of the resource for this request.
project
Location : path
Description : Project ID for this request.
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])?))
Required : Yes
Scopes :
Path : projects/{project}/global/externalVpnGateways/{resource}/testIamPermissions
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/global/externalVpnGateways/{resource}/testIamPermissions
▼ ▲ compute.externalVpnGateways.setLabels
Apiversion : 2026-12-01-preview
Parameters :
resource
Pattern : [a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Description : Name or id of the resource for this request.
Type : string
Required : Yes
project
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])?))
Location : path
Flat Path : projects/{project}/global/externalVpnGateways/{resource}/setLabels
Parameter Order :
Description : Sets the labels on an ExternalVpnGateway. To learn more about labels, read the Labeling Resources documentation.
HTTP Method : POST
Scopes :
Path : projects/{project}/global/externalVpnGateways/{resource}/setLabels
▼ ▲ compute.externalVpnGateways.insert
Parameter Order : project
Flat Path : projects/{project}/global/externalVpnGateways
HTTP Method : POST
Scopes :
Path : projects/{project}/global/externalVpnGateways
Parameters :
project
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])?))
Location : path
Description : Project ID for this request.
Required : Yes
requestId
Type : string
Location : query
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).
Apiversion : 2026-12-01-preview
Description : Creates a ExternalVpnGateway in the specified project using the data included in the request.
▼ ▲ compute.externalVpnGateways.get
Parameter Order :
HTTP Method : GET
Path : projects/{project}/global/externalVpnGateways/{externalVpnGateway}
Flat Path : projects/{project}/global/externalVpnGateways/{externalVpnGateway}
Description : Returns the specified externalVpnGateway. Get a list of available externalVpnGateways by making a list() request.
Apiversion : 2026-12-01-preview
Parameters :
project
Required : Yes
Description : Project ID for this request.
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])?))
externalVpnGateway
Required : Yes
Description : Name of the externalVpnGateway to return.
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Scopes :
▼ ▲ compute.externalVpnGateways.list
Scopes :
Description : Retrieves the list of ExternalVpnGateway available to the specified project.
Flat Path : projects/{project}/global/externalVpnGateways
HTTP Method : GET
Parameter Order : project
Path : projects/{project}/global/externalVpnGateways
Apiversion : 2026-12-01-preview
Parameters :
pageToken
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.
Type : string
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.
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
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])?))
Type : string
Required : Yes
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`)
Format : uint32
Default : 500
Type : integer
Minimum : 0
Location : query
▼ ▲ compute.externalVpnGateways.delete
Apiversion : 2026-12-01-preview
Parameter Order :
Description : Deletes the specified externalVpnGateway.
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
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])?))
Type : string
Required : Yes
Location : path
Description : Project ID for this request.
externalVpnGateway
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Location : path
Description : Name of the externalVpnGateways to delete.
Flat Path : projects/{project}/global/externalVpnGateways/{externalVpnGateway}
Scopes :
HTTP Method : DELETE
Path : projects/{project}/global/externalVpnGateways/{externalVpnGateway}
▼ ▲ compute.regionSnapshots.get
HTTP Method : GET
Description : Returns the specified Snapshot resource.
Flat Path : projects/{project}/regions/{region}/snapshots/{snapshot}
Scopes :
Path : projects/{project}/regions/{region}/snapshots/{snapshot}
Parameter Order :
Apiversion : 2026-12-01-preview
Parameters :
snapshot
Required : Yes
Type : string
Description : Name of the Snapshot resource to return.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Description : Name of the region for this request.
Required : Yes
Location : path
project
Description : Project ID for this request.
Type : string
Location : path
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])?))
▼ ▲ compute.regionSnapshots.delete
Path : projects/{project}/regions/{region}/snapshots/{snapshot}
Description : Deletes the specified Snapshot resource. Keep in mind that deleting a single snapshot might not necessarily delete all the data on that snapshot. If any data on the snapshot that is marked for deletion is needed for subsequent snapshots, the data will be moved to the next corresponding snapshot. For more information, seeDeleting snapshots.
Parameter Order :
HTTP Method : DELETE
Parameters :
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).
snapshot
Required : Yes
Description : Name of the snapshot resource to delete.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
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])?))
Description : Project ID for this request.
Required : Yes
Location : path
Type : string
region
Required : Yes
Type : string
Description : The name of the region for this request.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/regions/{region}/snapshots/{snapshot}
Scopes :
▼ ▲ compute.regionSnapshots.updateKmsKey
Flat Path : projects/{project}/regions/{region}/snapshots/{snapshot}/updateKmsKey
Scopes :
Path : projects/{project}/regions/{region}/snapshots/{snapshot}/updateKmsKey
Apiversion : 2026-12-01-preview
Parameters :
snapshot
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Description : Name of the snapshot resource to update. Should conform to RFC1035.
Type : string
Location : path
region
Location : path
Type : string
Description : Name of the region for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
project
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])?))
Description : Project ID for this request.
Required : Yes
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
HTTP Method : POST
Description : Rotates the customer-managed encryption key to the latest version for the specified snapshot.
Parameter Order :
▼ ▲ compute.regionSnapshots.insert
Flat Path : projects/{project}/regions/{region}/snapshots
Scopes :
HTTP Method : POST
Parameter Order :
Description : Creates a snapshot in the specified region using the data included in the request.
Apiversion : 2026-12-01-preview
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.
Type : string
Required : Yes
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
region
Required : Yes
Type : string
Location : path
Description : Name of the region for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Path : projects/{project}/regions/{region}/snapshots
▼ ▲ compute.regionSnapshots.setIamPolicy
Path : projects/{project}/regions/{region}/snapshots/{resource}/setIamPolicy
HTTP Method : POST
Description : Sets the access control policy on the specified resource. Replaces any existing policy.
Flat Path : projects/{project}/regions/{region}/snapshots/{resource}/setIamPolicy
Scopes :
Parameter Order :
Parameters :
region
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : The name of the region for this request.
Required : Yes
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.
Type : string
Location : path
resource
Required : Yes
Type : string
Description : Name or id of the resource for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Apiversion : 2026-12-01-preview
▼ ▲ compute.regionSnapshots.setLabels
Description : Sets the labels on a regional snapshot. To learn more about labels, read the Labeling Resources documentation.
Path : projects/{project}/regions/{region}/snapshots/{resource}/setLabels
Scopes :
Parameters :
region
Type : string
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Description : The region for 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).
Location : query
Type : string
project
Type : string
Description : Project ID for this request.
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])?))
resource
Description : Name or id of the resource for this request.
Required : Yes
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/regions/{region}/snapshots/{resource}/setLabels
Parameter Order :
HTTP Method : POST
▼ ▲ compute.regionSnapshots.testIamPermissions
Scopes :
Description : Returns permissions that a caller has on the specified resource.
Parameter Order :
Parameters :
project
Type : string
Location : path
Required : Yes
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])?))
resource
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Description : Name or id of the resource for this request.
region
Type : string
Location : path
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : The name of the region for this request.
Apiversion : 2026-12-01-preview
Path : projects/{project}/regions/{region}/snapshots/{resource}/testIamPermissions
HTTP Method : POST
Flat Path : projects/{project}/regions/{region}/snapshots/{resource}/testIamPermissions
▼ ▲ compute.regionSnapshots.getIamPolicy
Scopes :
HTTP Method : GET
Flat Path : projects/{project}/regions/{region}/snapshots/{resource}/getIamPolicy
Path : projects/{project}/regions/{region}/snapshots/{resource}/getIamPolicy
Parameter Order :
Apiversion : 2026-12-01-preview
Description : Gets the access control policy for a resource. May be empty if no such policy or resource exists.
Parameters :
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Location : path
Description : The name of the region for this request.
Type : string
project
Required : Yes
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])?))
Type : string
resource
Description : Name or id of the resource for this request.
Required : Yes
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
optionsRequestedPolicyVersion
Description : Requested IAM Policy version.
Format : int32
Type : integer
Location : query
▼ ▲ compute.regionSnapshots.list
Parameters :
region
Description : Name of the region for this request.
Location : path
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
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
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])?))
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
maxResults
Location : query
Type : integer
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`)
Format : uint32
Minimum : 0
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.
Type : string
Location : query
Flat Path : projects/{project}/regions/{region}/snapshots
Parameter Order :
Apiversion : 2026-12-01-preview
Path : projects/{project}/regions/{region}/snapshots
Description : Retrieves the list of Snapshot resources contained within the specified region.
HTTP Method : GET
Scopes :
▼ ▲ compute.regionInstantSnapshots.testIamPermissions
Parameter Order :
Scopes :
Apiversion : 2026-12-01-preview
Parameters :
region
Required : Yes
Type : string
Description : The name of the region for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
resource
Type : string
Required : Yes
Description : Name or id of the resource for this request.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
project
Location : path
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])?))
Description : Project ID for this request.
Required : Yes
HTTP Method : POST
Path : projects/{project}/regions/{region}/instantSnapshots/{resource}/testIamPermissions
Description : Returns permissions that a caller has on the specified resource.
Flat Path : projects/{project}/regions/{region}/instantSnapshots/{resource}/testIamPermissions
▼ ▲ compute.regionInstantSnapshots.get
Apiversion : 2026-12-01-preview
Path : projects/{project}/regions/{region}/instantSnapshots/{instantSnapshot}
Parameters :
instantSnapshot
Required : Yes
Location : path
Description : Name of the InstantSnapshot resource to return.
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
region
Location : path
Description : The name of the region for this request.
Required : Yes
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
project
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])?))
Location : path
Description : Returns the specified InstantSnapshot resource in the specified region.
Parameter Order :
Scopes :
Flat Path : projects/{project}/regions/{region}/instantSnapshots/{instantSnapshot}
HTTP Method : GET
▼ ▲ compute.regionInstantSnapshots.insert
Parameter Order :
Scopes :
HTTP Method : POST
Description : Creates an instant snapshot in the specified region.
Parameters :
project
Type : string
Required : Yes
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])?))
Location : path
region
Required : Yes
Description : Name of the region for this request.
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
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
Path : projects/{project}/regions/{region}/instantSnapshots
Flat Path : projects/{project}/regions/{region}/instantSnapshots
Apiversion : 2026-12-01-preview
▼ ▲ compute.regionInstantSnapshots.setLabels
HTTP Method : POST
Parameter Order :
Path : projects/{project}/regions/{region}/instantSnapshots/{resource}/setLabels
Description : Sets the labels on a instantSnapshot in the given region. To learn more about labels, read the Labeling Resources documentation.
Flat Path : projects/{project}/regions/{region}/instantSnapshots/{resource}/setLabels
Apiversion : 2026-12-01-preview
Scopes :
Parameters :
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).
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Type : string
Location : path
Description : The region for this request.
project
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])?))
Description : Project ID for this request.
resource
Description : Name or id of the resource for this request.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Location : path
▼ ▲ compute.regionInstantSnapshots.setIamPolicy
Parameters :
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : The name of the region for this request.
Required : Yes
Type : string
Location : path
resource
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Type : string
Location : path
Description : Name or id of the resource for this request.
project
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])?))
Location : path
Parameter Order :
Apiversion : 2026-12-01-preview
Path : projects/{project}/regions/{region}/instantSnapshots/{resource}/setIamPolicy
Description : Sets the access control policy on the specified resource. Replaces any existing policy.
Flat Path : projects/{project}/regions/{region}/instantSnapshots/{resource}/setIamPolicy
HTTP Method : POST
Scopes :
▼ ▲ compute.regionInstantSnapshots.getIamPolicy
Scopes :
Description : Gets the access control policy for a resource. May be empty if no such policy or resource exists.
Flat Path : projects/{project}/regions/{region}/instantSnapshots/{resource}/getIamPolicy
Path : projects/{project}/regions/{region}/instantSnapshots/{resource}/getIamPolicy
HTTP Method : GET
Parameters :
resource
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name or id of the resource for this request.
Location : path
Required : Yes
optionsRequestedPolicyVersion
Location : query
Type : integer
Description : Requested IAM Policy version.
Format : int32
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
region
Required : Yes
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Description : The name of the region for this request.
Parameter Order :
Apiversion : 2026-12-01-preview
▼ ▲ compute.regionInstantSnapshots.list
HTTP Method : GET
Path : projects/{project}/regions/{region}/instantSnapshots
Description : Retrieves the list of InstantSnapshot resources contained within the specified region.
Flat Path : projects/{project}/regions/{region}/instantSnapshots
Scopes :
Parameter Order :
Apiversion : 2026-12-01-preview
Parameters :
orderBy
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.
Location : query
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
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])?))
Required : Yes
Type : string
Description : Project ID for this request.
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`)
Location : query
Minimum : 0
Type : integer
Default : 500
Format : uint32
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
region
Location : path
Description : The name of the region for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Required : Yes
▼ ▲ compute.regionInstantSnapshots.delete
Apiversion : 2026-12-01-preview
Parameter Order :
Parameters :
instantSnapshot
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Location : path
Description : Name of the InstantSnapshot resource to delete.
Type : string
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])?))
Description : Project ID for this request.
Type : string
Required : Yes
region
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Description : The name of the region for this request.
Location : path
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).
Description : Deletes the specified InstantSnapshot resource. Keep in mind that deleting a single instantSnapshot might not necessarily delete all the data on that instantSnapshot. If any data on the instantSnapshot that is marked for deletion is needed for subsequent instantSnapshots, the data will be moved to the next corresponding instantSnapshot. For more information, seeDeleting instantSnapshots.
Path : projects/{project}/regions/{region}/instantSnapshots/{instantSnapshot}
Flat Path : projects/{project}/regions/{region}/instantSnapshots/{instantSnapshot}
Scopes :
HTTP Method : DELETE
▼ ▲ compute.networks.updatePeering
Flat Path : projects/{project}/global/networks/{network}/updatePeering
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])?))
Type : string
Required : Yes
Location : path
Description : Project ID for this request.
requestId
Location : query
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
network
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Type : string
Description : Name of the network resource which the updated peering is belonging to.
Location : path
Apiversion : 2026-12-01-preview
HTTP Method : PATCH
Description : Updates the specified network peering with the data included in the request. You can only modify the NetworkPeering.export_custom_routes field and the NetworkPeering.import_custom_routes field.
Path : projects/{project}/global/networks/{network}/updatePeering
Parameter Order :
Scopes :
▼ ▲ compute.networks.list
Apiversion : 2026-12-01-preview
Parameters :
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
filter
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.
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
Description : Project ID for this request.
Type : string
Required : Yes
maxResults
Minimum : 0
Location : query
Default : 500
Format : uint32
Type : integer
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`)
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.
Scopes :
Parameter Order : project
Description : Retrieves the list of networks available to the specified project.
Flat Path : projects/{project}/global/networks
Path : projects/{project}/global/networks
HTTP Method : GET
▼ ▲ compute.networks.insert
HTTP Method : POST
Path : projects/{project}/global/networks
Description : Creates a network in the specified project using the data included in the request.
Flat Path : projects/{project}/global/networks
Parameter Order : project
Apiversion : 2026-12-01-preview
Scopes :
Parameters :
requestId
Location : query
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
project
Description : Project ID for this request.
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])?))
Required : Yes
Location : path
▼ ▲ compute.networks.cancelRequestRemovePeering
Parameter Order :
Apiversion : 2026-12-01-preview
Parameters :
requestId
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).
Location : query
network
Location : path
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the network resource to remove peering from.
Required : Yes
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.
Required : Yes
Location : path
Type : string
Path : projects/{project}/global/networks/{network}/cancelRequestRemovePeering
Flat Path : projects/{project}/global/networks/{network}/cancelRequestRemovePeering
HTTP Method : POST
Scopes :
Description : Cancel requests to remove a peering from the specified network. Applicable only for PeeringConnection with update_strategy=CONSENSUS. Cancels a request to remove a peering from the specified network.
▼ ▲ compute.networks.patch
Path : projects/{project}/global/networks/{network}
HTTP Method : PATCH
Parameter Order :
Description : Patches the specified network with the data included in the request. Only routingConfig can be modified.
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/global/networks/{network}
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])?))
Type : string
Location : path
Description : Project ID for this request.
requestId
Location : query
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
network
Location : path
Type : string
Required : Yes
Description : Name of the network to update.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Scopes :
▼ ▲ compute.networks.removePeering
Apiversion : 2026-12-01-preview
Parameters :
project
Location : path
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])?))
Description : Project ID for this request.
Required : Yes
requestId
Location : query
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
network
Required : Yes
Description : Name of the network resource to remove peering from.
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Parameter Order :
Path : projects/{project}/global/networks/{network}/removePeering
Scopes :
Description : Removes a peering from the specified network.
Flat Path : projects/{project}/global/networks/{network}/removePeering
HTTP Method : POST
▼ ▲ compute.networks.delete
Scopes :
Description : Deletes the specified network.
Path : projects/{project}/global/networks/{network}
Flat Path : projects/{project}/global/networks/{network}
HTTP Method : DELETE
Parameters :
requestId
Type : string
Location : query
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).
network
Required : Yes
Type : string
Description : Name of the network to delete.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
project
Required : Yes
Description : Project ID for this request.
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])?))
Apiversion : 2026-12-01-preview
Parameter Order :
▼ ▲ compute.networks.listPeeringRoutes
Path : projects/{project}/global/networks/{network}/listPeeringRoutes
HTTP Method : GET
Parameter Order :
Scopes :
Flat Path : projects/{project}/global/networks/{network}/listPeeringRoutes
Description : Lists the peering routes exchanged over peering connection.
Parameters :
project
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])?))
Description : Project ID for this request.
Required : Yes
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.
Type : string
Location : query
network
Type : string
Description : Name of the network for this request.
Location : path
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
maxResults
Default : 500
Type : integer
Minimum : 0
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`)
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.
filter
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.
Type : string
direction
Enum :
Location : query
Enum Descriptions :
Type : string
Description : The direction of the exchanged routes.
region
Location : query
Type : string
Description : The region of the request. The response will include all subnet routes, static routes and dynamic routes in the region.
peeringName
Location : query
Type : string
Description : The response will show routes exchanged over the given peering connection.
Apiversion : 2026-12-01-preview
▼ ▲ compute.networks.requestRemovePeering
Apiversion : 2026-12-01-preview
Parameter Order :
Parameters :
requestId
Location : query
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
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
Type : string
Description : Project ID for this request.
Required : Yes
network
Required : Yes
Description : Name of the network resource to remove peering from.
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Scopes :
Description : Requests to remove a peering from the specified network. Applicable only for PeeringConnection with update_strategy=CONSENSUS.
Path : projects/{project}/global/networks/{network}/requestRemovePeering
Flat Path : projects/{project}/global/networks/{network}/requestRemovePeering
HTTP Method : POST
▼ ▲ compute.networks.getEffectiveFirewalls
HTTP Method : GET
Path : projects/{project}/global/networks/{network}/getEffectiveFirewalls
Scopes :
Flat Path : projects/{project}/global/networks/{network}/getEffectiveFirewalls
Description : Returns the effective firewalls on a given network.
Parameter Order :
Apiversion : 2026-12-01-preview
Parameters :
network
Type : string
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Name of the network for this request.
Location : path
project
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])?))
Type : string
Required : Yes
Location : path
▼ ▲ compute.networks.switchToCustomMode
Description : Switches the network mode from auto subnet mode to custom subnet mode.
Parameter Order :
HTTP Method : POST
Flat Path : projects/{project}/global/networks/{network}/switchToCustomMode
Scopes :
Parameters :
project
Description : Project ID for this request.
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
network
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the network to be updated.
Required : Yes
Type : string
Location : path
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).
Apiversion : 2026-12-01-preview
Path : projects/{project}/global/networks/{network}/switchToCustomMode
▼ ▲ compute.networks.addPeering
Parameter Order :
Description : Adds a peering to the specified network.
Apiversion : 2026-12-01-preview
Path : projects/{project}/global/networks/{network}/addPeering
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])?))
Type : string
Location : path
Description : Project ID for 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
network
Description : Name of the network resource to add peering to.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Location : path
HTTP Method : POST
Scopes :
Flat Path : projects/{project}/global/networks/{network}/addPeering
▼ ▲ compute.networks.get
HTTP Method : GET
Flat Path : projects/{project}/global/networks/{network}
Path : projects/{project}/global/networks/{network}
Description : Returns the specified network.
Scopes :
Parameters :
network
Location : path
Type : string
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the network to return.
project
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])?))
Required : Yes
Location : path
Description : Project ID for this request.
Apiversion : 2026-12-01-preview
Parameter Order :
▼ ▲ compute.globalNetworkEndpointGroups.attachNetworkEndpoints
Parameters :
project
Location : path
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])?))
Description : Project ID for this request.
Required : Yes
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
networkEndpointGroup
Location : path
Description : The name of the network endpoint group where you are attaching network endpoints to. It should comply with RFC1035.
Required : Yes
Type : string
Path : projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints
Apiversion : 2026-12-01-preview
Parameter Order :
Flat Path : projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints
Scopes :
HTTP Method : POST
Description : Attach a network endpoint to the specified network endpoint group.
▼ ▲ compute.globalNetworkEndpointGroups.get
HTTP Method : GET
Parameter Order :
Description : Returns the specified network endpoint group.
Flat Path : projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}
Parameters :
project
Required : Yes
Type : string
Location : path
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])?))
networkEndpointGroup
Location : path
Description : The name of the network endpoint group. It should comply with RFC1035.
Type : string
Required : Yes
Scopes :
Path : projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}
Apiversion : 2026-12-01-preview
▼ ▲ compute.globalNetworkEndpointGroups.detachNetworkEndpoints
HTTP Method : POST
Description : Detach the network endpoint from the specified network endpoint group.
Parameter Order :
Path : projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints
Flat Path : projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints
Parameters :
project
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])?))
Required : Yes
Location : path
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).
networkEndpointGroup
Required : Yes
Description : The name of the network endpoint group where you are removing network endpoints. It should comply with RFC1035.
Type : string
Location : path
Scopes :
Apiversion : 2026-12-01-preview
▼ ▲ compute.globalNetworkEndpointGroups.list
Apiversion : 2026-12-01-preview
Parameters :
pageToken
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.
Type : string
maxResults
Type : integer
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`)
Location : query
Format : uint32
Minimum : 0
Default : 500
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.
Required : Yes
Type : string
Location : path
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
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.
Parameter Order : project
Scopes :
HTTP Method : GET
Flat Path : projects/{project}/global/networkEndpointGroups
Description : Retrieves the list of network endpoint groups that are located in the specified project.
Path : projects/{project}/global/networkEndpointGroups
▼ ▲ compute.globalNetworkEndpointGroups.insert
HTTP Method : POST
Flat Path : projects/{project}/global/networkEndpointGroups
Description : Creates a network endpoint group in the specified project using the parameters that are included in the request. Note: Use the following APIs to manage network endpoint groups: - To manage NEGs with zonal scope (such as zonal NEGs, hybrid connectivity NEGs): zonal API - To manage NEGs with regional scope (such as regional internet NEGs, serverless NEGs, Private Service Connect NEGs): regional API - To manage NEGs with global scope (such as global internet NEGs):global API
Parameter Order : project
Apiversion : 2026-12-01-preview
Parameters :
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).
project
Location : path
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.
Type : string
Path : projects/{project}/global/networkEndpointGroups
Scopes :
▼ ▲ compute.globalNetworkEndpointGroups.listNetworkEndpoints
Description : Lists the network endpoints in the specified network endpoint group.
Parameters :
pageToken
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.
Type : string
project
Description : Project ID for this request.
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])?))
Required : Yes
maxResults
Format : uint32
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
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
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
Location : query
networkEndpointGroup
Type : string
Required : Yes
Description : The name of the network endpoint group from which you want to generate a list of included network endpoints. It should comply with RFC1035.
Location : path
Apiversion : 2026-12-01-preview
Parameter Order :
Path : projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}/listNetworkEndpoints
Scopes :
Flat Path : projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}/listNetworkEndpoints
HTTP Method : POST
▼ ▲ compute.globalNetworkEndpointGroups.delete
Apiversion : 2026-12-01-preview
Parameters :
networkEndpointGroup
Description : The name of the network endpoint group to delete. It should comply with RFC1035.
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).
Type : string
Location : query
project
Type : string
Description : Project ID for this request.
Location : path
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])?))
Path : projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}
Flat Path : projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}
Description : Deletes the specified network endpoint group.Note that the NEG cannot be deleted if there are backend services referencing it.
HTTP Method : DELETE
Parameter Order :
Scopes :
▼ ▲ compute.instantSnapshotGroups.getIamPolicy
Description : Gets the access control policy for a resource. May be empty if no such policy or resource exists.
Parameter Order :
HTTP Method : GET
Parameters :
zone
Description : The name of the zone for this request.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Required : Yes
optionsRequestedPolicyVersion
Format : int32
Type : integer
Description : Requested IAM Policy version.
Location : query
project
Location : path
Type : string
Required : Yes
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])?))
resource
Description : Name or id of the resource for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Type : string
Required : Yes
Apiversion : 2026-12-01-preview
Path : projects/{project}/zones/{zone}/instantSnapshotGroups/{resource}/getIamPolicy
Flat Path : projects/{project}/zones/{zone}/instantSnapshotGroups/{resource}/getIamPolicy
Scopes :
▼ ▲ compute.instantSnapshotGroups.insert
Parameter Order :
HTTP Method : POST
Flat Path : projects/{project}/zones/{zone}/instantSnapshotGroups
Path : projects/{project}/zones/{zone}/instantSnapshotGroups
Apiversion : 2026-12-01-preview
Scopes :
Description : inserts a Zonal InstantSnapshotGroup resource
Parameters :
sourceConsistencyGroup
Location : query
Description : begin_interface: MixerMutationRequestBuilder
Type : string
zone
Required : Yes
Description : Name of the zone for this request.
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
requestId
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).
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.instantSnapshotGroups.setIamPolicy
HTTP Method : POST
Description : Sets the access control policy on the specified resource. Replaces any existing policy.
Apiversion : 2026-12-01-preview
Parameters :
resource
Location : path
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name or id of the resource for this request.
Required : Yes
zone
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Required : Yes
Description : The name of the zone for this request.
Location : path
project
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])?))
Location : path
Description : Project ID for this request.
Required : Yes
Scopes :
Path : projects/{project}/zones/{zone}/instantSnapshotGroups/{resource}/setIamPolicy
Flat Path : projects/{project}/zones/{zone}/instantSnapshotGroups/{resource}/setIamPolicy
Parameter Order :
▼ ▲ compute.instantSnapshotGroups.testIamPermissions
Path : projects/{project}/zones/{zone}/instantSnapshotGroups/{resource}/testIamPermissions
Scopes :
HTTP Method : POST
Description : Returns permissions that a caller has on the specified resource.
Apiversion : 2026-12-01-preview
Parameters :
zone
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Location : path
Description : The name of the zone for this request.
project
Required : Yes
Type : string
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])?))
resource
Location : path
Type : string
Description : Name or id of the resource for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Flat Path : projects/{project}/zones/{zone}/instantSnapshotGroups/{resource}/testIamPermissions
Parameter Order :
▼ ▲ compute.instantSnapshotGroups.list
Flat Path : projects/{project}/zones/{zone}/instantSnapshotGroups
HTTP Method : GET
Parameter Order :
Scopes :
Description : retrieves the list of InstantSnapshotGroup resources contained within the specified zone.
Apiversion : 2026-12-01-preview
Parameters :
maxResults
Location : query
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`)
Format : uint32
Minimum : 0
Type : integer
Default : 500
zone
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : The name of the zone for this request.
Required : Yes
Location : path
Type : string
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.
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.
Type : string
Location : path
Required : Yes
pageToken
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.
Type : string
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.
Path : projects/{project}/zones/{zone}/instantSnapshotGroups
▼ ▲ compute.instantSnapshotGroups.delete
Apiversion : 2026-12-01-preview
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).
Location : query
Type : string
zone
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Type : string
Location : path
Description : The name of the zone for this request.
instantSnapshotGroup
Description : Name of the InstantSnapshot resource to delete.
Required : Yes
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
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])?))
Location : path
Description : Project ID for this request.
Type : string
Description : deletes a Zonal InstantSnapshotGroup resource
Scopes :
Parameter Order :
Path : projects/{project}/zones/{zone}/instantSnapshotGroups/{instantSnapshotGroup}
Flat Path : projects/{project}/zones/{zone}/instantSnapshotGroups/{instantSnapshotGroup}
HTTP Method : DELETE
▼ ▲ compute.instantSnapshotGroups.get
Parameter Order :
HTTP Method : GET
Description : returns the specified InstantSnapshotGroup resource in the specified zone.
Flat Path : projects/{project}/zones/{zone}/instantSnapshotGroups/{instantSnapshotGroup}
Apiversion : 2026-12-01-preview
Scopes :
Parameters :
project
Location : path
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])?))
Required : Yes
Description : Project ID for this request.
instantSnapshotGroup
Location : path
Description : Name of the InstantSnapshotGroup resource to return.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Required : Yes
zone
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Type : string
Location : path
Description : The name of the zone for this request.
Path : projects/{project}/zones/{zone}/instantSnapshotGroups/{instantSnapshotGroup}
▼ ▲ compute.autoscalers.delete
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/zones/{zone}/autoscalers/{autoscaler}
Parameter Order :
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
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
zone
Type : string
Location : path
Description : Name of the zone for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
autoscaler
Required : Yes
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the autoscaler to delete.
Scopes :
HTTP Method : DELETE
Description : Deletes the specified autoscaler.
Path : projects/{project}/zones/{zone}/autoscalers/{autoscaler}
▼ ▲ compute.autoscalers.get
HTTP Method : GET
Parameter Order :
Description : Returns the specified autoscaler resource.
Flat Path : projects/{project}/zones/{zone}/autoscalers/{autoscaler}
Path : projects/{project}/zones/{zone}/autoscalers/{autoscaler}
Apiversion : 2026-12-01-preview
Scopes :
Parameters :
zone
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Description : Name of the zone for this request.
project
Location : path
Description : Project ID for this request.
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])?))
Type : string
autoscaler
Required : Yes
Location : path
Description : Name of the autoscaler to return.
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
▼ ▲ compute.autoscalers.update
Parameter Order :
HTTP Method : PUT
Description : Updates an autoscaler in the specified project using the data included in the request.
Flat Path : projects/{project}/zones/{zone}/autoscalers
Scopes :
Path : projects/{project}/zones/{zone}/autoscalers
Parameters :
autoscaler
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Description : Name of the autoscaler to update.
Location : query
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
Required : Yes
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])?))
Type : string
zone
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Description : Name of the zone for this request.
Apiversion : 2026-12-01-preview
▼ ▲ compute.autoscalers.patch
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/zones/{zone}/autoscalers
Scopes :
Parameters :
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).
autoscaler
Description : Name of the autoscaler to patch.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : query
Type : string
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.
zone
Required : Yes
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Name of the zone for this request.
Location : path
Parameter Order :
Description : Updates an autoscaler in the specified project using the data included in the request. This method supportsPATCH semantics and uses theJSON merge patch format and processing rules.
HTTP Method : PATCH
Path : projects/{project}/zones/{zone}/autoscalers
▼ ▲ compute.autoscalers.aggregatedList
Parameters :
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.
serviceProjectNumber
Format : int64
Type : string
Location : query
Description : The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.
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
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])?))
Description : Project ID for this request.
Required : Yes
Type : string
maxResults
Location : query
Type : integer
Format : uint32
Minimum : 0
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`)
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
includeAllScopes
Description : Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
Location : query
Type : boolean
Flat Path : projects/{project}/aggregated/autoscalers
Apiversion : 2026-12-01-preview
Scopes :
Description : Retrieves an aggregated list of autoscalers. To prevent failure, it is recommended that you set the `returnPartialSuccess` parameter to `true`.
Path : projects/{project}/aggregated/autoscalers
HTTP Method : GET
Parameter Order : project
▼ ▲ compute.autoscalers.insert
Flat Path : projects/{project}/zones/{zone}/autoscalers
Scopes :
Parameter Order :
HTTP Method : POST
Parameters :
zone
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Name of the zone for this request.
Required : Yes
Location : path
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
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.
Type : string
Required : Yes
Description : Creates an autoscaler in the specified project using the data included in the request.
Apiversion : 2026-12-01-preview
Path : projects/{project}/zones/{zone}/autoscalers
▼ ▲ compute.autoscalers.list
HTTP Method : GET
Parameter Order :
Path : projects/{project}/zones/{zone}/autoscalers
Description : Retrieves a list of autoscalers contained within the specified zone.
Scopes :
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/zones/{zone}/autoscalers
Parameters :
zone
Required : Yes
Description : Name of the zone for this request.
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
maxResults
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`)
Minimum : 0
Format : uint32
Location : query
Type : integer
orderBy
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.
Location : query
filter
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.
Location : query
project
Location : path
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])?))
Description : Project ID for this request.
Required : Yes
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
▼ ▲ compute.autoscalers.testIamPermissions
Scopes :
Apiversion : 2026-12-01-preview
Parameters :
project
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])?))
Description : Project ID for this request.
resource
Description : Name or id of the resource for this request.
Location : path
Required : Yes
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
zone
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Description : The name of the zone for this request.
Required : Yes
HTTP Method : POST
Description : Returns permissions that a caller has on the specified resource.
Path : projects/{project}/zones/{zone}/autoscalers/{resource}/testIamPermissions
Flat Path : projects/{project}/zones/{zone}/autoscalers/{resource}/testIamPermissions
Parameter Order :
▼ ▲ compute.rolloutPlans.delete
Flat Path : projects/{project}/global/rolloutPlans/{rolloutPlan}
HTTP Method : DELETE
Apiversion : 2026-12-01-preview
Path : projects/{project}/global/rolloutPlans/{rolloutPlan}
Parameters :
project
Location : path
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])?))
Required : Yes
Description : Project ID for this request.
requestId
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).
Location : query
rolloutPlan
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the RolloutPlan resource to delete.
Required : Yes
Type : string
Scopes :
Parameter Order :
Description : Deletes a RolloutPlan.
▼ ▲ compute.rolloutPlans.insert
Description : Creates a new RolloutPlan in a given project and location.
Scopes :
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
project
Type : string
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
Flat Path : projects/{project}/global/rolloutPlans
Apiversion : 2026-12-01-preview
HTTP Method : POST
Path : projects/{project}/global/rolloutPlans
Parameter Order : project
▼ ▲ compute.rolloutPlans.list
Apiversion : 2026-12-01-preview
Scopes :
Parameters :
maxResults
Minimum : 0
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`)
Default : 500
Type : integer
Location : query
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.
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.
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
project
Type : string
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
Parameter Order : project
Flat Path : projects/{project}/global/rolloutPlans
Description : Lists RolloutPlans in a given project and location.
HTTP Method : GET
Path : projects/{project}/global/rolloutPlans
▼ ▲ compute.rolloutPlans.get
Path : projects/{project}/global/rolloutPlans/{rolloutPlan}
HTTP Method : GET
Flat Path : projects/{project}/global/rolloutPlans/{rolloutPlan}
Parameter Order :
Apiversion : 2026-12-01-preview
Parameters :
rolloutPlan
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Type : string
Description : Name of the persistent rollout plan to return.
project
Required : Yes
Description : Project ID for this request.
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])?))
Scopes :
Description : Gets details of a single project-scoped RolloutPlan.
▼ ▲ compute.storagePoolTypes.aggregatedList
Parameters :
maxResults
Type : integer
Location : query
Default : 500
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`)
Format : uint32
serviceProjectNumber
Location : query
Format : int64
Type : string
Description : The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.
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
Required : Yes
Description : Project ID for this request.
includeAllScopes
Type : boolean
Description : Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
Location : query
filter
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.
Type : string
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.
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
Apiversion : 2026-12-01-preview
Scopes :
Path : projects/{project}/aggregated/storagePoolTypes
Parameter Order : project
Description : Retrieves an aggregated list of storage pool types. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.
Flat Path : projects/{project}/aggregated/storagePoolTypes
HTTP Method : GET
▼ ▲ compute.storagePoolTypes.list
Description : Retrieves a list of storage pool types available to the specified project.
Flat Path : projects/{project}/zones/{zone}/storagePoolTypes
Apiversion : 2026-12-01-preview
Parameters :
project
Description : Project ID for this request.
Location : path
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])?))
zone
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Description : The name of the zone for this request.
Required : Yes
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.
orderBy
Type : string
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.
maxResults
Format : uint32
Location : query
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`)
Minimum : 0
Default : 500
Type : integer
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.
HTTP Method : GET
Parameter Order :
Path : projects/{project}/zones/{zone}/storagePoolTypes
Scopes :
▼ ▲ compute.storagePoolTypes.get
Scopes :
Parameters :
zone
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Location : path
Required : Yes
Description : The name of the zone for 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])?))
Location : path
Description : Project ID for this request.
Required : Yes
Type : string
storagePoolType
Location : path
Description : Name of the storage pool type to return.
Type : string
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Parameter Order :
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/zones/{zone}/storagePoolTypes/{storagePoolType}
Path : projects/{project}/zones/{zone}/storagePoolTypes/{storagePoolType}
Description : Returns the specified storage pool type.
HTTP Method : GET
▼ ▲ compute.globalVmExtensionPolicies.aggregatedList
Path : projects/{project}/aggregated/vmExtensionPolicies
Parameter Order : project
Description : Retrieves the list of all VM Extension Policy resources available to the specified project. To prevent failure, it's recommended that you set the `returnPartialSuccess` parameter to `true`.
Scopes :
Parameters :
filter
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.
Location : query
orderBy
Type : string
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.
includeAllScopes
Location : query
Type : boolean
Description : Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
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])?))
Type : string
Required : Yes
Description : Name of the project scoping this request.
Location : path
serviceProjectNumber
Type : string
Location : query
Format : int64
Description : The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.
maxResults
Location : query
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`)
Default : 500
Type : integer
Minimum : 0
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.
Type : string
Location : query
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/aggregated/vmExtensionPolicies
HTTP Method : GET
▼ ▲ compute.globalVmExtensionPolicies.insert
Apiversion : 2026-12-01-preview
Parameters :
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])?))
Description : Project ID for this request.
Required : Yes
Type : string
requestId
Type : string
Location : query
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).
Description : Creates a new project level GlobalVmExtensionPolicy.
Flat Path : projects/{project}/global/vmExtensionPolicies
Parameter Order : project
Scopes :
HTTP Method : POST
Path : projects/{project}/global/vmExtensionPolicies
▼ ▲ compute.globalVmExtensionPolicies.get
Path : projects/{project}/global/vmExtensionPolicies/{globalVmExtensionPolicy}
HTTP Method : GET
Parameter Order :
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/global/vmExtensionPolicies/{globalVmExtensionPolicy}
Scopes :
Parameters :
project
Required : Yes
Type : string
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])?))
globalVmExtensionPolicy
Required : Yes
Description : Name of the GlobalVmExtensionPolicy resource to return.
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Gets details of a global VM extension policy.
▼ ▲ compute.globalVmExtensionPolicies.list
Path : projects/{project}/global/vmExtensionPolicies
Parameters :
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
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
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.
maxResults
Format : uint32
Location : query
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
Minimum : 0
Default : 500
filter
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.
Location : query
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/global/vmExtensionPolicies
Description : Lists global VM extension policies.
HTTP Method : GET
Scopes :
Parameter Order : project
▼ ▲ compute.globalVmExtensionPolicies.update
Path : projects/{project}/global/vmExtensionPolicies/{globalVmExtensionPolicy}
Parameter Order :
HTTP Method : PATCH
Description : Updates a global VM extension policy.
Flat Path : projects/{project}/global/vmExtensionPolicies/{globalVmExtensionPolicy}
Parameters :
globalVmExtensionPolicy
Required : Yes
Location : path
Type : string
Description : Name of the global VM extension policy to update.
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
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
Scopes :
Apiversion : 2026-12-01-preview
▼ ▲ compute.globalVmExtensionPolicies.delete
Scopes :
Path : projects/{project}/global/vmExtensionPolicies/{globalVmExtensionPolicy}/delete
Description : Purge scoped resources (zonal policies) from a global VM extension policy, and then delete the global VM extension policy. Purge of the scoped resources is a pre-condition of the global VM extension policy deletion. The deletion of the global VM extension policy happens after the purge rollout is done, so it's not a part of the LRO. It's an automatic process that triggers in the backend.
Flat Path : projects/{project}/global/vmExtensionPolicies/{globalVmExtensionPolicy}/delete
Parameters :
project
Required : Yes
Description : Project ID for this request.
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])?))
Location : path
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
globalVmExtensionPolicy
Location : path
Description : Name of the global VM extension policy to purge scoped resources for.
Type : string
Required : Yes
Parameter Order :
Apiversion : 2026-12-01-preview
HTTP Method : POST
▼ ▲ compute.regionHealthChecks.update
Path : projects/{project}/regions/{region}/healthChecks/{healthCheck}
Flat Path : projects/{project}/regions/{region}/healthChecks/{healthCheck}
Description : Updates a HealthCheck resource in the specified project using the data included in the request.
Apiversion : 2026-12-01-preview
Parameters :
project
Required : Yes
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])?))
Type : string
region
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Name of the region scoping this request.
Type : string
Required : Yes
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
healthCheck
Required : Yes
Description : Name of the HealthCheck resource to update.
Location : path
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Scopes :
HTTP Method : PUT
Parameter Order :
▼ ▲ compute.regionHealthChecks.testIamPermissions
Path : projects/{project}/regions/{region}/healthChecks/{resource}/testIamPermissions
HTTP Method : POST
Scopes :
Parameters :
region
Description : The name of the region for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Type : string
Location : path
project
Required : Yes
Description : Project ID for this request.
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])?))
resource
Description : Name or id of the resource for this request.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Type : string
Apiversion : 2026-12-01-preview
Parameter Order :
Description : Returns permissions that a caller has on the specified resource.
Flat Path : projects/{project}/regions/{region}/healthChecks/{resource}/testIamPermissions
▼ ▲ compute.regionHealthChecks.patch
Apiversion : 2026-12-01-preview
Parameters :
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])?))
Required : Yes
Type : string
Description : Project ID for this request.
region
Required : Yes
Description : Name of the region scoping this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
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
healthCheck
Location : path
Required : Yes
Type : string
Description : Name of the HealthCheck resource to patch.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Flat Path : projects/{project}/regions/{region}/healthChecks/{healthCheck}
HTTP Method : PATCH
Description : Updates a HealthCheck resource in the specified project using the data included in the request. This method supportsPATCH semantics and uses theJSON merge patch format and processing rules.
Scopes :
Parameter Order :
Path : projects/{project}/regions/{region}/healthChecks/{healthCheck}
▼ ▲ compute.regionHealthChecks.delete
Flat Path : projects/{project}/regions/{region}/healthChecks/{healthCheck}
Parameter Order :
Parameters :
requestId
Location : query
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
project
Required : Yes
Description : Project ID for this request.
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])?))
healthCheck
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the HealthCheck resource to delete.
Type : string
Location : path
region
Required : Yes
Description : Name of the region scoping this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Type : string
Apiversion : 2026-12-01-preview
Description : Deletes the specified HealthCheck resource.
HTTP Method : DELETE
Scopes :
Path : projects/{project}/regions/{region}/healthChecks/{healthCheck}
▼ ▲ compute.regionHealthChecks.list
Parameters :
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.
maxResults
Default : 500
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`)
Format : uint32
Location : query
Type : integer
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.
Type : string
Location : query
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.
Type : string
Location : query
project
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])?))
Required : Yes
Description : Project ID for this request.
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Type : string
Location : path
Description : Name of the region scoping this request.
Parameter Order :
Apiversion : 2026-12-01-preview
Scopes :
Path : projects/{project}/regions/{region}/healthChecks
Description : Retrieves the list of HealthCheck resources available to the specified project.
Flat Path : projects/{project}/regions/{region}/healthChecks
HTTP Method : GET
▼ ▲ compute.regionHealthChecks.get
HTTP Method : GET
Scopes :
Flat Path : projects/{project}/regions/{region}/healthChecks/{healthCheck}
Description : Returns the specified HealthCheck resource.
Path : projects/{project}/regions/{region}/healthChecks/{healthCheck}
Apiversion : 2026-12-01-preview
Parameter Order :
Parameters :
region
Required : Yes
Description : Name of the region scoping this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Location : path
project
Location : path
Required : Yes
Description : Project ID for this request.
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])?))
healthCheck
Required : Yes
Description : Name of the HealthCheck resource to return.
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
▼ ▲ compute.regionHealthChecks.insert
Path : projects/{project}/regions/{region}/healthChecks
HTTP Method : POST
Flat Path : projects/{project}/regions/{region}/healthChecks
Parameter Order :
Description : Creates a HealthCheck resource in the specified project using the data included in the request.
Scopes :
Parameters :
project
Location : path
Type : string
Description : Project ID for this request.
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])?))
region
Type : string
Location : path
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Name of the region scoping this request.
requestId
Location : query
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
Apiversion : 2026-12-01-preview
▼ ▲ compute.serviceAttachments.patch
Description : Patches the specified ServiceAttachment resource with the data included in the request. This method supports PATCH semantics and usesJSON merge patch format and processing rules.
HTTP Method : PATCH
Flat Path : projects/{project}/regions/{region}/serviceAttachments/{serviceAttachment}
Scopes :
Path : projects/{project}/regions/{region}/serviceAttachments/{serviceAttachment}
Parameter Order :
Parameters :
project
Type : string
Description : Project ID for this request.
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])?))
Location : path
region
Location : path
Description : The region scoping this request and should conform to RFC1035.
Type : string
Required : Yes
serviceAttachment
Required : Yes
Type : string
Location : path
Description : The resource id of the ServiceAttachment to patch. It should conform to RFC1035 resource name or be a string form on an unsigned long number.
requestId
Type : string
Location : query
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).
Apiversion : 2026-12-01-preview
▼ ▲ compute.serviceAttachments.list
Path : projects/{project}/regions/{region}/serviceAttachments
Flat Path : projects/{project}/regions/{region}/serviceAttachments
Scopes :
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.
Location : query
Type : string
maxResults
Location : query
Type : integer
Format : uint32
Minimum : 0
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`)
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.
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Description : Name of the region of this request.
Type : string
Location : path
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
Location : path
Description : Project ID for this request.
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.
Apiversion : 2026-12-01-preview
HTTP Method : GET
Description : Lists the ServiceAttachments for a project in the given scope.
Parameter Order :
▼ ▲ compute.serviceAttachments.get
HTTP Method : GET
Path : projects/{project}/regions/{region}/serviceAttachments/{serviceAttachment}
Flat Path : projects/{project}/regions/{region}/serviceAttachments/{serviceAttachment}
Scopes :
Parameter Order :
Parameters :
showNatIps
Description : Indicates whether NAT IPs should be included in the response.
Type : boolean
Location : query
serviceAttachment
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Description : Name of the ServiceAttachment resource to return.
Location : path
Type : string
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])?))
Location : path
Type : string
Description : Project ID for this request.
region
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Location : path
Description : Name of the region of this request.
Description : Returns the specified ServiceAttachment resource in the given scope.
Apiversion : 2026-12-01-preview
▼ ▲ compute.serviceAttachments.getIamPolicy
Path : projects/{project}/regions/{region}/serviceAttachments/{resource}/getIamPolicy
Scopes :
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
Description : Project ID for this request.
Type : string
Required : Yes
region
Location : path
Description : The name of the region for this request.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
resource
Required : Yes
Type : string
Description : Name or id of the resource for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
optionsRequestedPolicyVersion
Location : query
Type : integer
Description : Requested IAM Policy version.
Format : int32
Description : Gets the access control policy for a resource. May be empty if no such policy or resource exists.
Apiversion : 2026-12-01-preview
HTTP Method : GET
Flat Path : projects/{project}/regions/{region}/serviceAttachments/{resource}/getIamPolicy
▼ ▲ compute.serviceAttachments.aggregatedList
HTTP Method : GET
Description : Retrieves the list of all ServiceAttachment resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.
Parameter Order : project
Scopes :
Path : projects/{project}/aggregated/serviceAttachments
Parameters :
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.
Type : string
Location : query
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
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.
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])?))
Type : string
Description : Name of the project scoping this request.
Location : path
serviceProjectNumber
Description : The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.
Type : string
Format : int64
Location : query
includeAllScopes
Description : Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
Location : query
Type : boolean
maxResults
Format : uint32
Default : 500
Minimum : 0
Location : query
Type : integer
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`)
Flat Path : projects/{project}/aggregated/serviceAttachments
Apiversion : 2026-12-01-preview
▼ ▲ compute.serviceAttachments.setIamPolicy
Scopes :
Parameters :
region
Location : path
Required : Yes
Type : string
Description : The name of the region for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
resource
Type : string
Description : Name or id of the resource for this request.
Location : path
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
project
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])?))
Description : Project ID for this request.
Location : path
Parameter Order :
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/regions/{region}/serviceAttachments/{resource}/setIamPolicy
Description : Sets the access control policy on the specified resource. Replaces any existing policy.
Path : projects/{project}/regions/{region}/serviceAttachments/{resource}/setIamPolicy
HTTP Method : POST
▼ ▲ compute.serviceAttachments.testIamPermissions
Scopes :
Description : Returns permissions that a caller has on the specified resource.
Path : projects/{project}/regions/{region}/serviceAttachments/{resource}/testIamPermissions
Parameter Order :
HTTP Method : POST
Parameters :
project
Location : path
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])?))
Required : Yes
Type : string
region
Description : The name of the region for this request.
Location : path
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
resource
Description : Name or id of the resource for this request.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Type : string
Flat Path : projects/{project}/regions/{region}/serviceAttachments/{resource}/testIamPermissions
Apiversion : 2026-12-01-preview
▼ ▲ compute.serviceAttachments.delete
HTTP Method : DELETE
Path : projects/{project}/regions/{region}/serviceAttachments/{serviceAttachment}
Description : Deletes the specified ServiceAttachment in the given scope
Parameter Order :
Flat Path : projects/{project}/regions/{region}/serviceAttachments/{serviceAttachment}
Parameters :
serviceAttachment
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Description : Name of the ServiceAttachment resource to delete.
Location : path
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).
project
Type : string
Required : Yes
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])?))
Location : path
region
Description : Name of the region of this request.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Required : Yes
Scopes :
Apiversion : 2026-12-01-preview
▼ ▲ compute.serviceAttachments.insert
Parameter Order :
HTTP Method : POST
Scopes :
Description : Creates a ServiceAttachment in the specified project in the given scope using the parameters that are included in the request.
Flat Path : projects/{project}/regions/{region}/serviceAttachments
Parameters :
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Type : string
Location : path
Description : Name of the region of this request.
project
Required : Yes
Type : string
Location : path
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])?))
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).
Apiversion : 2026-12-01-preview
Path : projects/{project}/regions/{region}/serviceAttachments
▼ ▲ compute.reliabilityRisks.get
HTTP Method : GET
Scopes :
Description : Returns the specified ReliabilityRisk resource.
Parameter Order :
Path : projects/{project}/global/reliabilityRisks/{reliabilityRisk}
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/global/reliabilityRisks/{reliabilityRisk}
Parameters :
project
Required : Yes
Description : Project ID for this request.
Location : path
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])?))
reliabilityRisk
Type : string
Location : path
Description : Name of the ReliabilityRisk resource to return.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
▼ ▲ compute.reliabilityRisks.list
Scopes :
Path : projects/{project}/global/reliabilityRisks
HTTP Method : GET
Description : Retrieves the list of reliabilityRisks available in the specified project.
Apiversion : 2026-12-01-preview
Parameter Order : project
Parameters :
orderBy
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.
Location : query
filter
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.
Location : query
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])?))
Type : string
Required : Yes
Description : Project ID for this request.
Location : path
maxResults
Format : uint32
Minimum : 0
Default : 500
Location : query
Type : integer
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`)
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.
Flat Path : projects/{project}/global/reliabilityRisks
▼ ▲ compute.targetPools.removeInstance
Parameters :
targetPool
Required : Yes
Description : Name of the TargetPool resource to remove instances from.
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
region
Type : string
Required : Yes
Description : Name of the region scoping this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
requestId
Type : string
Location : query
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).
project
Description : Project ID for this request.
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])?))
Required : Yes
Parameter Order :
Apiversion : 2026-12-01-preview
Scopes :
Description : Removes instance URL from a target pool.
Flat Path : projects/{project}/regions/{region}/targetPools/{targetPool}/removeInstance
Path : projects/{project}/regions/{region}/targetPools/{targetPool}/removeInstance
HTTP Method : POST
▼ ▲ compute.targetPools.list
Parameters :
region
Required : Yes
Description : Name of the region scoping this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Type : string
maxResults
Minimum : 0
Default : 500
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`)
Location : query
Type : integer
orderBy
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.
Location : query
pageToken
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.
Type : string
filter
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.
Location : query
project
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])?))
Required : Yes
Description : Project ID for this request.
Location : path
Scopes :
Parameter Order :
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/regions/{region}/targetPools
Path : projects/{project}/regions/{region}/targetPools
Description : Retrieves a list of target pools available to the specified project and region.
HTTP Method : GET
▼ ▲ compute.targetPools.removeHealthCheck
Flat Path : projects/{project}/regions/{region}/targetPools/{targetPool}/removeHealthCheck
Apiversion : 2026-12-01-preview
Parameters :
project
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])?))
Required : Yes
Location : path
Type : string
targetPool
Location : path
Description : Name of the target pool to remove health checks from.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Required : Yes
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Required : Yes
Location : path
Description : Name of the region for this request.
requestId
Type : string
Location : query
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).
HTTP Method : POST
Path : projects/{project}/regions/{region}/targetPools/{targetPool}/removeHealthCheck
Parameter Order :
Scopes :
Description : Removes health check URL from a target pool.
▼ ▲ compute.targetPools.addHealthCheck
Flat Path : projects/{project}/regions/{region}/targetPools/{targetPool}/addHealthCheck
Parameter Order :
Scopes :
HTTP Method : POST
Apiversion : 2026-12-01-preview
Parameters :
region
Description : Name of the region scoping this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Type : string
Required : Yes
targetPool
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Type : string
Description : Name of the target pool to add a health check to.
Location : path
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
Description : Project ID for this request.
Location : path
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])?))
Required : Yes
Path : projects/{project}/regions/{region}/targetPools/{targetPool}/addHealthCheck
Description : Adds health check URLs to a target pool.
▼ ▲ compute.targetPools.setBackup
HTTP Method : POST
Flat Path : projects/{project}/regions/{region}/targetPools/{targetPool}/setBackup
Scopes :
Parameter Order :
Description : Changes a backup target pool's configurations.
Parameters :
requestId
Type : string
Location : query
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).
region
Type : string
Required : Yes
Description : Name of the region scoping this request.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
targetPool
Description : Name of the TargetPool resource to set a backup pool for.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Type : string
project
Type : string
Location : path
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.
failoverRatio
Type : number
Location : query
Description : New failoverRatio value for the target pool.
Format : float
Apiversion : 2026-12-01-preview
Path : projects/{project}/regions/{region}/targetPools/{targetPool}/setBackup
▼ ▲ compute.targetPools.setSecurityPolicy
Description : Sets the Google Cloud Armor security policy for the specified target pool. For more information, seeGoogle Cloud Armor Overview
Scopes :
Apiversion : 2026-12-01-preview
Parameter Order :
Parameters :
region
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Name of the region scoping this request.
Location : path
Type : string
project
Location : path
Required : Yes
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])?))
Type : string
targetPool
Required : Yes
Type : string
Description : Name of the TargetPool resource to which the security policy should be set. The name should conform to RFC1035.
Location : path
requestId
Location : query
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
HTTP Method : POST
Path : projects/{project}/regions/{region}/targetPools/{targetPool}/setSecurityPolicy
Flat Path : projects/{project}/regions/{region}/targetPools/{targetPool}/setSecurityPolicy
▼ ▲ compute.targetPools.aggregatedList
Path : projects/{project}/aggregated/targetPools
HTTP Method : GET
Parameter Order : project
Parameters :
pageToken
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.
Type : string
maxResults
Default : 500
Type : integer
Minimum : 0
Format : uint32
Location : query
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`)
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])?))
Type : string
Location : path
Description : Project ID for this request.
Required : Yes
includeAllScopes
Type : boolean
Location : query
Description : Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
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.
Location : query
Type : string
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
serviceProjectNumber
Type : string
Location : query
Description : The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.
Format : int64
Flat Path : projects/{project}/aggregated/targetPools
Apiversion : 2026-12-01-preview
Description : Retrieves an aggregated list of target pools. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.
Scopes :
▼ ▲ compute.targetPools.getHealth
Scopes :
Flat Path : projects/{project}/regions/{region}/targetPools/{targetPool}/getHealth
Parameter Order :
HTTP Method : POST
Path : projects/{project}/regions/{region}/targetPools/{targetPool}/getHealth
Description : Gets the most recent health check results for each IP for the instance that is referenced by the given target pool.
Parameters :
region
Required : Yes
Description : Name of the region scoping this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Location : path
targetPool
Description : Name of the TargetPool resource to which the queried instance belongs.
Location : path
Type : string
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
project
Location : path
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])?))
Required : Yes
Apiversion : 2026-12-01-preview
▼ ▲ compute.targetPools.insert
Description : Creates a target pool in the specified project and region using the data included in the request.
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
region
Description : Name of the region scoping this request.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Type : string
project
Description : Project ID for this request.
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
Scopes :
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/regions/{region}/targetPools
HTTP Method : POST
Parameter Order :
Path : projects/{project}/regions/{region}/targetPools
▼ ▲ compute.targetPools.delete
Flat Path : projects/{project}/regions/{region}/targetPools/{targetPool}
Apiversion : 2026-12-01-preview
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
Description : Project ID for this request.
Location : path
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
targetPool
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the TargetPool resource to delete.
Required : Yes
Type : string
Location : path
region
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Description : Name of the region scoping this request.
Parameter Order :
Scopes :
Description : Deletes the specified target pool.
HTTP Method : DELETE
Path : projects/{project}/regions/{region}/targetPools/{targetPool}
▼ ▲ compute.targetPools.addInstance
HTTP Method : POST
Scopes :
Path : projects/{project}/regions/{region}/targetPools/{targetPool}/addInstance
Flat Path : projects/{project}/regions/{region}/targetPools/{targetPool}/addInstance
Parameter Order :
Apiversion : 2026-12-01-preview
Description : Adds an instance to a target pool.
Parameters :
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Description : Name of the region scoping this request.
Type : string
Required : Yes
project
Type : string
Required : Yes
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])?))
Location : path
targetPool
Required : Yes
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the TargetPool resource to add instances to.
Location : path
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
▼ ▲ compute.targetPools.get
Flat Path : projects/{project}/regions/{region}/targetPools/{targetPool}
Scopes :
HTTP Method : GET
Description : Returns the specified target pool.
Path : projects/{project}/regions/{region}/targetPools/{targetPool}
Apiversion : 2026-12-01-preview
Parameter Order :
Parameters :
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Name of the region scoping this request.
Location : path
Type : string
Required : Yes
project
Required : Yes
Description : Project ID for this request.
Location : path
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])?))
targetPool
Location : path
Description : Name of the TargetPool resource to return.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Required : Yes
▼ ▲ compute.targetPools.testIamPermissions
HTTP Method : POST
Flat Path : projects/{project}/regions/{region}/targetPools/{resource}/testIamPermissions
Scopes :
Description : Returns permissions that a caller has on the specified resource.
Parameter Order :
Path : projects/{project}/regions/{region}/targetPools/{resource}/testIamPermissions
Parameters :
resource
Type : string
Location : path
Description : Name or id of the resource for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
project
Location : path
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])?))
Required : Yes
Description : Project ID for this request.
region
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Required : Yes
Description : The name of the region for this request.
Apiversion : 2026-12-01-preview
▼ ▲ compute.regionInstanceGroups.get
HTTP Method : GET
Parameter Order :
Scopes :
Flat Path : projects/{project}/regions/{region}/instanceGroups/{instanceGroup}
Description : Returns the specified instance group resource.
Apiversion : 2026-12-01-preview
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.
Type : string
Location : path
region
Required : Yes
Description : Name of the region scoping this request.
Type : string
Location : path
instanceGroup
Location : path
Description : Name of the instance group resource to return.
Type : string
Required : Yes
Path : projects/{project}/regions/{region}/instanceGroups/{instanceGroup}
▼ ▲ compute.regionInstanceGroups.testIamPermissions
Parameters :
project
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])?))
Description : Project ID for this request.
Location : path
region
Required : Yes
Description : The name of the region for this request.
Location : path
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
resource
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Description : Name or id of the resource for this request.
Location : path
Apiversion : 2026-12-01-preview
Scopes :
Flat Path : projects/{project}/regions/{region}/instanceGroups/{resource}/testIamPermissions
Path : projects/{project}/regions/{region}/instanceGroups/{resource}/testIamPermissions
Parameter Order :
Description : Returns permissions that a caller has on the specified resource.
HTTP Method : POST
▼ ▲ compute.regionInstanceGroups.listInstances
Scopes :
Parameters :
instanceGroup
Required : Yes
Type : string
Location : path
Description : Name of the regional instance group for which we want to list the instances.
filter
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.
Type : string
maxResults
Type : integer
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`)
Location : query
Default : 500
Format : uint32
Minimum : 0
orderBy
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.
Location : query
region
Required : Yes
Description : Name of the region scoping this request.
Type : string
Location : path
project
Required : Yes
Description : Project ID for this request.
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])?))
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.
Type : string
Location : query
Description : Lists the instances in the specified instance group and displays information about the named ports. Depending on the specified options, this method can list all instances or only the instances that are running. The orderBy query parameter is not supported.
Apiversion : 2026-12-01-preview
Path : projects/{project}/regions/{region}/instanceGroups/{instanceGroup}/listInstances
Flat Path : projects/{project}/regions/{region}/instanceGroups/{instanceGroup}/listInstances
HTTP Method : POST
Parameter Order :
▼ ▲ compute.regionInstanceGroups.list
Path : projects/{project}/regions/{region}/instanceGroups
HTTP Method : GET
Description : Retrieves the list of instance group resources contained within the specified region.
Scopes :
Flat Path : projects/{project}/regions/{region}/instanceGroups
Parameters :
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.
maxResults
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`)
Type : integer
Default : 500
Minimum : 0
Location : query
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
Type : string
Location : path
Description : Project ID for this request.
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])?))
orderBy
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.
Location : query
region
Required : Yes
Type : string
Location : path
Description : Name of the region scoping this request.
Parameter Order :
Apiversion : 2026-12-01-preview
▼ ▲ compute.regionInstanceGroups.setNamedPorts
HTTP Method : POST
Flat Path : projects/{project}/regions/{region}/instanceGroups/{instanceGroup}/setNamedPorts
Path : projects/{project}/regions/{region}/instanceGroups/{instanceGroup}/setNamedPorts
Description : Sets the named ports for the specified regional instance group.
Parameters :
project
Description : Project ID for this request.
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])?))
Location : path
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).
region
Required : Yes
Description : Name of the region scoping this request.
Type : string
Location : path
instanceGroup
Type : string
Required : Yes
Description : The name of the regional instance group where the named ports are updated.
Location : path
Parameter Order :
Scopes :
Apiversion : 2026-12-01-preview
▼ ▲ compute.regions.list
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
Minimum : 0
Location : query
Format : uint32
Type : integer
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
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
Required : Yes
Description : Project ID for this request.
orderBy
Type : string
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.
filter
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.
Type : string
Apiversion : 2026-12-01-preview
Path : projects/{project}/regions
Scopes :
Parameter Order : project
Flat Path : projects/{project}/regions
HTTP Method : GET
Description : Retrieves the list of region resources available to the specified project. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `items.quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request. This method fails if the quota information is unavailable for the region and if the organization policy constraint compute.requireBasicQuotaInResponse is enforced. This constraint, when enforced, disables the fail-open behaviour when quota information (the `items.quotas` field) is unavailable for the region. It is recommended to use the default setting for the constraint unless your application requires the fail-closed behaviour for this method.
▼ ▲ compute.regions.get
HTTP Method : GET
Parameter Order :
Apiversion : 2026-12-01-preview
Parameters :
project
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])?))
Description : Project ID for this request.
Location : path
Required : Yes
region
Required : Yes
Description : Name of the region resource to return.
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Flat Path : projects/{project}/regions/{region}
Description : Returns the specified Region resource. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request. This method fails if the quota information is unavailable for the region and if the organization policy constraint compute.requireBasicQuotaInResponse is enforced. This constraint, when enforced, disables the fail-open behaviour when quota information (the `items.quotas` field) is unavailable for the region. It is recommended to use the default setting for the constraint unless your application requires the fail-closed behaviour for this method.
Path : projects/{project}/regions/{region}
Scopes :
▼ ▲ compute.imageFamilyViews.get
HTTP Method : GET
Flat Path : projects/{project}/zones/{zone}/imageFamilyViews/{family}
Description : Returns the latest image that is part of an image family, is not deprecated and is rolled out in the specified zone.
Scopes :
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
Type : string
Description : Project ID for this request.
Required : Yes
zone
Required : Yes
Description : The name of the zone for this request.
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
family
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the image family to search for.
Type : string
Location : path
Required : Yes
Path : projects/{project}/zones/{zone}/imageFamilyViews/{family}
Parameter Order :
Apiversion : 2026-12-01-preview
▼ ▲ compute.httpsHealthChecks.update
Apiversion : 2026-12-01-preview
Scopes :
Description : Updates a HttpsHealthCheck resource in the specified project using the data included in the request.
Parameters :
requestId
Location : query
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
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
httpsHealthCheck
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Description : Name of the HttpsHealthCheck resource to update.
Location : path
Flat Path : projects/{project}/global/httpsHealthChecks/{httpsHealthCheck}
Path : projects/{project}/global/httpsHealthChecks/{httpsHealthCheck}
HTTP Method : PUT
Parameter Order :
▼ ▲ compute.httpsHealthChecks.testIamPermissions
Parameter Order :
Flat Path : projects/{project}/global/httpsHealthChecks/{resource}/testIamPermissions
Scopes :
HTTP Method : POST
Parameters :
resource
Required : Yes
Description : Name or id of the resource for this request.
Type : string
Pattern : [a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
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
Type : string
Description : Project ID for this request.
Required : Yes
Description : Returns permissions that a caller has on the specified resource.
Apiversion : 2026-12-01-preview
Path : projects/{project}/global/httpsHealthChecks/{resource}/testIamPermissions
▼ ▲ compute.httpsHealthChecks.delete
HTTP Method : DELETE
Flat Path : projects/{project}/global/httpsHealthChecks/{httpsHealthCheck}
Path : projects/{project}/global/httpsHealthChecks/{httpsHealthCheck}
Scopes :
Parameter Order :
Apiversion : 2026-12-01-preview
Description : Deletes the specified HttpsHealthCheck resource.
Parameters :
project
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])?))
Required : Yes
Location : path
Description : Project ID for this request.
httpsHealthCheck
Description : Name of the HttpsHealthCheck resource to delete.
Location : path
Type : string
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
requestId
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).
Location : query
▼ ▲ compute.httpsHealthChecks.patch
Parameter Order :
Flat Path : projects/{project}/global/httpsHealthChecks/{httpsHealthCheck}
Path : projects/{project}/global/httpsHealthChecks/{httpsHealthCheck}
Apiversion : 2026-12-01-preview
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])?))
Type : string
Description : Project ID for this request.
Location : path
requestId
Location : query
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
httpsHealthCheck
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Type : string
Description : Name of the HttpsHealthCheck resource to patch.
Required : Yes
HTTP Method : PATCH
Description : Updates a HttpsHealthCheck resource in the specified project using the data included in the request. This method supportsPATCH semantics and uses theJSON merge patch format and processing rules.
Scopes :
▼ ▲ compute.httpsHealthChecks.get
HTTP Method : GET
Parameter Order :
Parameters :
httpsHealthCheck
Required : Yes
Description : Name of the HttpsHealthCheck resource to return.
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
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])?))
Type : string
Location : path
Description : Project ID for this request.
Apiversion : 2026-12-01-preview
Scopes :
Description : Returns the specified HttpsHealthCheck resource.
Flat Path : projects/{project}/global/httpsHealthChecks/{httpsHealthCheck}
Path : projects/{project}/global/httpsHealthChecks/{httpsHealthCheck}
▼ ▲ compute.httpsHealthChecks.list
HTTP Method : GET
Parameter Order : project
Path : projects/{project}/global/httpsHealthChecks
Flat Path : projects/{project}/global/httpsHealthChecks
Description : Retrieves the list of HttpsHealthCheck resources available to the specified project.
Scopes :
Apiversion : 2026-12-01-preview
Parameters :
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
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
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.
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.
maxResults
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`)
Minimum : 0
Default : 500
Location : query
▼ ▲ compute.httpsHealthChecks.insert
Scopes :
HTTP Method : POST
Flat Path : projects/{project}/global/httpsHealthChecks
Path : projects/{project}/global/httpsHealthChecks
Parameters :
project
Location : path
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])?))
Type : string
Required : Yes
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
Description : Creates a HttpsHealthCheck resource in the specified project using the data included in the request.
Parameter Order : project
Apiversion : 2026-12-01-preview
▼ ▲ compute.regionSslCertificates.delete
Apiversion : 2026-12-01-preview
Scopes :
Parameters :
sslCertificate
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Required : Yes
Description : Name of the SslCertificate resource to delete.
project
Required : Yes
Description : Project ID for this request.
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])?))
Location : path
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Name of the region scoping this request.
Required : Yes
Location : path
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).
Parameter Order :
Flat Path : projects/{project}/regions/{region}/sslCertificates/{sslCertificate}
Path : projects/{project}/regions/{region}/sslCertificates/{sslCertificate}
Description : Deletes the specified SslCertificate resource in the region.
HTTP Method : DELETE
▼ ▲ compute.regionSslCertificates.insert
Scopes :
HTTP Method : POST
Description : Creates a SslCertificate resource in the specified project and region using the data included in the request
Flat Path : projects/{project}/regions/{region}/sslCertificates
Path : projects/{project}/regions/{region}/sslCertificates
Parameter Order :
Parameters :
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Location : path
Type : string
Description : Name of the region scoping this request.
requestId
Type : string
Location : query
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).
project
Location : path
Description : Project ID for this request.
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])?))
Required : Yes
Apiversion : 2026-12-01-preview
▼ ▲ compute.regionSslCertificates.get
Apiversion : 2026-12-01-preview
Path : projects/{project}/regions/{region}/sslCertificates/{sslCertificate}
Parameters :
sslCertificate
Description : Name of the SslCertificate resource to return.
Required : Yes
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
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])?))
Location : path
Description : Project ID for this request.
region
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Required : Yes
Description : Name of the region scoping this request.
Parameter Order :
Scopes :
Flat Path : projects/{project}/regions/{region}/sslCertificates/{sslCertificate}
Description : Returns the specified SslCertificate resource in the specified region. Get a list of available SSL certificates by making a list() request.
HTTP Method : GET
▼ ▲ compute.regionSslCertificates.list
Apiversion : 2026-12-01-preview
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])?))
Location : path
Type : string
Description : Project ID for this request.
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
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
region
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Name of the region scoping this request.
Type : string
Required : Yes
maxResults
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`)
Location : query
Minimum : 0
Type : integer
Format : uint32
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.
Description : Retrieves the list of SslCertificate resources available to the specified project in the specified region.
Flat Path : projects/{project}/regions/{region}/sslCertificates
Parameter Order :
Path : projects/{project}/regions/{region}/sslCertificates
HTTP Method : GET
Scopes :
▼ ▲ compute.packetMirrorings.get
Apiversion : 2026-12-01-preview
Parameters :
packetMirroring
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Description : Name of the PacketMirroring resource to return.
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Required : Yes
Location : path
Description : Name of the region for this request.
project
Description : Project ID for this request.
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])?))
Location : path
Description : Returns the specified PacketMirroring resource.
Scopes :
Flat Path : projects/{project}/regions/{region}/packetMirrorings/{packetMirroring}
Path : projects/{project}/regions/{region}/packetMirrorings/{packetMirroring}
Parameter Order :
HTTP Method : GET
▼ ▲ compute.packetMirrorings.list
Flat Path : projects/{project}/regions/{region}/packetMirrorings
HTTP Method : GET
Parameter Order :
Apiversion : 2026-12-01-preview
Description : Retrieves a list of PacketMirroring resources available to the specified project and region.
Parameters :
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
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
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.
Location : query
Type : string
maxResults
Type : integer
Location : query
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
Minimum : 0
Format : uint32
project
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])?))
Required : Yes
Description : Project ID for this request.
Location : path
region
Description : Name of the region for this request.
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Scopes :
Path : projects/{project}/regions/{region}/packetMirrorings
▼ ▲ compute.packetMirrorings.insert
Scopes :
Path : projects/{project}/regions/{region}/packetMirrorings
Description : Creates a PacketMirroring resource in the specified project and region using the data included in the request.
Parameters :
region
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Description : Name of the region for this request.
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
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.
Type : string
Required : Yes
Apiversion : 2026-12-01-preview
Parameter Order :
HTTP Method : POST
Flat Path : projects/{project}/regions/{region}/packetMirrorings
▼ ▲ compute.packetMirrorings.patch
Apiversion : 2026-12-01-preview
Parameters :
requestId
Location : query
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
region
Required : Yes
Description : Name of the region for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Location : path
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.
Type : string
Location : path
packetMirroring
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the PacketMirroring resource to patch.
Required : Yes
Type : string
Location : path
Description : Patches the specified PacketMirroring resource with the data included in the request. This method supportsPATCH semantics and usesJSON merge patch format and processing rules.
Path : projects/{project}/regions/{region}/packetMirrorings/{packetMirroring}
Parameter Order :
Flat Path : projects/{project}/regions/{region}/packetMirrorings/{packetMirroring}
Scopes :
HTTP Method : PATCH
▼ ▲ compute.packetMirrorings.testIamPermissions
Parameters :
region
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Description : The name of the region for this request.
Type : string
resource
Location : path
Description : Name or id of the resource for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Required : Yes
project
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])?))
Location : path
Description : Returns permissions that a caller has on the specified resource.
Apiversion : 2026-12-01-preview
Scopes :
Path : projects/{project}/regions/{region}/packetMirrorings/{resource}/testIamPermissions
Flat Path : projects/{project}/regions/{region}/packetMirrorings/{resource}/testIamPermissions
Parameter Order :
HTTP Method : POST
▼ ▲ compute.packetMirrorings.aggregatedList
HTTP Method : GET
Flat Path : projects/{project}/aggregated/packetMirrorings
Scopes :
Parameters :
includeAllScopes
Type : boolean
Description : Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
Location : query
maxResults
Location : query
Format : uint32
Type : integer
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`)
Minimum : 0
orderBy
Type : string
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.
serviceProjectNumber
Description : The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.
Format : int64
Location : query
Type : string
filter
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.
Location : query
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])?))
Location : path
Description : Project ID for this request.
Description : Retrieves an aggregated list of packetMirrorings. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.
Apiversion : 2026-12-01-preview
Path : projects/{project}/aggregated/packetMirrorings
Parameter Order : project
▼ ▲ compute.packetMirrorings.delete
Apiversion : 2026-12-01-preview
Parameters :
requestId
Location : query
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
project
Required : Yes
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])?))
Type : string
region
Location : path
Description : Name of the region for this request.
Required : Yes
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
packetMirroring
Required : Yes
Type : string
Description : Name of the PacketMirroring resource to delete.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Scopes :
Description : Deletes the specified PacketMirroring resource.
Flat Path : projects/{project}/regions/{region}/packetMirrorings/{packetMirroring}
Parameter Order :
Path : projects/{project}/regions/{region}/packetMirrorings/{packetMirroring}
HTTP Method : DELETE
▼ ▲ compute.publicAdvertisedPrefixes.patch
Scopes :
Path : projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}
HTTP Method : PATCH
Parameter Order :
Apiversion : 2026-12-01-preview
Parameters :
project
Location : path
Type : string
Required : Yes
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])?))
requestId
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).
Location : query
publicAdvertisedPrefix
Required : Yes
Description : Name of the PublicAdvertisedPrefix resource to patch.
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Flat Path : projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}
Description : Patches the specified Router resource with the data included in the request. This method supportsPATCH semantics and usesJSON merge patch format and processing rules.
▼ ▲ compute.publicAdvertisedPrefixes.list
HTTP Method : GET
Path : projects/{project}/global/publicAdvertisedPrefixes
Parameter Order : project
Description : Lists the PublicAdvertisedPrefixes for a project.
Scopes :
Flat Path : projects/{project}/global/publicAdvertisedPrefixes
Apiversion : 2026-12-01-preview
Parameters :
maxResults
Default : 500
Minimum : 0
Type : integer
Location : query
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`)
Format : uint32
project
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])?))
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.
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.
orderBy
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.
Location : query
▼ ▲ compute.publicAdvertisedPrefixes.announce
Scopes :
Parameters :
publicAdvertisedPrefix
Description : The name of the public advertised prefix. It should comply with RFC1035.
Required : Yes
Type : string
Location : path
requestId
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).
Location : query
project
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])?))
Required : Yes
Location : path
Type : string
Apiversion : 2026-12-01-preview
Path : projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}/announce
Flat Path : projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}/announce
Description : Announces the specified PublicAdvertisedPrefix
HTTP Method : POST
Parameter Order :
▼ ▲ compute.publicAdvertisedPrefixes.delete
Path : projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}
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
requestId
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).
Location : query
publicAdvertisedPrefix
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Type : string
Description : Name of the PublicAdvertisedPrefix resource to delete.
Required : Yes
Scopes :
Description : Deletes the specified PublicAdvertisedPrefix
HTTP Method : DELETE
Parameter Order :
▼ ▲ compute.publicAdvertisedPrefixes.get
Parameter Order :
Scopes :
HTTP Method : GET
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
Type : string
Required : Yes
Description : Project ID for this request.
publicAdvertisedPrefix
Description : Name of the PublicAdvertisedPrefix resource to return.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Type : string
Description : Returns the specified PublicAdvertisedPrefix resource.
Path : projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}
▼ ▲ compute.publicAdvertisedPrefixes.withdraw
Path : projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}/withdraw
Apiversion : 2026-12-01-preview
Parameters :
requestId
Type : string
Location : query
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).
project
Description : Project ID for this request.
Type : string
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])?))
publicAdvertisedPrefix
Required : Yes
Type : string
Location : path
Description : The name of the public advertised prefix. It should comply with RFC1035.
Flat Path : projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}/withdraw
Description : Withdraws the specified PublicAdvertisedPrefix
Scopes :
HTTP Method : POST
Parameter Order :
▼ ▲ compute.publicAdvertisedPrefixes.insert
Description : Creates a PublicAdvertisedPrefix in the specified project using the parameters that are included in the request.
HTTP Method : POST
Path : projects/{project}/global/publicAdvertisedPrefixes
Parameter Order : project
Scopes :
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).
Location : query
Type : string
project
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])?))
Location : path
Flat Path : projects/{project}/global/publicAdvertisedPrefixes
Apiversion : 2026-12-01-preview
▼ ▲ compute.instanceGroupManagers.stopInstances
HTTP Method : POST
Parameter Order :
Scopes :
Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/stopInstances
Apiversion : 2026-12-01-preview
Description : Flags the specified instances in the managed instance group to be immediately stopped. You can only specify instances that are running in this request. This method reduces thetargetSize and increases the targetStoppedSize of the managed instance group by the number of instances that you stop. The stopInstances operation is marked DONE if the stopInstances request is successful. The underlying actions take additional time. You must separately verify the status of theSTOPPING action with thelistmanagedinstances method. If the standbyPolicy.initialDelaySec field is set, the group delays stopping the instances until initialDelaySec have passed from instance.creationTimestamp (that is, when the instance was created). This delay gives your application time to set itself up and initialize on the instance. If more thaninitialDelaySec seconds have passed sinceinstance.creationTimestamp when this method is called, there will be zero delay. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is stopped. Stopped instances can be started using the startInstances method. You can specify a maximum of 1000 instances with this method per request.
Flat Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/stopInstances
Parameters :
zone
Location : path
Description : The name of thezone where the managed instance group is located.
Required : Yes
Type : string
project
Location : path
Description : Project ID for this request.
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])?))
Required : Yes
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).
instanceGroupManager
Required : Yes
Description : The name of the managed instance group.
Type : string
Location : path
noGracefulShutdown
Type : boolean
Default : false
Location : query
Description : When set, graceful shutdown is skipped for instance stopping even if it's configured for the instances.
▼ ▲ compute.instanceGroupManagers.setInstanceTemplate
HTTP Method : POST
Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/setInstanceTemplate
Description : Specifies the instance template to use when creating new instances in this group. The templates for existing instances in the group do not change unless you run recreateInstances, runapplyUpdatesToInstances, or set the group'supdatePolicy.type to PROACTIVE.
Parameter Order :
Apiversion : 2026-12-01-preview
Scopes :
Parameters :
instanceGroupManager
Required : Yes
Description : The name of the managed instance group.
Location : path
Type : string
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
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
zone
Required : Yes
Type : string
Location : path
Description : The name of thezone where the managed instance group is located.
Flat Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/setInstanceTemplate
▼ ▲ compute.instanceGroupManagers.updatePerInstanceConfigs
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/updatePerInstanceConfigs
Scopes :
Parameters :
zone
Type : string
Required : Yes
Location : path
Description : The name of thezone where the managed instance group is located. It 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])?))
Location : path
Type : string
Required : Yes
Description : Project ID for this request.
instanceGroupManager
Required : Yes
Type : string
Location : path
Description : The name of the managed instance group. It should conform to RFC1035.
requestId
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).
Location : query
Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/updatePerInstanceConfigs
Parameter Order :
Description : Inserts or updates per-instance configurations for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch.
HTTP Method : POST
▼ ▲ compute.instanceGroupManagers.patchPerInstanceConfigs
Parameters :
instanceGroupManager
Location : path
Type : string
Description : The name of the managed instance group. It should conform to RFC1035.
Required : Yes
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
zone
Location : path
Type : string
Required : Yes
Description : The name of thezone where the managed instance group is located. It 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).
Type : string
Location : query
Apiversion : 2026-12-01-preview
Parameter Order :
Flat Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/patchPerInstanceConfigs
Description : Inserts or patches per-instance configurations for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch.
Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/patchPerInstanceConfigs
Scopes :
HTTP Method : POST
▼ ▲ compute.instanceGroupManagers.patch
Description : Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is patched even if the instances in the group are still in the process of being patched. You must separately verify the status of the individual instances with thelistManagedInstances method. This method supportsPATCH semantics and uses theJSON merge patch format and processing rules. If you update your group to specify a new template or instance configuration, it's possible that your intended specification for each VM in the group is different from the current state of that VM. To learn how to apply an updated configuration to the VMs in a MIG, seeUpdating instances in a MIG.
Flat Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}
Scopes :
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
instanceGroupManager
Required : Yes
Description : The name of the instance group manager.
Type : string
Location : path
zone
Location : path
Description : The name of the zone where you want to create the managed instance group.
Type : string
Required : Yes
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])?))
Type : string
Location : path
Description : Project ID for this request.
Apiversion : 2026-12-01-preview
HTTP Method : PATCH
Parameter Order :
Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}
▼ ▲ compute.instanceGroupManagers.listManagedInstances
Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listManagedInstances
Parameter Order :
Parameters :
maxResults
Default : 500
Minimum : 0
Location : query
Format : uint32
Type : integer
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
instanceGroupManager
Location : path
Type : string
Description : The name of the managed instance group.
Required : Yes
project
Location : path
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])?))
Required : Yes
Type : string
filter
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.
Location : query
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
zone
Required : Yes
Type : string
Description : The name of thezone where the managed instance group is located.
Location : path
Apiversion : 2026-12-01-preview
Scopes :
Flat Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listManagedInstances
Description : Lists all of the instances in the managed instance group. Each instance in the list has a currentAction, which indicates the action that the managed instance group is performing on the instance. For example, if the group is still creating an instance, the currentAction is CREATING. If a previous action failed, the list displays the errors for that failed action. The orderBy query parameter is not supported. The `pageToken` query parameter is supported only if the group's `listManagedInstancesResults` field is set to `PAGINATED`.
HTTP Method : POST
▼ ▲ compute.instanceGroupManagers.suspendInstances
Parameters :
project
Type : string
Required : Yes
Location : path
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])?))
instanceGroupManager
Required : Yes
Description : The name of the managed instance group.
Location : path
Type : string
zone
Type : string
Required : Yes
Description : The name of thezone where the managed instance group is located.
Location : path
requestId
Type : string
Location : query
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).
Scopes :
Apiversion : 2026-12-01-preview
Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/suspendInstances
Flat Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/suspendInstances
Description : Flags the specified instances in the managed instance group to be immediately suspended. You can only specify instances that are running in this request. This method reduces thetargetSize and increases the targetSuspendedSize of the managed instance group by the number of instances that you suspend. The suspendInstances operation is marked DONE if the suspendInstances request is successful. The underlying actions take additional time. You must separately verify the status of theSUSPENDING action with thelistmanagedinstances method. If the standbyPolicy.initialDelaySec field is set, the group delays suspension of the instances until initialDelaySec have passed from instance.creationTimestamp (that is, when the instance was created). This delay gives your application time to set itself up and initialize on the instance. If more thaninitialDelaySec seconds have passed sinceinstance.creationTimestamp when this method is called, there will be zero delay. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is suspended. Suspended instances can be resumed using the resumeInstances method. You can specify a maximum of 1000 instances with this method per request.
Parameter Order :
HTTP Method : POST
▼ ▲ compute.instanceGroupManagers.recreateInstances
Scopes :
Flat Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/recreateInstances
Parameter Order :
Description : Flags the specified VM instances in the managed instance group to be immediately recreated. Each instance is recreated using the group's current configuration. This operation is marked as DONE when the flag is set even if the instances have not yet been recreated. You must separately verify the status of each instance by checking itscurrentAction field; for more information, see Checking the status of managed instances. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request.
HTTP Method : POST
Parameters :
instanceGroupManager
Description : The name of the managed instance group.
Required : Yes
Type : string
Location : path
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
Type : string
Required : Yes
Location : path
Description : The name of thezone where the managed instance group is located.
project
Required : Yes
Location : path
Description : Project ID for this request.
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])?))
noGracefulShutdown
Location : query
Description : When set, graceful shutdown is skipped for instance recreation even if it's configured for the instances.
Type : boolean
Default : false
Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/recreateInstances
Apiversion : 2026-12-01-preview
▼ ▲ compute.instanceGroupManagers.resumeInstances
Scopes :
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
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.
Type : string
Required : Yes
Location : path
zone
Description : The name of thezone where the managed instance group is located.
Required : Yes
Type : string
Location : path
instanceGroupManager
Type : string
Description : The name of the managed instance group.
Location : path
Required : Yes
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resumeInstances
Description : Flags the specified instances in the managed instance group to be resumed. This method increases thetargetSize and decreases the targetSuspendedSize of the managed instance group by the number of instances that you resume. The resumeInstances operation is marked DONE if the resumeInstances request is successful. The underlying actions take additional time. You must separately verify the status of theRESUMING action with thelistmanagedinstances method. In this request, you can only specify instances that are suspended. For example, if an instance was previously suspended using the suspendInstances method, it can be resumed using the resumeInstances method. If a health check is attached to the managed instance group, the specified instances will be verified as healthy after they are resumed. You can specify a maximum of 1000 instances with this method per request.
Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resumeInstances
Parameter Order :
HTTP Method : POST
▼ ▲ compute.instanceGroupManagers.startInstances
Parameters :
instanceGroupManager
Description : The name of the managed instance group.
Required : Yes
Type : string
Location : path
project
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])?))
Location : path
Description : Project ID for this request.
Required : Yes
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
zone
Description : The name of thezone where the managed instance group is located.
Location : path
Required : Yes
Type : string
Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/startInstances
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/startInstances
Parameter Order :
Description : Flags the specified instances in the managed instance group to be started. This method increases thetargetSize and decreases the targetStoppedSize of the managed instance group by the number of instances that you start. The startInstances operation is marked DONE if the startInstances request is successful. The underlying actions take additional time. You must separately verify the status of theSTARTING action with thelistmanagedinstances method. In this request, you can only specify instances that are stopped. For example, if an instance was previously stopped using the stopInstances method, it can be started using the startInstances method. If a health check is attached to the managed instance group, the specified instances will be verified as healthy after they are started. You can specify a maximum of 1000 instances with this method per request.
Scopes :
HTTP Method : POST
▼ ▲ compute.instanceGroupManagers.listErrors
Description : Lists all errors thrown by actions on instances for a given managed instance group. The filter and orderBy query parameters are not supported.
Parameter Order :
Flat Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listErrors
Parameters :
instanceGroupManager
Location : path
Description : The name of the managed instance group. It must be a string that meets the requirements in RFC1035, or an unsigned long integer: must match regexp pattern: (?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?)|1-9{0,19}.
Required : Yes
Type : string
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
zone
Location : path
Description : The name of thezone where the managed instance group is located. It should conform to RFC1035.
Type : string
Required : Yes
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.
Type : string
Location : query
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.
maxResults
Location : query
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
Type : integer
Format : uint32
Minimum : 0
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
Apiversion : 2026-12-01-preview
HTTP Method : GET
Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listErrors
Scopes :
▼ ▲ compute.instanceGroupManagers.deletePerInstanceConfigs
Flat Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/deletePerInstanceConfigs
Scopes :
Parameter Order :
Apiversion : 2026-12-01-preview
Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/deletePerInstanceConfigs
Parameters :
instanceGroupManager
Location : path
Description : The name of the managed instance group. It should conform to RFC1035.
Type : string
Required : Yes
zone
Location : path
Type : string
Description : The name of thezone where the managed instance group is located. It should conform to RFC1035.
Required : Yes
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
HTTP Method : POST
Description : Deletes selected per-instance configurations for the managed instance group.
▼ ▲ compute.instanceGroupManagers.list
Flat Path : projects/{project}/zones/{zone}/instanceGroupManagers
Parameter Order :
Path : projects/{project}/zones/{zone}/instanceGroupManagers
Scopes :
HTTP Method : GET
Description : Retrieves a list of managed instance groups that are contained within the specified project and zone.
Apiversion : 2026-12-01-preview
Parameters :
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.
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])?))
Description : Project ID for this request.
Type : string
Required : Yes
maxResults
Minimum : 0
Format : uint32
Default : 500
Location : query
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
orderBy
Type : string
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.
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.
Location : query
Type : string
zone
Location : path
Description : The name of thezone where the managed instance group is located.
Required : Yes
Type : string
▼ ▲ compute.instanceGroupManagers.createInstances
Description : Creates instances with per-instance configurations in this managed instance group. Instances are created using the current instance template. Thecreate instances operation is marked DONE if thecreateInstances request is successful. The underlying actions take additional time. You must separately verify the status of thecreating or actions with the listmanagedinstances method.
HTTP Method : POST
Parameter Order :
Parameters :
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. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
project
Required : Yes
Location : path
Description : Project ID for this request.
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])?))
zone
Location : path
Type : string
Required : Yes
Description : The name of thezone where the managed instance group is located. It should conform to RFC1035.
instanceGroupManager
Type : string
Location : path
Required : Yes
Description : The name of the managed instance group. It should conform to RFC1035.
Scopes :
Flat Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/createInstances
Apiversion : 2026-12-01-preview
Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/createInstances
▼ ▲ compute.instanceGroupManagers.delete
Flat Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}
Scopes :
HTTP Method : DELETE
Parameter Order :
Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}
Description : Deletes the specified managed instance group and all of the instances in that group. Note that the instance group must not belong to a backend service. Read Deleting an instance group for more information.
Parameters :
noGracefulShutdown
Type : boolean
Description : When set, graceful shutdown is skipped for instance deletion even if it's configured for the instances.
Default : false
Location : query
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.
Required : Yes
Type : string
Location : path
requestId
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).
Location : query
zone
Required : Yes
Description : The name of thezone where the managed instance group is located.
Type : string
Location : path
instanceGroupManager
Type : string
Location : path
Description : The name of the managed instance group to delete.
Required : Yes
Apiversion : 2026-12-01-preview
▼ ▲ compute.instanceGroupManagers.deleteInstances
Flat Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/deleteInstances
HTTP Method : POST
Parameters :
requestId
Location : query
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
noGracefulShutdown
Description : When set, graceful shutdown is skipped for instance deletion even if it's configured for the instances.
Default : false
Type : boolean
Location : query
instanceGroupManager
Location : path
Type : string
Description : The name of the managed instance group.
Required : Yes
zone
Required : Yes
Description : The name of thezone where the managed instance group is located.
Type : string
Location : path
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])?))
Type : string
Location : path
Description : Project ID for this request.
Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/deleteInstances
Apiversion : 2026-12-01-preview
Parameter Order :
Description : Flags the specified instances in the managed instance group for immediate deletion. The instances are also removed from any target pools of which they were a member. This method reduces thetargetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with thelistmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request.
Scopes :
▼ ▲ compute.instanceGroupManagers.abandonInstances
Description : Flags the specified instances to be removed from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces thetargetSize of the managed instance group by the number of instances that you abandon. This operation is marked asDONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with thelistmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request.
Parameters :
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).
project
Type : string
Location : path
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.
zone
Type : string
Location : path
Description : The name of thezone where the managed instance group is located.
Required : Yes
instanceGroupManager
Location : path
Description : The name of the managed instance group.
Type : string
Required : Yes
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/abandonInstances
Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/abandonInstances
Scopes :
Parameter Order :
HTTP Method : POST
▼ ▲ compute.instanceGroupManagers.insert
Scopes :
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/zones/{zone}/instanceGroupManagers
Description : Creates a managed instance group using the information that you specify in the request. After the group is created, instances in the group are created using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with thelistmanagedinstances method. A managed instance group can have up to 1000 VM instances per group. Please contact Cloud Support if you need an increase in this limit.
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.
Type : string
Required : Yes
zone
Required : Yes
Type : string
Description : The name of the zone where you want to create the managed instance group.
Location : path
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).
Path : projects/{project}/zones/{zone}/instanceGroupManagers
HTTP Method : POST
Parameter Order :
▼ ▲ compute.instanceGroupManagers.aggregatedList
Path : projects/{project}/aggregated/instanceGroupManagers
Parameters :
includeAllScopes
Type : boolean
Location : query
Description : Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
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
serviceProjectNumber
Location : query
Format : int64
Type : string
Description : The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.
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.
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.
Type : string
Location : query
maxResults
Minimum : 0
Format : uint32
Default : 500
Type : integer
Location : query
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`)
project
Required : Yes
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])?))
Type : string
Location : path
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/aggregated/instanceGroupManagers
Parameter Order : project
Description : Retrieves the list of managed instance groups and groups them by zone. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.
Scopes :
HTTP Method : GET
▼ ▲ compute.instanceGroupManagers.applyUpdatesToInstances
HTTP Method : POST
Description : Applies changes to selected instances on the managed instance group. This method can be used to apply new overrides and/or new versions.
Scopes :
Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/applyUpdatesToInstances
Flat Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/applyUpdatesToInstances
Parameter Order :
Parameters :
zone
Required : Yes
Description : The name of thezone where the managed instance group is located. Should conform to RFC1035.
Type : string
Location : path
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])?))
instanceGroupManager
Description : The name of the managed instance group, should conform to RFC1035.
Location : path
Type : string
Required : Yes
Apiversion : 2026-12-01-preview
▼ ▲ compute.instanceGroupManagers.get
Parameters :
zone
Type : string
Required : Yes
Location : path
Description : The name of thezone where the managed instance group is located.
project
Location : path
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.
Type : string
instanceGroupManager
Type : string
Location : path
Description : The name of the managed instance group.
Required : Yes
Parameter Order :
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}
Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}
Scopes :
Description : Returns all of the details about the specified managed instance group.
HTTP Method : GET
▼ ▲ compute.instanceGroupManagers.listPerInstanceConfigs
Scopes :
Apiversion : 2026-12-01-preview
Parameters :
instanceGroupManager
Type : string
Required : Yes
Description : The name of the managed instance group. It should conform to RFC1035.
Location : path
maxResults
Format : uint32
Minimum : 0
Default : 500
Type : integer
Location : query
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`)
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
zone
Description : The name of thezone where the managed instance group is located. It should conform to RFC1035.
Required : Yes
Type : string
Location : path
filter
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.
Location : query
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.
orderBy
Type : string
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.
HTTP Method : POST
Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listPerInstanceConfigs
Description : Lists all of the per-instance configurations defined for the managed instance group. The orderBy query parameter is not supported.
Parameter Order :
Flat Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listPerInstanceConfigs
▼ ▲ compute.instanceGroupManagers.setTargetPools
Description : Modifies the target pools to which all instances in this managed instance group are assigned. The target pools automatically apply to all of the instances in the managed instance group. This operation is markedDONE when you make the request even if the instances have not yet been added to their target pools. The change might take some time to apply to all of the instances in the group depending on the size of the group.
HTTP Method : POST
Parameter Order :
Flat Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/setTargetPools
Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/setTargetPools
Scopes :
Apiversion : 2026-12-01-preview
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).
Location : query
Type : string
zone
Description : The name of thezone where the managed instance group is located.
Required : Yes
Type : string
Location : path
project
Location : path
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])?))
Type : string
Required : Yes
instanceGroupManager
Description : The name of the managed instance group.
Required : Yes
Type : string
Location : path
▼ ▲ compute.instanceGroupManagers.resize
Scopes :
HTTP Method : POST
Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resize
Apiversion : 2026-12-01-preview
Parameter Order :
Parameters :
zone
Location : path
Description : The name of thezone where the managed instance group is located.
Type : string
Required : Yes
instanceGroupManager
Location : path
Required : Yes
Description : The name of the managed instance group.
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
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
Required : Yes
Description : Project ID for this request.
size
Description : The number of running instances that the managed instance group should maintain at any given time. The group automatically adds or removes instances to maintain the number of instances specified by this parameter.
Location : query
Required : Yes
Format : int32
Type : integer
Description : Resizes the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is markedDONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with thelistmanagedinstances method. When resizing down, the instance group arbitrarily chooses the order in which VMs are deleted. The group takes into account some VM attributes when making the selection including: + The status of the VM instance. + The health of the VM instance. + The instance template version the VM is based on. + For regional managed instance groups, the location of the VM instance. This list is subject to change. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.
Flat Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resize
▼ ▲ compute.httpHealthChecks.list
Flat Path : projects/{project}/global/httpHealthChecks
Path : projects/{project}/global/httpHealthChecks
Parameters :
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
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])?))
Location : path
maxResults
Type : integer
Location : query
Minimum : 0
Default : 500
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`)
filter
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.
Location : query
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.
Type : string
Location : query
Apiversion : 2026-12-01-preview
Parameter Order : project
HTTP Method : GET
Description : Retrieves the list of HttpHealthCheck resources available to the specified project.
Scopes :
▼ ▲ compute.httpHealthChecks.patch
Parameter Order :
Scopes :
HTTP Method : PATCH
Parameters :
project
Description : Project ID for this request.
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])?))
Location : path
requestId
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).
Location : query
httpHealthCheck
Location : path
Required : Yes
Description : Name of the HttpHealthCheck resource to patch.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Description : Updates a HttpHealthCheck resource in the specified project using the data included in the request. This method supportsPATCH semantics and uses theJSON merge patch format and processing rules.
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/global/httpHealthChecks/{httpHealthCheck}
Path : projects/{project}/global/httpHealthChecks/{httpHealthCheck}
▼ ▲ compute.httpHealthChecks.delete
HTTP Method : DELETE
Description : Deletes the specified HttpHealthCheck resource.
Parameter Order :
Path : projects/{project}/global/httpHealthChecks/{httpHealthCheck}
Apiversion : 2026-12-01-preview
Scopes :
Parameters :
httpHealthCheck
Description : Name of the HttpHealthCheck resource to delete.
Required : Yes
Location : path
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
requestId
Type : string
Location : query
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).
project
Required : Yes
Type : string
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])?))
Flat Path : projects/{project}/global/httpHealthChecks/{httpHealthCheck}
▼ ▲ compute.httpHealthChecks.update
Parameter Order :
Scopes :
HTTP Method : PUT
Path : projects/{project}/global/httpHealthChecks/{httpHealthCheck}
Parameters :
httpHealthCheck
Location : path
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Description : Name of the HttpHealthCheck resource to update.
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])?))
Required : Yes
Type : string
Description : Project ID for this request.
requestId
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).
Location : query
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/global/httpHealthChecks/{httpHealthCheck}
Description : Updates a HttpHealthCheck resource in the specified project using the data included in the request.
▼ ▲ compute.httpHealthChecks.testIamPermissions
Parameters :
project
Location : path
Description : Project ID for this request.
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])?))
resource
Description : Name or id of the resource for this request.
Required : Yes
Pattern : [a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Location : path
Apiversion : 2026-12-01-preview
Parameter Order :
Scopes :
Flat Path : projects/{project}/global/httpHealthChecks/{resource}/testIamPermissions
Path : projects/{project}/global/httpHealthChecks/{resource}/testIamPermissions
Description : Returns permissions that a caller has on the specified resource.
HTTP Method : POST
▼ ▲ compute.httpHealthChecks.insert
HTTP Method : POST
Scopes :
Flat Path : projects/{project}/global/httpHealthChecks
Description : Creates a HttpHealthCheck resource in the specified project using the data included in the request.
Path : projects/{project}/global/httpHealthChecks
Apiversion : 2026-12-01-preview
Parameter Order : project
Parameters :
project
Description : Project ID for this request.
Location : path
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])?))
Required : Yes
requestId
Type : string
Location : query
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).
▼ ▲ compute.httpHealthChecks.get
Parameters :
httpHealthCheck
Required : Yes
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the HttpHealthCheck resource to return.
project
Location : path
Type : string
Required : Yes
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])?))
Apiversion : 2026-12-01-preview
Path : projects/{project}/global/httpHealthChecks/{httpHealthCheck}
Description : Returns the specified HttpHealthCheck resource.
HTTP Method : GET
Flat Path : projects/{project}/global/httpHealthChecks/{httpHealthCheck}
Parameter Order :
Scopes :
▼ ▲ compute.globalForwardingRules.delete
HTTP Method : DELETE
Parameter Order :
Description : Deletes the specified GlobalForwardingRule resource.
Path : projects/{project}/global/forwardingRules/{forwardingRule}
Scopes :
Flat Path : projects/{project}/global/forwardingRules/{forwardingRule}
Parameters :
forwardingRule
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the ForwardingRule resource to delete.
Type : string
Required : Yes
requestId
Location : query
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
project
Location : path
Description : Project ID for this request.
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])?))
Required : Yes
Apiversion : 2026-12-01-preview
▼ ▲ compute.globalForwardingRules.list
Description : Retrieves a list of GlobalForwardingRule resources available to the specified project.
Scopes :
Parameter Order : project
HTTP Method : GET
Parameters :
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.
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
Description : Project ID for this request.
Type : string
Location : path
maxResults
Location : query
Type : integer
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`)
Format : uint32
Default : 500
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.
filter
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.
Location : query
Path : projects/{project}/global/forwardingRules
Flat Path : projects/{project}/global/forwardingRules
Apiversion : 2026-12-01-preview
▼ ▲ compute.globalForwardingRules.setTarget
HTTP Method : POST
Scopes :
Parameter Order :
Flat Path : projects/{project}/global/forwardingRules/{forwardingRule}/setTarget
Description : Changes target URL for the GlobalForwardingRule resource. The new target should be of the same type as the old target.
Path : projects/{project}/global/forwardingRules/{forwardingRule}/setTarget
Apiversion : 2026-12-01-preview
Parameters :
project
Type : string
Location : path
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])?))
Required : Yes
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).
forwardingRule
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Description : Name of the ForwardingRule resource in which target is to be set.
Required : Yes
Location : path
▼ ▲ compute.globalForwardingRules.patch
Parameter Order :
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
project
Location : path
Required : Yes
Description : Project ID for this request.
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])?))
forwardingRule
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the ForwardingRule resource to patch.
Required : Yes
Type : string
Scopes :
Apiversion : 2026-12-01-preview
Path : projects/{project}/global/forwardingRules/{forwardingRule}
Description : Updates the specified forwarding rule with the data included in the request. This method supportsPATCH semantics and uses theJSON merge patch format and processing rules. Currently, you can only patch the network_tier field.
Flat Path : projects/{project}/global/forwardingRules/{forwardingRule}
HTTP Method : PATCH
▼ ▲ compute.globalForwardingRules.get
Path : projects/{project}/global/forwardingRules/{forwardingRule}
Parameter Order :
HTTP Method : GET
Flat Path : projects/{project}/global/forwardingRules/{forwardingRule}
Scopes :
Parameters :
view
Enum :
Enum Descriptions :
Location : query
Type : string
forwardingRule
Location : path
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the ForwardingRule resource to return.
Required : Yes
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])?))
Type : string
Location : path
Required : Yes
Description : Project ID for this request.
Apiversion : 2026-12-01-preview
Description : Returns the specified GlobalForwardingRule resource. Gets a list of available forwarding rules by making a list() request.
▼ ▲ compute.globalForwardingRules.insert
Apiversion : 2026-12-01-preview
Parameters :
project
Description : Project ID for this request.
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])?))
Location : path
requestId
Location : query
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
Description : Creates a GlobalForwardingRule resource in the specified project using the data included in the request.
Path : projects/{project}/global/forwardingRules
Parameter Order : project
Flat Path : projects/{project}/global/forwardingRules
Scopes :
HTTP Method : POST
▼ ▲ compute.globalForwardingRules.setLabels
HTTP Method : POST
Parameters :
resource
Description : Name or id of the resource for this request.
Required : Yes
Pattern : [a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Type : string
project
Description : Project ID for this request.
Location : path
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])?))
Path : projects/{project}/global/forwardingRules/{resource}/setLabels
Parameter Order :
Description : Sets the labels on the specified resource. To learn more about labels, read the Labeling resources documentation.
Scopes :
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/global/forwardingRules/{resource}/setLabels
▼ ▲ compute.networkFirewallPolicies.getAssociation
Parameter Order :
Parameters :
name
Type : string
Location : query
Description : The name of the association to get from the firewall policy.
project
Required : Yes
Description : Project ID for this request.
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])?))
firewallPolicy
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Location : path
Description : Name of the firewall policy to which the queried association belongs.
Type : string
Scopes :
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/getAssociation
Description : Gets an association with the specified name.
HTTP Method : GET
Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/getAssociation
▼ ▲ compute.networkFirewallPolicies.patchPacketMirroringRule
Scopes :
Flat Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/patchPacketMirroringRule
HTTP Method : POST
Description : Patches a packet mirroring rule of the specified priority.
Apiversion : 2026-12-01-preview
Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/patchPacketMirroringRule
Parameters :
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
priority
Description : The priority of the rule to patch.
Location : query
Type : integer
Format : int32
firewallPolicy
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Location : path
Type : string
Description : Name of the firewall policy to update.
requestId
Location : query
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
Parameter Order :
▼ ▲ compute.networkFirewallPolicies.getIamPolicy
Scopes :
Parameter Order :
Path : projects/{project}/global/firewallPolicies/{resource}/getIamPolicy
Description : Gets the access control policy for a resource. May be empty if no such policy or resource exists.
Flat Path : projects/{project}/global/firewallPolicies/{resource}/getIamPolicy
HTTP Method : GET
Parameters :
optionsRequestedPolicyVersion
Description : Requested IAM Policy version.
Type : integer
Format : int32
Location : query
resource
Required : Yes
Type : string
Description : Name or id of the resource for this request.
Pattern : [a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
project
Type : string
Location : path
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])?))
Required : Yes
Apiversion : 2026-12-01-preview
▼ ▲ compute.networkFirewallPolicies.removePacketMirroringRule
Parameters :
priority
Description : The priority of the rule to remove from the firewall policy.
Location : query
Type : integer
Format : int32
firewallPolicy
Required : Yes
Description : Name of the firewall policy to update.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
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
Location : path
Type : string
Required : Yes
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])?))
Description : Deletes a packet mirroring rule of the specified priority.
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/removePacketMirroringRule
Scopes :
Parameter Order :
Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/removePacketMirroringRule
HTTP Method : POST
▼ ▲ compute.networkFirewallPolicies.aggregatedList
Scopes :
HTTP Method : GET
Parameter Order : project
Apiversion : 2026-12-01-preview
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
Description : Project ID for this request.
Location : path
maxResults
Location : query
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`)
Type : integer
Minimum : 0
Default : 500
serviceProjectNumber
Description : The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.
Type : string
Location : query
Format : int64
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.
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
includeAllScopes
Description : Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
Type : boolean
Location : query
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.
Flat Path : projects/{project}/aggregated/firewallPolicies
Path : projects/{project}/aggregated/firewallPolicies
Description : Retrieves an aggregated list of network firewall policies, listing network firewall policies from all applicable scopes (global and regional) and grouping the results per scope. To prevent failure, it is recommended that you set the `returnPartialSuccess` parameter to `true`.
▼ ▲ compute.networkFirewallPolicies.testIamPermissions
Description : Returns permissions that a caller has on the specified resource.
Scopes :
HTTP Method : POST
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])?))
Description : Project ID for this request.
Location : path
Type : string
Required : Yes
resource
Required : Yes
Type : string
Pattern : [a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name or id of the resource for this request.
Location : path
Apiversion : 2026-12-01-preview
Parameter Order :
Path : projects/{project}/global/firewallPolicies/{resource}/testIamPermissions
Flat Path : projects/{project}/global/firewallPolicies/{resource}/testIamPermissions
▼ ▲ compute.networkFirewallPolicies.addAssociation
Parameter Order :
Parameters :
replaceExistingAssociation
Type : boolean
Description : Indicates whether or not to replace it if an association of the attachment already exists. This is false by default, in which case an error will be returned if an association already exists.
Location : query
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
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.
Type : string
Location : path
firewallPolicy
Type : string
Location : path
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the firewall policy to update.
Apiversion : 2026-12-01-preview
Description : Inserts an association for the specified firewall policy.
Scopes :
Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/addAssociation
Flat Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/addAssociation
HTTP Method : POST
▼ ▲ compute.networkFirewallPolicies.getPacketMirroringRule
Flat Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/getPacketMirroringRule
HTTP Method : GET
Description : Gets a packet mirroring rule of the specified priority.
Apiversion : 2026-12-01-preview
Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/getPacketMirroringRule
Parameter Order :
Scopes :
Parameters :
priority
Type : integer
Description : The priority of the rule to get from the firewall policy.
Format : int32
Location : query
firewallPolicy
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Description : Name of the firewall policy to which the queried rule belongs.
project
Description : Project ID for this request.
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])?))
Location : path
Type : string
▼ ▲ compute.networkFirewallPolicies.addRule
Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/addRule
HTTP Method : POST
Scopes :
Description : Inserts a rule into a firewall policy.
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/addRule
Parameters :
firewallPolicy
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the firewall policy to update.
Required : Yes
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
maxPriority
Location : query
Description : When rule.priority is not specified, auto choose a unused priority betweenminPriority and maxPriority>. This field is exclusive with rule.priority.
Type : integer
Format : int32
minPriority
Format : int32
Location : query
Description : When rule.priority is not specified, auto choose a unused priority betweenminPriority and maxPriority>. This field is exclusive with rule.priority.
Type : integer
project
Location : path
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])?))
Required : Yes
Description : Project ID for this request.
Parameter Order :
▼ ▲ compute.networkFirewallPolicies.insert
Description : Creates a new policy in the specified project using the data included in the request.
HTTP Method : POST
Path : projects/{project}/global/firewallPolicies
Apiversion : 2026-12-01-preview
Scopes :
Parameters :
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).
project
Type : string
Location : path
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])?))
Required : Yes
Flat Path : projects/{project}/global/firewallPolicies
Parameter Order : project
▼ ▲ compute.networkFirewallPolicies.addPacketMirroringRule
Flat Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/addPacketMirroringRule
Scopes :
Apiversion : 2026-12-01-preview
Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/addPacketMirroringRule
Parameters :
maxPriority
Format : int32
Description : When rule.priority is not specified, auto choose a unused priority betweenminPriority and maxPriority>. This field is exclusive with rule.priority.
Location : query
Type : integer
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])?))
Description : Project ID for this request.
Type : string
Required : Yes
firewallPolicy
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Required : Yes
Description : Name of the firewall policy to update.
Location : path
requestId
Type : string
Location : query
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).
minPriority
Location : query
Description : When rule.priority is not specified, auto choose a unused priority betweenminPriority and maxPriority>. This field is exclusive with rule.priority.
Type : integer
Format : int32
HTTP Method : POST
Parameter Order :
Description : Inserts a packet mirroring rule into a firewall policy.
▼ ▲ compute.networkFirewallPolicies.setIamPolicy
Flat Path : projects/{project}/global/firewallPolicies/{resource}/setIamPolicy
Parameters :
resource
Type : string
Required : Yes
Pattern : [a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Description : Name or id of the resource for this request.
project
Description : Project ID for this request.
Location : path
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 : Sets the access control policy on the specified resource. Replaces any existing policy.
Apiversion : 2026-12-01-preview
Parameter Order :
Scopes :
HTTP Method : POST
Path : projects/{project}/global/firewallPolicies/{resource}/setIamPolicy
▼ ▲ compute.networkFirewallPolicies.delete
HTTP Method : DELETE
Flat Path : projects/{project}/global/firewallPolicies/{firewallPolicy}
Parameter Order :
Apiversion : 2026-12-01-preview
Path : projects/{project}/global/firewallPolicies/{firewallPolicy}
Parameters :
requestId
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).
Location : query
firewallPolicy
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Required : Yes
Description : Name of the firewall policy to delete.
Location : path
project
Description : Project ID for this request.
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])?))
Location : path
Scopes :
Description : Deletes the specified policy.
▼ ▲ compute.networkFirewallPolicies.removeRule
Parameters :
requestId
Type : string
Location : query
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).
priority
Location : query
Type : integer
Description : The priority of the rule to remove from the firewall policy.
Format : int32
firewallPolicy
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Description : Name of the firewall policy to update.
Location : path
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
Location : path
Type : string
Description : Project ID for this request.
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/removeRule
Description : Deletes a rule of the specified priority.
Scopes :
Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/removeRule
Parameter Order :
HTTP Method : POST
▼ ▲ compute.networkFirewallPolicies.getRule
Parameters :
firewallPolicy
Type : string
Description : Name of the firewall policy to which the queried rule belongs.
Location : path
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
priority
Format : int32
Description : The priority of the rule to get from the firewall policy.
Location : query
Type : integer
project
Required : Yes
Description : Project ID for this request.
Location : path
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])?))
Flat Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/getRule
Description : Gets a rule of the specified priority.
Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/getRule
Apiversion : 2026-12-01-preview
Parameter Order :
Scopes :
HTTP Method : GET
▼ ▲ compute.networkFirewallPolicies.removeAssociation
Flat Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/removeAssociation
Apiversion : 2026-12-01-preview
Parameters :
name
Type : string
Location : query
Description : Name for the attachment that will be removed.
firewallPolicy
Location : path
Description : Name of the firewall policy to update.
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
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.
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
Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/removeAssociation
HTTP Method : POST
Description : Removes an association for the specified firewall policy.
Scopes :
Parameter Order :
▼ ▲ compute.networkFirewallPolicies.patchRule
Description : Patches a rule of the specified priority.
Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/patchRule
Parameter Order :
HTTP Method : POST
Scopes :
Parameters :
priority
Description : The priority of the rule to patch.
Location : query
Type : integer
Format : int32
project
Required : Yes
Type : string
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])?))
firewallPolicy
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Description : Name of the firewall policy to update.
Location : path
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
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/patchRule
▼ ▲ compute.networkFirewallPolicies.list
Flat Path : projects/{project}/global/firewallPolicies
Scopes :
HTTP Method : GET
Apiversion : 2026-12-01-preview
Parameters :
project
Type : string
Location : path
Required : Yes
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])?))
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.
Type : string
Location : query
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`)
Type : integer
Location : query
Default : 500
Format : uint32
Minimum : 0
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
pageToken
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.
Type : string
Path : projects/{project}/global/firewallPolicies
Parameter Order : project
Description : Lists all the policies that have been configured for the specified project.
▼ ▲ compute.networkFirewallPolicies.get
HTTP Method : GET
Parameter Order :
Description : Returns the specified network firewall policy.
Flat Path : projects/{project}/global/firewallPolicies/{firewallPolicy}
Path : projects/{project}/global/firewallPolicies/{firewallPolicy}
Scopes :
Apiversion : 2026-12-01-preview
Parameters :
firewallPolicy
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Required : Yes
Description : Name of the firewall policy to get.
project
Required : Yes
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])?))
Type : string
Location : path
▼ ▲ compute.networkFirewallPolicies.cloneRules
Scopes :
Apiversion : 2026-12-01-preview
Parameters :
sourceFirewallPolicy
Type : string
Description : The firewall policy from which to copy rules.
Location : query
firewallPolicy
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the firewall policy to update.
Type : string
Required : Yes
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])?))
Description : Project ID for this request.
Type : string
Required : Yes
Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/cloneRules
Flat Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/cloneRules
Description : Copies rules to the specified firewall policy.
Parameter Order :
HTTP Method : POST
▼ ▲ compute.networkFirewallPolicies.patch
Flat Path : projects/{project}/global/firewallPolicies/{firewallPolicy}
HTTP Method : PATCH
Description : Patches the specified policy with the data included in the request.
Scopes :
Apiversion : 2026-12-01-preview
Parameters :
project
Type : string
Location : path
Description : Project ID for this request.
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])?))
requestId
Location : query
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
firewallPolicy
Required : Yes
Description : Name of the firewall policy to update.
Location : path
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Path : projects/{project}/global/firewallPolicies/{firewallPolicy}
Parameter Order :
▼ ▲ compute.futureReservations.delete
Flat Path : projects/{project}/zones/{zone}/futureReservations/{futureReservation}
Path : projects/{project}/zones/{zone}/futureReservations/{futureReservation}
Description : Deletes the specified future reservation.
Scopes :
Apiversion : 2026-12-01-preview
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).
Location : query
Type : string
futureReservation
Description : Name of the future reservation to retrieve. Name should conform to RFC1035.
Location : path
Required : Yes
Type : string
zone
Required : Yes
Location : path
Description : Name of the zone for this request. Name should conform to RFC1035.
Type : string
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])?))
Required : Yes
Description : Project ID for this request.
Type : string
HTTP Method : DELETE
Parameter Order :
▼ ▲ compute.futureReservations.get
HTTP Method : GET
Path : projects/{project}/zones/{zone}/futureReservations/{futureReservation}
Scopes :
Parameter Order :
Flat Path : projects/{project}/zones/{zone}/futureReservations/{futureReservation}
Apiversion : 2026-12-01-preview
Description : Retrieves information about the specified future reservation.
Parameters :
project
Required : Yes
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])?))
Type : string
zone
Required : Yes
Description : Name of the zone for this request. Name should conform to RFC1035.
Location : path
Type : string
futureReservation
Required : Yes
Type : string
Location : path
Description : Name of the future reservation to retrieve. Name should conform to RFC1035.
▼ ▲ compute.futureReservations.list
Flat Path : projects/{project}/zones/{zone}/futureReservations
Scopes :
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])?))
Type : string
Description : Project ID for this request.
Required : Yes
Location : path
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.
Type : string
Location : query
maxResults
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`)
Minimum : 0
Format : uint32
Type : integer
Location : query
zone
Required : Yes
Description : Name of the zone for this request. Name should conform to RFC1035.
Type : string
Location : path
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.
Type : string
Location : query
filter
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.
Type : string
Apiversion : 2026-12-01-preview
Path : projects/{project}/zones/{zone}/futureReservations
Parameter Order :
Description : A list of all the future reservations that have been configured for the specified project in specified zone.
HTTP Method : GET
▼ ▲ compute.futureReservations.update
Flat Path : projects/{project}/zones/{zone}/futureReservations/{futureReservation}
HTTP Method : PATCH
Description : Updates the specified future reservation.
Parameters :
updateMask
Location : query
Type : string
Format : google-fieldmask
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).
Location : query
Type : string
zone
Location : path
Type : string
Description : Name of the zone for this request. Name should conform to RFC1035.
Required : Yes
project
Location : path
Description : Project ID for this request.
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])?))
Required : Yes
futureReservation
Location : path
Description : Name of the reservation to update. Name should conform to RFC1035.
Required : Yes
Type : string
Scopes :
Path : projects/{project}/zones/{zone}/futureReservations/{futureReservation}
Apiversion : 2026-12-01-preview
Parameter Order :
▼ ▲ compute.futureReservations.cancel
HTTP Method : POST
Parameter Order :
Scopes :
Flat Path : projects/{project}/zones/{zone}/futureReservations/{futureReservation}/cancel
Description : Cancel the specified future reservation.
Parameters :
requestId
Location : query
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
futureReservation
Description : Name of the future reservation to retrieve. Name should conform to RFC1035.
Type : string
Required : Yes
Location : path
zone
Location : path
Type : string
Required : Yes
Description : Name of the zone for this request. Name should conform to RFC1035.
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])?))
Type : string
Location : path
Description : Project ID for this request.
Apiversion : 2026-12-01-preview
Path : projects/{project}/zones/{zone}/futureReservations/{futureReservation}/cancel
▼ ▲ compute.futureReservations.insert
Path : projects/{project}/zones/{zone}/futureReservations
HTTP Method : POST
Flat Path : projects/{project}/zones/{zone}/futureReservations
Parameter Order :
Scopes :
Description : Creates a new Future Reservation.
Parameters :
zone
Type : string
Location : path
Description : Name of the zone for this request. Name should conform to RFC1035.
Required : Yes
requestId
Type : string
Location : query
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).
project
Required : Yes
Type : string
Location : path
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])?))
Apiversion : 2026-12-01-preview
▼ ▲ compute.futureReservations.aggregatedList
Scopes :
Path : projects/{project}/aggregated/futureReservations
HTTP Method : GET
Parameter Order : project
Description : Retrieves an aggregated list of future reservations. To prevent failure, it is recommended that you set the `returnPartialSuccess` parameter to `true`.
Apiversion : 2026-12-01-preview
Parameters :
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
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])?))
Type : string
Location : path
Description : Project ID for this request.
Required : Yes
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.
Type : string
Location : query
maxResults
Location : query
Type : integer
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`)
Format : uint32
Minimum : 0
includeAllScopes
Description : Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
Type : boolean
Location : query
serviceProjectNumber
Type : string
Description : The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.
Location : query
Format : int64
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
Flat Path : projects/{project}/aggregated/futureReservations
▼ ▲ compute.securityPolicies.insert
Scopes :
Parameters :
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])?))
Required : Yes
Description : Project ID for this request.
Type : string
validateOnly
Location : query
Description : If true, the request will not be committed.
Type : boolean
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
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/global/securityPolicies
Description : Creates a new policy in the specified project using the data included in the request.
Parameter Order : project
HTTP Method : POST
Path : projects/{project}/global/securityPolicies
▼ ▲ compute.securityPolicies.aggregatedList
Apiversion : 2026-12-01-preview
Parameters :
project
Description : Name of the project scoping 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])?))
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.
orderBy
Type : string
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.
maxResults
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`)
Type : integer
Minimum : 0
Default : 500
Location : query
includeAllScopes
Type : boolean
Location : query
Description : Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
filter
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.
Type : string
serviceProjectNumber
Format : int64
Type : string
Description : The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.
Location : query
Parameter Order : project
Description : Retrieves the list of all SecurityPolicy resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.
Scopes :
Path : projects/{project}/aggregated/securityPolicies
HTTP Method : GET
Flat Path : projects/{project}/aggregated/securityPolicies
▼ ▲ compute.securityPolicies.get
Description : List all of the ordered rules present in a single specified policy.
Flat Path : projects/{project}/global/securityPolicies/{securityPolicy}
Apiversion : 2026-12-01-preview
Parameters :
project
Location : path
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])?))
Type : string
Description : Project ID for this request.
securityPolicy
Description : Name of the security policy to get.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Location : path
HTTP Method : GET
Parameter Order :
Path : projects/{project}/global/securityPolicies/{securityPolicy}
Scopes :
▼ ▲ compute.securityPolicies.patchRule
Path : projects/{project}/global/securityPolicies/{securityPolicy}/patchRule
Parameter Order :
Scopes :
Description : Patches a rule at the specified priority. To clear fields in the rule, leave the fields empty and specify them in the updateMask.
HTTP Method : POST
Flat Path : projects/{project}/global/securityPolicies/{securityPolicy}/patchRule
Parameters :
updateMask
Type : string
Format : google-fieldmask
Description : Indicates fields to be cleared as part of this request.
Location : query
priority
Type : integer
Description : The priority of the rule to patch.
Format : int32
Location : query
securityPolicy
Type : string
Location : path
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the security policy to update.
project
Required : Yes
Description : Project ID for this request.
Location : path
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])?))
validateOnly
Type : boolean
Location : query
Description : If true, the request will not be committed.
Apiversion : 2026-12-01-preview
▼ ▲ compute.securityPolicies.addRule
Flat Path : projects/{project}/global/securityPolicies/{securityPolicy}/addRule
Path : projects/{project}/global/securityPolicies/{securityPolicy}/addRule
HTTP Method : POST
Apiversion : 2026-12-01-preview
Scopes :
Parameters :
securityPolicy
Description : Name of the security policy to update.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Type : string
project
Type : string
Location : path
Required : Yes
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])?))
validateOnly
Type : boolean
Description : If true, the request will not be committed.
Location : query
Description : Inserts a rule into a security policy.
Parameter Order :
▼ ▲ compute.securityPolicies.delete
HTTP Method : DELETE
Path : projects/{project}/global/securityPolicies/{securityPolicy}
Scopes :
Parameter Order :
Apiversion : 2026-12-01-preview
Description : Deletes the specified policy.
Flat Path : projects/{project}/global/securityPolicies/{securityPolicy}
Parameters :
securityPolicy
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Required : Yes
Description : Name of the security policy to delete.
project
Type : string
Location : path
Required : Yes
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])?))
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
▼ ▲ compute.securityPolicies.list
Parameters :
project
Location : path
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])?))
Type : string
Description : Project ID for this request.
pageToken
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.
Type : string
maxResults
Minimum : 0
Type : integer
Location : query
Default : 500
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
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
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.
Flat Path : projects/{project}/global/securityPolicies
Apiversion : 2026-12-01-preview
Scopes :
Parameter Order : project
Path : projects/{project}/global/securityPolicies
HTTP Method : GET
Description : List all the policies that have been configured for the specified project.
▼ ▲ compute.securityPolicies.listPreconfiguredExpressionSets
Apiversion : 2026-12-01-preview
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`)
Format : uint32
Type : integer
Default : 500
Minimum : 0
Location : query
project
Required : Yes
Type : string
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])?))
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.
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
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
Scopes :
Path : projects/{project}/global/securityPolicies/listPreconfiguredExpressionSets
Description : Gets the current list of preconfigured Web Application Firewall (WAF) expressions.
Parameter Order : project
HTTP Method : GET
Flat Path : projects/{project}/global/securityPolicies/listPreconfiguredExpressionSets
▼ ▲ compute.securityPolicies.removeRule
Apiversion : 2026-12-01-preview
Parameters :
securityPolicy
Required : Yes
Description : Name of the security policy to update.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Location : path
project
Description : Project ID for this request.
Type : string
Location : path
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])?))
priority
Description : The priority of the rule to remove from the security policy.
Type : integer
Location : query
Format : int32
Parameter Order :
Scopes :
Path : projects/{project}/global/securityPolicies/{securityPolicy}/removeRule
HTTP Method : POST
Flat Path : projects/{project}/global/securityPolicies/{securityPolicy}/removeRule
Description : Deletes a rule at the specified priority.
▼ ▲ compute.securityPolicies.getRule
Path : projects/{project}/global/securityPolicies/{securityPolicy}/getRule
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])?))
Description : Project ID for this request.
Location : path
Type : string
Required : Yes
securityPolicy
Required : Yes
Description : Name of the security policy to which the queried rule belongs.
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
priority
Type : integer
Description : The priority of the rule to get from the security policy.
Format : int32
Location : query
Description : Gets a rule at the specified priority.
Parameter Order :
Apiversion : 2026-12-01-preview
HTTP Method : GET
Flat Path : projects/{project}/global/securityPolicies/{securityPolicy}/getRule
Scopes :
▼ ▲ compute.securityPolicies.patch
HTTP Method : PATCH
Flat Path : projects/{project}/global/securityPolicies/{securityPolicy}
Parameter Order :
Description : Patches the specified policy with the data included in the request. To clear fields in the policy, leave the fields empty and specify them in the updateMask. This cannot be used to be update the rules in the policy. Please use the per rule methods like addRule, patchRule, and removeRule instead.
Scopes :
Path : projects/{project}/global/securityPolicies/{securityPolicy}
Apiversion : 2026-12-01-preview
Parameters :
updateMask
Description : Indicates fields to be cleared as part of this request.
Location : query
Type : string
Format : google-fieldmask
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
Type : string
Required : Yes
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])?))
securityPolicy
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Location : path
Description : Name of the security policy to update.
Required : Yes
▼ ▲ compute.securityPolicies.setLabels
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/global/securityPolicies/{resource}/setLabels
Parameters :
project
Location : path
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])?))
Required : Yes
Description : Project ID for this request.
resource
Description : Name or id of the resource for this request.
Type : string
Pattern : [a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Required : Yes
Path : projects/{project}/global/securityPolicies/{resource}/setLabels
Description : Sets the labels on a security policy. To learn more about labels, read the Labeling Resources documentation.
Parameter Order :
Scopes :
HTTP Method : POST
▼ ▲ compute.nodeTemplates.delete
Parameters :
nodeTemplate
Required : Yes
Description : Name of the NodeTemplate resource to delete.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Location : path
project
Location : path
Description : Project ID for this request.
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])?))
region
Type : string
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Description : The name of the region for this request.
requestId
Type : string
Location : query
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 :
Apiversion : 2026-12-01-preview
Path : projects/{project}/regions/{region}/nodeTemplates/{nodeTemplate}
Scopes :
Description : Deletes the specified NodeTemplate resource.
Flat Path : projects/{project}/regions/{region}/nodeTemplates/{nodeTemplate}
HTTP Method : DELETE
▼ ▲ compute.nodeTemplates.setIamPolicy
Apiversion : 2026-12-01-preview
Parameters :
project
Location : path
Description : Project ID for this request.
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])?))
Required : Yes
region
Required : Yes
Type : string
Description : The name of the region for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
resource
Description : Name or id of the resource for this request.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Type : string
Path : projects/{project}/regions/{region}/nodeTemplates/{resource}/setIamPolicy
Flat Path : projects/{project}/regions/{region}/nodeTemplates/{resource}/setIamPolicy
Parameter Order :
Scopes :
HTTP Method : POST
Description : Sets the access control policy on the specified resource. Replaces any existing policy.
▼ ▲ compute.nodeTemplates.aggregatedList
Scopes :
Parameters :
serviceProjectNumber
Format : int64
Location : query
Description : The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.
Type : string
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
Type : integer
Format : uint32
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`)
includeAllScopes
Location : query
Type : boolean
Description : Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
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.
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
Required : Yes
Type : string
Location : path
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])?))
Parameter Order : project
Apiversion : 2026-12-01-preview
Flat Path : projects/{project}/aggregated/nodeTemplates
HTTP Method : GET
Path : projects/{project}/aggregated/nodeTemplates
Description : Retrieves an aggregated list of node templates. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.
▼ ▲ compute.nodeTemplates.get
Path : projects/{project}/regions/{region}/nodeTemplates/{nodeTemplate}
Scopes :
HTTP Method : GET
Apiversion : 2026-12-01-preview
Parameters :
nodeTemplate
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Location : path
Description : Name of the node template to return.
Type : string
region
Required : Yes
Description : The name of the region for this request.
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
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])?))
Description : Project ID for this request.
Required : Yes
Type : string
Flat Path : projects/{project}/regions/{region}/nodeTemplates/{nodeTemplate}
Parameter Order :
Description : Returns the specified node template.
▼ ▲ compute.nodeTemplates.list
HTTP Method : GET
Path : projects/{project}/regions/{region}/nodeTemplates
Description : Retrieves a list of node templates available to the specified project.
Scopes :
Flat Path : projects/{project}/regions/{region}/nodeTemplates
Apiversion : 2026-12-01-preview
Parameter Order :
Parameters :
region
Required : Yes
Description : The name of the region for this request.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
maxResults
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`)
Minimum : 0
Format : uint32
Type : integer
Location : query
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.
Type : string
Location : query
project
Required : Yes
Type : string
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])?))
filter
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.
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.
▼ ▲ compute.nodeTemplates.testIamPermissions
Flat Path : projects/{project}/regions/{region}/nodeTemplates/{resource}/testIamPermissions
Scopes :
Path : projects/{project}/regions/{region}/nodeTemplates/{resource}/testIamPermissions
HTTP Method : POST
Parameters :
region
Description : The name of the region for this request.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Location : path
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
Description : Project ID for this request.
Type : string
Location : path
resource
Location : path
Description : Name or id of the resource for this request.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Description : Returns permissions that a caller has on the specified resource.
Apiversion : 2026-12-01-preview
Parameter Order :
▼ ▲ compute.nodeTemplates.insert
Scopes :
Parameter Order :
HTTP Method : POST
Description : Creates a NodeTemplate resource in the specified project using the data included in the request.
Path : projects/{project}/regions/{region}/nodeTemplates
Flat Path : projects/{project}/regions/{region}/nodeTemplates
Parameters :
requestId
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).
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])?))
Type : string
Required : Yes
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Description : The name of the region for this request.
Type : string
Required : Yes
Apiversion : 2026-12-01-preview
▼ ▲ compute.nodeTemplates.getIamPolicy
Apiversion : 2026-12-01-preview
Description : Gets the access control policy for a resource. May be empty if no such policy or resource exists.
Scopes :
Parameters :
resource
Location : path
Description : Name or id of the resource for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Required : Yes
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
optionsRequestedPolicyVersion
Format : int32
Description : Requested IAM Policy version.
Type : integer
Location : query
region
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : The name of the region for this request.
Required : Yes
Type : string
Flat Path : projects/{project}/regions/{region}/nodeTemplates/{resource}/getIamPolicy
Parameter Order :
Path : projects/{project}/regions/{region}/nodeTemplates/{resource}/getIamPolicy
HTTP Method : GET