2026-09-23
▼ ▲ compute.networkEdgeSecurityServices.insert
Description : Creates a new service in the specified project using the data included in the request.
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/regions/{region}/networkEdgeSecurityServices
HTTP Method : POST
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).
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.
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
validateOnly
Description : If true, the request will not be committed.
Location : query
Type : boolean
Scopes :
Path : projects/{project}/regions/{region}/networkEdgeSecurityServices
▼ ▲ compute.networkEdgeSecurityServices.delete
Description : Deletes the specified service.
Path : projects/{project}/regions/{region}/networkEdgeSecurityServices/{networkEdgeSecurityService}
Flat Path : projects/{project}/regions/{region}/networkEdgeSecurityServices/{networkEdgeSecurityService}
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
Location : path
Type : string
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Name of the region scoping this request.
networkEdgeSecurityService
Description : Name of the network edge security service to delete.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Required : Yes
Type : string
Scopes :
HTTP Method : DELETE
Apiversion : 2026-10-01-preview
Parameter Order :
▼ ▲ compute.networkEdgeSecurityServices.aggregatedList
Apiversion : 2026-10-01-preview
HTTP Method : GET
Path : projects/{project}/aggregated/networkEdgeSecurityServices
Parameter Order : project
Parameters :
project
Type : string
Required : Yes
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])?))
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
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
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
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.
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
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}/aggregated/networkEdgeSecurityServices
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`.
Scopes :
▼ ▲ compute.networkEdgeSecurityServices.patch
Parameters :
updateMask
Format : google-fieldmask
Description : Indicates fields to be updated as part of this request.
Location : query
Type : string
networkEdgeSecurityService
Location : path
Required : Yes
Type : string
Description : Name of the network edge security service 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])?))
Type : string
Required : Yes
Description : Project ID for this request.
Location : path
paths
Type : string
Location : query
Repeated : 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
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
Path : projects/{project}/regions/{region}/networkEdgeSecurityServices/{networkEdgeSecurityService}
Description : Patches the specified policy with the data included in the request.
Scopes :
Apiversion : 2026-10-01-preview
Parameter Order :
Flat Path : projects/{project}/regions/{region}/networkEdgeSecurityServices/{networkEdgeSecurityService}
HTTP Method : PATCH
▼ ▲ compute.networkEdgeSecurityServices.get
Path : projects/{project}/regions/{region}/networkEdgeSecurityServices/{networkEdgeSecurityService}
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
networkEdgeSecurityService
Description : Name of the network edge security service to get.
Location : path
Type : string
Required : Yes
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])?
Required : Yes
Description : Name of the region scoping this request.
Type : string
Location : path
Parameter Order :
Description : Gets a specified NetworkEdgeSecurityService.
Flat Path : projects/{project}/regions/{region}/networkEdgeSecurityServices/{networkEdgeSecurityService}
Apiversion : 2026-10-01-preview
HTTP Method : GET
Scopes :
▼ ▲ compute.acceleratorTypes.get
Flat Path : projects/{project}/zones/{zone}/acceleratorTypes/{acceleratorType}
Parameters :
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
acceleratorType
Location : path
Type : string
Description : Name of the accelerator type to return.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
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])?))
Scopes :
Path : projects/{project}/zones/{zone}/acceleratorTypes/{acceleratorType}
Parameter Order :
Description : Returns the specified accelerator type.
HTTP Method : GET
Apiversion : 2026-10-01-preview
▼ ▲ compute.acceleratorTypes.list
HTTP Method : GET
Scopes :
Path : projects/{project}/zones/{zone}/acceleratorTypes
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/zones/{zone}/acceleratorTypes
Parameter Order :
Description : Retrieves a list of accelerator types that are available to the specified project.
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.
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
maxResults
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
Format : uint32
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
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])?))
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.acceleratorTypes.aggregatedList
HTTP Method : GET
Apiversion : 2026-10-01-preview
Parameter Order : project
Description : Retrieves an aggregated list of accelerator types. To prevent failure, it is recommended that you set the `returnPartialSuccess` parameter to `true`.
Flat Path : projects/{project}/aggregated/acceleratorTypes
Scopes :
Parameters :
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
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
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.
Location : query
Type : string
maxResults
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`)
Format : uint32
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
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
Path : projects/{project}/aggregated/acceleratorTypes
▼ ▲ compute.regionInstanceGroupManagerResizeRequests.get
Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}
Parameter Order :
Scopes :
Parameters :
region
Type : string
Required : Yes
Location : path
Description : The name of the region scoping this request. Name should conform to RFC1035.
instanceGroupManager
Location : path
Description : The name of the managed instance group. Name should conform to RFC1035 or be a resource ID.
Required : Yes
Type : string
resizeRequest
Required : Yes
Type : string
Location : path
Description : The name of the resize request. Name should conform to RFC1035 or be a resource ID.
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}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}
Description : Returns all of the details about the specified resize request.
Apiversion : 2026-10-01-preview
HTTP Method : GET
▼ ▲ compute.regionInstanceGroupManagerResizeRequests.cancel
Apiversion : 2026-10-01-preview
Scopes :
Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}/cancel
HTTP Method : POST
Parameter Order :
Flat Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}/cancel
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
region
Type : string
Location : path
Description : The name of the region scoping this request. Name should conform to RFC1035.
Required : Yes
instanceGroupManager
Description : The name of the managed instance group. Name should conform to RFC1035 or be a resource ID.
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).
resizeRequest
Type : string
Required : Yes
Description : The name of the resize request to cancel. Name should conform to RFC1035 or be a resource ID.
Location : path
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.
▼ ▲ compute.regionInstanceGroupManagerResizeRequests.list
Parameter Order :
Flat Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests
Parameters :
region
Location : path
Type : string
Description : Name of the region scoping this request. Name should conform to RFC1035.
Required : Yes
maxResults
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`)
Type : integer
Default : 500
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
Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-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
instanceGroupManager
Location : path
Required : Yes
Description : The name of the managed instance group. The name should conform to RFC1035.
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
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
HTTP Method : GET
Scopes :
Description : Retrieves a list of Resize Requests that are contained in the managed instance group.
Apiversion : 2026-10-01-preview
Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests
▼ ▲ compute.regionInstanceGroupManagerResizeRequests.insert
Apiversion : 2026-10-01-preview
HTTP Method : POST
Parameter Order :
Scopes :
Flat Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests
Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests
Parameters :
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).
Type : string
Location : query
instanceGroupManager
Required : Yes
Location : path
Type : string
Description : Name of the managed instance group to which the resize request is scoped. Name should conform to RFC1035 or be a resource ID.
region
Location : path
Required : Yes
Description : Name of the region scoping this request. Name should conform to RFC1035.
Type : string
Description : Creates a new Resize Request that starts provisioning VMs immediately or queues VM creation.
▼ ▲ compute.regionInstanceGroupManagerResizeRequests.delete
Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}
Description : Deletes the specified, inactive resize request. Requests that are still active cannot be deleted. Deleting request does not delete instances that were provisioned previously.
Apiversion : 2026-10-01-preview
HTTP Method : DELETE
Parameter Order :
Scopes :
Flat Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}
Parameters :
resizeRequest
Type : string
Location : path
Description : The name of the resize request to delete. Name should conform to RFC1035 or be a resource ID.
Required : Yes
region
Description : The name of the region scoping this request. Name should conform to RFC1035.
Required : Yes
Location : path
Type : string
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).
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
▼ ▲ compute.regionHealthSources.list
HTTP Method : GET
Apiversion : 2026-10-01-preview
Path : projects/{project}/regions/{region}/healthSources
Flat Path : projects/{project}/regions/{region}/healthSources
Description : Lists the HealthSources for a project in the given region.
Scopes :
Parameter Order :
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
region
Description : Name of the region scoping this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
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.
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`)
Default : 500
Format : uint32
Type : integer
Minimum : 0
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
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.
▼ ▲ compute.regionHealthSources.insert
Scopes :
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
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.
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}/healthSources
HTTP Method : POST
Apiversion : 2026-10-01-preview
Path : projects/{project}/regions/{region}/healthSources
Description : Create a HealthSource in the specified project in the given region using the parameters that are included in the request.
Parameter Order :
▼ ▲ compute.regionHealthSources.delete
Scopes :
Apiversion : 2026-10-01-preview
HTTP Method : DELETE
Path : projects/{project}/regions/{region}/healthSources/{healthSource}
Flat Path : projects/{project}/regions/{region}/healthSources/{healthSource}
Description : Deletes the specified HealthSource in the given region
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
healthSource
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 HealthSource resource to delete.
Location : path
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
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])?))
Parameter Order :
▼ ▲ compute.regionHealthSources.testIamPermissions
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/regions/{region}/healthSources/{resource}/testIamPermissions
HTTP Method : POST
Parameter Order :
Description : Returns permissions that a caller has on the specified resource.
Scopes :
Parameters :
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
region
Type : string
Description : The name of the region for this request.
Required : Yes
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
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
Path : projects/{project}/regions/{region}/healthSources/{resource}/testIamPermissions
▼ ▲ compute.regionHealthSources.getHealth
Flat Path : projects/{project}/regions/{region}/healthSources/{healthSource}/getHealth
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 : Name of the project scoping this request.
healthSource
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 HealthSource resource to get health for.
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
Description : Gets the most recent health check results for this regional HealthSource.
Scopes :
Parameter Order :
HTTP Method : GET
Path : projects/{project}/regions/{region}/healthSources/{healthSource}/getHealth
Apiversion : 2026-10-01-preview
▼ ▲ compute.regionHealthSources.get
Scopes :
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])?))
healthSource
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 HealthSource resource to return.
Required : Yes
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Required : Yes
Description : Name of the region scoping this request.
Location : path
Description : Returns the specified HealthSource resource in the given region.
Flat Path : projects/{project}/regions/{region}/healthSources/{healthSource}
Parameter Order :
Apiversion : 2026-10-01-preview
HTTP Method : GET
Path : projects/{project}/regions/{region}/healthSources/{healthSource}
▼ ▲ compute.regionHealthSources.aggregatedList
Path : projects/{project}/aggregated/healthSources
Parameters :
serviceProjectNumber
Location : query
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.
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
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
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
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
Default : 500
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.
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.
HTTP Method : GET
Apiversion : 2026-10-01-preview
Flat 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
Scopes :
▼ ▲ compute.regionHealthSources.patch
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.
Parameters :
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.
healthSource
Required : Yes
Type : string
Location : path
Description : Name of the HealthSource to update. The name must be 1-63 characters long, and comply with RFC1035.
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
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 :
HTTP Method : PATCH
Scopes :
Apiversion : 2026-10-01-preview
Path : projects/{project}/regions/{region}/healthSources/{healthSource}
Flat Path : projects/{project}/regions/{region}/healthSources/{healthSource}
▼ ▲ compute.targetInstances.setSecurityPolicy
Flat Path : projects/{project}/zones/{zone}/targetInstances/{targetInstance}/setSecurityPolicy
Parameters :
targetInstance
Description : Name of the TargetInstance resource to which the security policy should be set. The name should conform to RFC1035.
Location : path
Required : Yes
Type : string
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
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
Required : Yes
Description : Name of the zone scoping this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Scopes :
Path : projects/{project}/zones/{zone}/targetInstances/{targetInstance}/setSecurityPolicy
Parameter Order :
Apiversion : 2026-10-01-preview
HTTP Method : POST
Description : Sets the Google Cloud Armor security policy for the specified target instance. For more information, seeGoogle Cloud Armor Overview
▼ ▲ compute.targetInstances.get
Path : projects/{project}/zones/{zone}/targetInstances/{targetInstance}
Parameters :
zone
Type : string
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Description : Name of the zone scoping this request.
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])?))
Required : Yes
Location : path
targetInstance
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 TargetInstance resource to return.
Location : path
Description : Returns the specified TargetInstance resource.
HTTP Method : GET
Flat Path : projects/{project}/zones/{zone}/targetInstances/{targetInstance}
Apiversion : 2026-10-01-preview
Scopes :
Parameter Order :
▼ ▲ compute.targetInstances.list
HTTP Method : GET
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/zones/{zone}/targetInstances
Parameter Order :
Path : projects/{project}/zones/{zone}/targetInstances
Description : Retrieves a list of TargetInstance resources available to the specified project and zone.
Parameters :
maxResults
Minimum : 0
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`)
Format : uint32
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
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
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
zone
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Name of the zone scoping this request.
Required : Yes
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
Scopes :
▼ ▲ compute.targetInstances.aggregatedList
Scopes :
Parameter Order : project
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
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
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
Location : query
Default : 500
Type : integer
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
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
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])?))
Apiversion : 2026-10-01-preview
Path : projects/{project}/aggregated/targetInstances
HTTP Method : GET
Description : Retrieves an aggregated list of target instances. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.
Flat Path : projects/{project}/aggregated/targetInstances
▼ ▲ compute.targetInstances.insert
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
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])?
Type : string
Description : Name of the zone scoping this request.
Required : Yes
Parameter Order :
HTTP Method : POST
Path : projects/{project}/zones/{zone}/targetInstances
Flat Path : projects/{project}/zones/{zone}/targetInstances
Apiversion : 2026-10-01-preview
Description : Creates a TargetInstance resource in the specified project and zone using the data included in the request.
▼ ▲ compute.targetInstances.delete
Path : projects/{project}/zones/{zone}/targetInstances/{targetInstance}
Apiversion : 2026-10-01-preview
HTTP Method : DELETE
Parameter Order :
Flat Path : projects/{project}/zones/{zone}/targetInstances/{targetInstance}
Parameters :
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.
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 : Name of the zone scoping this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
targetInstance
Required : Yes
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}
Scopes :
Description : Deletes the specified TargetInstance resource.
▼ ▲ compute.targetInstances.testIamPermissions
Scopes :
HTTP Method : POST
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/zones/{zone}/targetInstances/{resource}/testIamPermissions
Parameter Order :
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.
resource
Description : Name or id of the resource for this request.
Type : string
Required : Yes
Location : path
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])?
Required : Yes
Description : The name of the zone for this request.
Location : path
Path : projects/{project}/zones/{zone}/targetInstances/{resource}/testIamPermissions
▼ ▲ compute.regionSnapshots.testIamPermissions
Path : projects/{project}/regions/{region}/snapshots/{resource}/testIamPermissions
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])?))
Location : path
Type : string
Description : Project ID for this request.
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
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
Scopes :
Apiversion : 2026-10-01-preview
HTTP Method : POST
Description : Returns permissions that a caller has on the specified resource.
Flat Path : projects/{project}/regions/{region}/snapshots/{resource}/testIamPermissions
▼ ▲ compute.regionSnapshots.get
Path : projects/{project}/regions/{region}/snapshots/{snapshot}
Scopes :
Flat Path : projects/{project}/regions/{region}/snapshots/{snapshot}
Description : Returns the specified Snapshot resource.
HTTP Method : GET
Parameter Order :
Apiversion : 2026-10-01-preview
Parameters :
snapshot
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}
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
Required : Yes
Description : Project ID for this request.
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Description : Name of the region for this request.
Location : path
Type : string
▼ ▲ compute.regionSnapshots.insert
Flat Path : projects/{project}/regions/{region}/snapshots
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
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
region
Description : Name of the region for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Type : string
Location : path
Parameter Order :
Apiversion : 2026-10-01-preview
Path : projects/{project}/regions/{region}/snapshots
HTTP Method : POST
Description : Creates a snapshot in the specified region using the data included in the request.
▼ ▲ compute.regionSnapshots.delete
Flat Path : projects/{project}/regions/{region}/snapshots/{snapshot}
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
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 : The name of the region for this request.
snapshot
Location : path
Required : Yes
Type : string
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}
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-10-01-preview
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.
HTTP Method : DELETE
Parameter Order :
Path : projects/{project}/regions/{region}/snapshots/{snapshot}
▼ ▲ compute.regionSnapshots.setIamPolicy
Apiversion : 2026-10-01-preview
HTTP Method : POST
Flat Path : projects/{project}/regions/{region}/snapshots/{resource}/setIamPolicy
Parameter Order :
Scopes :
Description : Sets the access control policy on the specified resource. Replaces any existing policy.
Path : projects/{project}/regions/{region}/snapshots/{resource}/setIamPolicy
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])?))
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
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
▼ ▲ compute.regionSnapshots.updateKmsKey
Description : Rotates the customer-managed encryption key to the latest version for the specified snapshot.
HTTP Method : POST
Apiversion : 2026-10-01-preview
Scopes :
Path : projects/{project}/regions/{region}/snapshots/{snapshot}/updateKmsKey
Parameter Order :
Flat Path : projects/{project}/regions/{region}/snapshots/{snapshot}/updateKmsKey
Parameters :
region
Required : Yes
Type : string
Description : Name of the region for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
snapshot
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 snapshot resource to update. Should conform to RFC1035.
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])?))
Location : path
Type : string
Description : Project ID for this request.
▼ ▲ compute.regionSnapshots.list
Flat Path : projects/{project}/regions/{region}/snapshots
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
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`)
Minimum : 0
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
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
Type : string
Description : Name of the region for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Required : Yes
Scopes :
Apiversion : 2026-10-01-preview
Description : Retrieves the list of Snapshot resources contained within the specified region.
HTTP Method : GET
Parameter Order :
Path : projects/{project}/regions/{region}/snapshots
▼ ▲ compute.regionSnapshots.getIamPolicy
Description : Gets the access control policy for a resource. May be empty if no such policy or resource exists.
Parameters :
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
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Required : Yes
Description : The 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])?))
Type : string
Location : path
optionsRequestedPolicyVersion
Location : query
Type : integer
Format : int32
Description : Requested IAM Policy version.
Scopes :
Parameter Order :
Path : projects/{project}/regions/{region}/snapshots/{resource}/getIamPolicy
Flat Path : projects/{project}/regions/{region}/snapshots/{resource}/getIamPolicy
Apiversion : 2026-10-01-preview
HTTP Method : GET
▼ ▲ compute.regionSnapshots.setLabels
Parameter Order :
Flat Path : projects/{project}/regions/{region}/snapshots/{resource}/setLabels
Parameters :
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Description : The region for this request.
Required : Yes
Type : string
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
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
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 :
Path : projects/{project}/regions/{region}/snapshots/{resource}/setLabels
Description : Sets the labels on a regional snapshot. To learn more about labels, read the Labeling Resources documentation.
HTTP Method : POST
Apiversion : 2026-10-01-preview
▼ ▲ compute.targetVpnGateways.insert
HTTP Method : POST
Apiversion : 2026-10-01-preview
Scopes :
Parameter Order :
Description : Creates a target VPN gateway in the specified project and region using the data included in the request.
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
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
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Description : Name of the region for this request.
Path : projects/{project}/regions/{region}/targetVpnGateways
Flat Path : projects/{project}/regions/{region}/targetVpnGateways
▼ ▲ compute.targetVpnGateways.delete
Apiversion : 2026-10-01-preview
HTTP Method : DELETE
Description : Deletes the specified target VPN gateway.
Flat Path : projects/{project}/regions/{region}/targetVpnGateways/{targetVpnGateway}
Scopes :
Parameter Order :
Path : projects/{project}/regions/{region}/targetVpnGateways/{targetVpnGateway}
Parameters :
targetVpnGateway
Description : Name of the target VPN gateway to delete.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Required : Yes
Type : string
region
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Description : Name of the region 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).
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])?))
Location : path
Description : Project ID for this request.
▼ ▲ compute.targetVpnGateways.get
Apiversion : 2026-10-01-preview
Scopes :
HTTP Method : GET
Description : Returns the specified target VPN gateway.
Flat Path : projects/{project}/regions/{region}/targetVpnGateways/{targetVpnGateway}
Path : projects/{project}/regions/{region}/targetVpnGateways/{targetVpnGateway}
Parameters :
targetVpnGateway
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Description : Name of the target VPN gateway to return.
Type : string
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
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
Parameter Order :
▼ ▲ compute.targetVpnGateways.aggregatedList
Description : Retrieves an aggregated list of target VPN gateways. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.
Flat Path : projects/{project}/aggregated/targetVpnGateways
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
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
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
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
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
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.
Path : projects/{project}/aggregated/targetVpnGateways
Parameter Order : project
Apiversion : 2026-10-01-preview
HTTP Method : GET
Scopes :
▼ ▲ compute.targetVpnGateways.list
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
maxResults
Minimum : 0
Location : query
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`)
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
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
region
Description : Name of the region for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Type : string
Location : path
Parameter Order :
HTTP Method : GET
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/regions/{region}/targetVpnGateways
Description : Retrieves a list of target VPN gateways available to the specified project and region.
Path : projects/{project}/regions/{region}/targetVpnGateways
▼ ▲ compute.targetVpnGateways.setLabels
Apiversion : 2026-10-01-preview
Description : Sets the labels on a TargetVpnGateway. To learn more about labels, read theLabeling Resources documentation.
HTTP Method : POST
Scopes :
Parameter Order :
Path : projects/{project}/regions/{region}/targetVpnGateways/{resource}/setLabels
Flat Path : projects/{project}/regions/{region}/targetVpnGateways/{resource}/setLabels
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])?))
resource
Required : Yes
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
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
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : The region for this request.
Required : Yes
▼ ▲ compute.regionInstantSnapshots.setLabels
Parameters :
resource
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 or id of the resource 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).
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : The region for this request.
Location : path
Type : string
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
Flat Path : projects/{project}/regions/{region}/instantSnapshots/{resource}/setLabels
Parameter Order :
Scopes :
Description : Sets the labels on a instantSnapshot in the given region. To learn more about labels, read the Labeling Resources documentation.
Path : projects/{project}/regions/{region}/instantSnapshots/{resource}/setLabels
HTTP Method : POST
Apiversion : 2026-10-01-preview
▼ ▲ compute.regionInstantSnapshots.setIamPolicy
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
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}
Required : Yes
region
Description : The name of the region for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Location : path
Type : string
Flat Path : projects/{project}/regions/{region}/instantSnapshots/{resource}/setIamPolicy
Description : Sets the access control policy on the specified resource. Replaces any existing policy.
Scopes :
Parameter Order :
Path : projects/{project}/regions/{region}/instantSnapshots/{resource}/setIamPolicy
Apiversion : 2026-10-01-preview
HTTP Method : POST
▼ ▲ compute.regionInstantSnapshots.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`)
Location : query
Default : 500
Type : integer
Format : uint32
Minimum : 0
region
Location : path
Required : Yes
Description : The name of the region for this request.
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
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.
Location : query
Type : string
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])?))
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
Scopes :
Description : Retrieves the list of InstantSnapshot resources contained within the specified region.
Parameter Order :
Path : projects/{project}/regions/{region}/instantSnapshots
HTTP Method : GET
Flat Path : projects/{project}/regions/{region}/instantSnapshots
Apiversion : 2026-10-01-preview
▼ ▲ compute.regionInstantSnapshots.getIamPolicy
Parameters :
region
Location : path
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : The name of the region for this request.
Type : string
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
optionsRequestedPolicyVersion
Format : int32
Description : Requested IAM Policy version.
Location : query
Type : integer
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.
Flat Path : projects/{project}/regions/{region}/instantSnapshots/{resource}/getIamPolicy
Scopes :
Description : Gets the access control policy for a resource. May be empty if no such policy or resource exists.
Parameter Order :
Path : projects/{project}/regions/{region}/instantSnapshots/{resource}/getIamPolicy
HTTP Method : GET
Apiversion : 2026-10-01-preview
▼ ▲ compute.regionInstantSnapshots.insert
Path : projects/{project}/regions/{region}/instantSnapshots
Parameters :
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])?))
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).
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
Description : Creates an instant snapshot in the specified region.
Scopes :
HTTP Method : POST
Flat Path : projects/{project}/regions/{region}/instantSnapshots
Apiversion : 2026-10-01-preview
Parameter Order :
▼ ▲ compute.regionInstantSnapshots.delete
Parameter Order :
Path : projects/{project}/regions/{region}/instantSnapshots/{instantSnapshot}
Apiversion : 2026-10-01-preview
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.
Scopes :
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
instantSnapshot
Type : string
Required : Yes
Description : Name of the InstantSnapshot 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
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])?
Flat Path : projects/{project}/regions/{region}/instantSnapshots/{instantSnapshot}
▼ ▲ compute.regionInstantSnapshots.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}
Required : Yes
Type : string
Description : Name or id of the resource 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])?))
Location : path
Required : Yes
Type : string
Description : Returns permissions that a caller has on the specified resource.
Scopes :
Parameter Order :
Flat Path : projects/{project}/regions/{region}/instantSnapshots/{resource}/testIamPermissions
Path : projects/{project}/regions/{region}/instantSnapshots/{resource}/testIamPermissions
Apiversion : 2026-10-01-preview
HTTP Method : POST
▼ ▲ compute.regionInstantSnapshots.get
HTTP Method : GET
Apiversion : 2026-10-01-preview
Scopes :
Parameter Order :
Flat Path : projects/{project}/regions/{region}/instantSnapshots/{instantSnapshot}
Parameters :
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
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Description : The name of the region for this request.
Location : path
instantSnapshot
Description : Name of the InstantSnapshot resource to return.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Location : path
Type : string
Path : projects/{project}/regions/{region}/instantSnapshots/{instantSnapshot}
Description : Returns the specified InstantSnapshot resource in the specified region.
▼ ▲ compute.forwardingRules.setLabels
HTTP Method : POST
Scopes :
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/regions/{region}/forwardingRules/{resource}/setLabels
Path : projects/{project}/regions/{region}/forwardingRules/{resource}/setLabels
Description : Sets the labels on the specified resource. To learn more about labels, read the Labeling Resources documentation.
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
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
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])?))
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Description : The region for this request.
Type : string
Required : Yes
Parameter Order :
▼ ▲ compute.forwardingRules.insert
Scopes :
Apiversion : 2026-10-01-preview
HTTP Method : POST
Parameter Order :
Path : projects/{project}/regions/{region}/forwardingRules
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.
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.
Required : Yes
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Flat Path : projects/{project}/regions/{region}/forwardingRules
Description : Creates a ForwardingRule resource in the specified project and region using the data included in the request.
▼ ▲ compute.forwardingRules.delete
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/regions/{region}/forwardingRules/{forwardingRule}
HTTP Method : DELETE
Parameter Order :
Path : projects/{project}/regions/{region}/forwardingRules/{forwardingRule}
Scopes :
Description : Deletes the specified ForwardingRule resource.
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
Description : An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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
forwardingRule
Description : Name of the ForwardingRule resource to delete.
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.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Type : string
Location : path
▼ ▲ compute.forwardingRules.patch
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])?))
Description : Project ID for this request.
Location : path
Required : Yes
Type : string
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Description : Name of the region scoping this request.
Type : string
Location : path
forwardingRule
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 ForwardingRule resource to 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.
Flat Path : projects/{project}/regions/{region}/forwardingRules/{forwardingRule}
Scopes :
Path : projects/{project}/regions/{region}/forwardingRules/{forwardingRule}
Parameter Order :
Apiversion : 2026-10-01-preview
HTTP Method : PATCH
▼ ▲ compute.forwardingRules.setTarget
Apiversion : 2026-10-01-preview
Parameter Order :
Description : Changes target URL for forwarding rule. The new target should be of the same type as the old target.
HTTP Method : POST
Flat Path : projects/{project}/regions/{region}/forwardingRules/{forwardingRule}/setTarget
Path : projects/{project}/regions/{region}/forwardingRules/{forwardingRule}/setTarget
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).
forwardingRule
Type : string
Description : Name of the ForwardingRule resource in which target is to be set.
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.
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
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.
▼ ▲ compute.forwardingRules.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.
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
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.
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
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
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
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
Description : Retrieves an aggregated list of forwarding rules. To prevent failure, it is recommended that you set the `returnPartialSuccess` parameter to `true`.
Flat Path : projects/{project}/aggregated/forwardingRules
Path : projects/{project}/aggregated/forwardingRules
HTTP Method : GET
Parameter Order : project
Apiversion : 2026-10-01-preview
Scopes :
▼ ▲ compute.forwardingRules.get
Parameters :
view
Type : string
Enum :
Enum Descriptions :
Location : query
region
Location : path
Description : Name of the region scoping this request.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
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
forwardingRule
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Description : Name of the ForwardingRule resource to return.
Type : string
Required : Yes
Flat Path : projects/{project}/regions/{region}/forwardingRules/{forwardingRule}
Path : projects/{project}/regions/{region}/forwardingRules/{forwardingRule}
Description : Returns the specified ForwardingRule resource.
Parameter Order :
HTTP Method : GET
Scopes :
Apiversion : 2026-10-01-preview
▼ ▲ compute.forwardingRules.list
Scopes :
Path : projects/{project}/regions/{region}/forwardingRules
Flat Path : projects/{project}/regions/{region}/forwardingRules
Apiversion : 2026-10-01-preview
HTTP Method : GET
Parameter Order :
Parameters :
filter
Description : A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based onresource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using GoogleRE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.
Type : string
Location : query
orderBy
Location : query
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.
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
maxResults
Type : integer
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`)
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 a list of ForwardingRule resources available to the specified project and region.
▼ ▲ compute.vpnGateways.getStatus
Description : Returns the status for the specified VPN gateway.
Path : projects/{project}/regions/{region}/vpnGateways/{vpnGateway}/getStatus
HTTP Method : GET
Apiversion : 2026-10-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])?))
Location : path
Description : Project ID for this request.
region
Location : path
Required : Yes
Type : string
Description : Name of the region for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
vpnGateway
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 VPN gateway to return.
Scopes :
Parameter Order :
Flat Path : projects/{project}/regions/{region}/vpnGateways/{vpnGateway}/getStatus
▼ ▲ compute.vpnGateways.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])?))
Type : string
Location : path
Description : Project ID for this request.
Required : Yes
vpnGateway
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 VPN gateway to return.
Required : Yes
region
Description : Name of the region for this request.
Required : Yes
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Parameter Order :
Scopes :
Flat Path : projects/{project}/regions/{region}/vpnGateways/{vpnGateway}
Path : projects/{project}/regions/{region}/vpnGateways/{vpnGateway}
Description : Returns the specified VPN gateway.
HTTP Method : GET
Apiversion : 2026-10-01-preview
▼ ▲ compute.vpnGateways.aggregatedList
Scopes :
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.
Type : string
Location : query
Format : int64
maxResults
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`)
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.
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.
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
project
Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Required : Yes
Type : string
Description : Project ID for this request.
Location : path
Path : projects/{project}/aggregated/vpnGateways
Description : Retrieves an aggregated list of VPN gateways. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.
HTTP Method : GET
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/aggregated/vpnGateways
Parameter Order : project
▼ ▲ compute.vpnGateways.insert
Description : Creates a VPN gateway in the specified project and region using the data included in the request.
HTTP Method : POST
Apiversion : 2026-10-01-preview
Path : projects/{project}/regions/{region}/vpnGateways
Flat Path : projects/{project}/regions/{region}/vpnGateways
Parameters :
region
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Name of the region for 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
Description : Project ID 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
Scopes :
Parameter Order :
▼ ▲ compute.vpnGateways.delete
Parameters :
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Type : string
Required : Yes
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
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
vpnGateway
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 VPN gateway to delete.
Type : string
Description : Deletes the specified VPN gateway.
Scopes :
Path : projects/{project}/regions/{region}/vpnGateways/{vpnGateway}
Parameter Order :
HTTP Method : DELETE
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/regions/{region}/vpnGateways/{vpnGateway}
▼ ▲ compute.vpnGateways.list
Description : Retrieves a list of VPN gateways available to the specified project and region.
Path : projects/{project}/regions/{region}/vpnGateways
Flat Path : projects/{project}/regions/{region}/vpnGateways
HTTP Method : GET
Parameter Order :
Apiversion : 2026-10-01-preview
Scopes :
Parameters :
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
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
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.
region
Description : Name of the region for this request.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
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.
▼ ▲ compute.vpnGateways.testIamPermissions
Scopes :
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
resource
Type : string
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
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
Description : Returns permissions that a caller has on the specified resource.
Flat Path : projects/{project}/regions/{region}/vpnGateways/{resource}/testIamPermissions
Path : projects/{project}/regions/{region}/vpnGateways/{resource}/testIamPermissions
Parameter Order :
Apiversion : 2026-10-01-preview
HTTP Method : POST
▼ ▲ compute.vpnGateways.setLabels
Description : Sets the labels on a VpnGateway. To learn more about labels, read theLabeling Resources documentation.
Scopes :
HTTP Method : POST
Path : projects/{project}/regions/{region}/vpnGateways/{resource}/setLabels
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/regions/{region}/vpnGateways/{resource}/setLabels
Parameter Order :
Parameters :
region
Location : path
Description : 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])?))
Description : Project ID for this request.
Required : Yes
Type : string
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}
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.diskTypes.list
Parameter Order :
Description : Retrieves a list of disk types available to the specified project.
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.
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
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
Type : integer
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.
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])?
Scopes :
Flat Path : projects/{project}/zones/{zone}/diskTypes
Path : projects/{project}/zones/{zone}/diskTypes
Apiversion : 2026-10-01-preview
HTTP Method : GET
▼ ▲ compute.diskTypes.get
Description : Returns the specified disk type.
Parameter Order :
Path : projects/{project}/zones/{zone}/diskTypes/{diskType}
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.
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])?
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.
Type : string
Location : path
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/zones/{zone}/diskTypes/{diskType}
HTTP Method : GET
Scopes :
▼ ▲ compute.diskTypes.aggregatedList
Description : Retrieves an aggregated list of disk types. To prevent failure, it is recommended that you set the `returnPartialSuccess` parameter to `true`.
Flat Path : projects/{project}/aggregated/diskTypes
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.
maxResults
Format : uint32
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`)
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
serviceProjectNumber
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
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])?))
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.
Location : query
Type : boolean
Parameter Order : project
Apiversion : 2026-10-01-preview
HTTP Method : GET
Path : projects/{project}/aggregated/diskTypes
▼ ▲ compute.regionUrlMaps.update
Scopes :
Parameters :
urlMap
Description : Name of the UrlMap 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
Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-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
requestId
Location : query
Type : string
Description : begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.
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
Path : projects/{project}/regions/{region}/urlMaps/{urlMap}
Flat Path : projects/{project}/regions/{region}/urlMaps/{urlMap}
Parameter Order :
Description : Updates the specified UrlMap resource with the data included in the request.
HTTP Method : PUT
Apiversion : 2026-10-01-preview
▼ ▲ compute.regionUrlMaps.get
Flat Path : projects/{project}/regions/{region}/urlMaps/{urlMap}
Scopes :
Apiversion : 2026-10-01-preview
HTTP Method : GET
Description : Returns the specified UrlMap resource.
Parameters :
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.
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 return.
Required : Yes
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 :
Path : projects/{project}/regions/{region}/urlMaps/{urlMap}
▼ ▲ compute.regionUrlMaps.validate
Apiversion : 2026-10-01-preview
HTTP Method : POST
Flat Path : projects/{project}/regions/{region}/urlMaps/{urlMap}/validate
Scopes :
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.
Parameter Order :
Parameters :
urlMap
Location : path
Description : Name of the UrlMap resource to be validated as.
Type : string
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
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
Location : path
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Description : Name of the region scoping this request.
Path : projects/{project}/regions/{region}/urlMaps/{urlMap}/validate
▼ ▲ compute.regionUrlMaps.patch
Parameter Order :
Parameters :
urlMap
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 UrlMap 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])?))
Type : string
Location : path
Required : Yes
Description : Project ID for this request.
requestId
Description : begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.
Type : string
Location : query
region
Description : Name of the region scoping this request.
Required : Yes
Location : path
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Flat 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.
Apiversion : 2026-10-01-preview
Scopes :
Path : projects/{project}/regions/{region}/urlMaps/{urlMap}
▼ ▲ compute.regionUrlMaps.insert
HTTP Method : POST
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/regions/{region}/urlMaps
Parameter Order :
Description : Creates a UrlMap resource in the specified project using the data included in the request.
Scopes :
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
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
Type : string
Description : begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.
Location : query
Path : projects/{project}/regions/{region}/urlMaps
▼ ▲ compute.regionUrlMaps.delete
Parameters :
urlMap
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}
Type : string
Location : path
Required : Yes
requestId
Type : string
Description : begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.
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
Location : path
Description : Project ID for this request.
Required : Yes
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
Parameter Order :
Flat Path : projects/{project}/regions/{region}/urlMaps/{urlMap}
Path : projects/{project}/regions/{region}/urlMaps/{urlMap}
HTTP Method : DELETE
Scopes :
Apiversion : 2026-10-01-preview
Description : Deletes the specified UrlMap resource.
▼ ▲ compute.regionUrlMaps.list
Apiversion : 2026-10-01-preview
Description : Retrieves the list of UrlMap resources available to the specified project in the specified region.
Flat Path : projects/{project}/regions/{region}/urlMaps
HTTP Method : GET
Parameter Order :
Path : projects/{project}/regions/{region}/urlMaps
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.
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
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`)
Minimum : 0
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
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
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.instanceGroupManagerResizeRequests.insert
Parameter Order :
Parameters :
instanceGroupManager
Location : path
Required : Yes
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.
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
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.
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 :
Flat Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests
Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests
Apiversion : 2026-10-01-preview
HTTP Method : POST
Description : Creates a new resize request that starts provisioning VMs immediately or queues VM creation.
▼ ▲ compute.instanceGroupManagerResizeRequests.delete
Parameters :
instanceGroupManager
Description : The name of the managed instance group. The name should conform to RFC1035 or be a resource ID.
Required : Yes
Type : string
Location : path
resizeRequest
Description : The name of the resize request to delete. The name should conform to RFC1035 or be a resource ID.
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).
zone
Description : The name of thezone where the managed instance group is located. The name should conform to RFC1035.
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
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 :
Flat Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}
HTTP Method : DELETE
Apiversion : 2026-10-01-preview
Scopes :
▼ ▲ compute.instanceGroupManagerResizeRequests.cancel
Parameters :
zone
Type : string
Required : Yes
Location : path
Description : The name of thezone where the managed instance group is located. The name should conform to RFC1035.
project
Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Location : path
Description : Project ID for this request.
Type : string
Required : Yes
instanceGroupManager
Location : path
Required : Yes
Type : string
Description : The name of the managed instance group. The name should conform to RFC1035 or be a resource ID.
resizeRequest
Required : Yes
Location : path
Description : The name of the resize request to cancel. The name should conform to RFC1035 or be a resource ID.
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 : 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.
Flat Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}/cancel
Scopes :
Parameter Order :
Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}/cancel
HTTP Method : POST
Apiversion : 2026-10-01-preview
▼ ▲ compute.instanceGroupManagerResizeRequests.list
Description : Retrieves a list of resize requests that are contained in the managed instance group.
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
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
instanceGroupManager
Description : The name of the managed instance group. The name should conform to RFC1035.
Type : string
Required : Yes
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.
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
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
Location : query
Default : 500
zone
Description : The name of thezone where the managed instance group is located. The name should conform to RFC1035.
Location : path
Required : Yes
Type : string
Apiversion : 2026-10-01-preview
Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests
HTTP Method : GET
Scopes :
Parameter Order :
Flat Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests
▼ ▲ compute.instanceGroupManagerResizeRequests.get
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.
instanceGroupManager
Type : string
Location : path
Required : Yes
Description : The name of the managed instance group. Name should conform to RFC1035 or be a resource ID.
zone
Location : path
Type : string
Required : Yes
Description : Name of the href="/compute/docs/regions-zones/#available">zone scoping this request. Name should conform to RFC1035.
resizeRequest
Type : string
Required : Yes
Location : path
Description : The name of the resize request. Name should conform to RFC1035 or be a resource ID.
Scopes :
Flat Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}
Parameter Order :
Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}
HTTP Method : GET
Description : Returns all of the details about the specified resize request.
Apiversion : 2026-10-01-preview
▼ ▲ compute.instanceSettings.get
Description : Get Instance settings.
HTTP Method : GET
Flat Path : projects/{project}/zones/{zone}/instanceSettings
Apiversion : 2026-10-01-preview
Parameter Order :
Path : projects/{project}/zones/{zone}/instanceSettings
Scopes :
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])?))
zone
Location : path
Description : Name of the zone for this request.
Required : Yes
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
▼ ▲ compute.instanceSettings.patch
Scopes :
Flat Path : projects/{project}/zones/{zone}/instanceSettings
Parameter Order :
Parameters :
zone
Description : The zone scoping this request. It should conform to RFC1035.
Required : Yes
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.
updateMask
Format : google-fieldmask
Description : update_mask indicates fields to be updated as part of this request.
Type : string
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. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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}/instanceSettings
Apiversion : 2026-10-01-preview
Description : Patch Instance settings
HTTP Method : PATCH
▼ ▲ compute.regionNetworkFirewallPolicies.setIamPolicy
Scopes :
Flat Path : projects/{project}/regions/{region}/firewallPolicies/{resource}/setIamPolicy
Description : Sets the access control policy on the specified resource. Replaces any existing policy.
HTTP Method : POST
Parameter Order :
Apiversion : 2026-10-01-preview
Parameters :
region
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Description : The name of the region 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])?))
Description : Project ID for this request.
Required : Yes
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.
Required : Yes
Type : string
Location : path
Path : projects/{project}/regions/{region}/firewallPolicies/{resource}/setIamPolicy
▼ ▲ compute.regionNetworkFirewallPolicies.addRule
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).
minPriority
Location : query
Format : int32
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
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
Description : Name of the region scoping this request.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
maxPriority
Format : int32
Type : integer
Location : query
Description : When rule.priority is not specified, auto choose a unused priority betweenminPriority and maxPriority>. This field is exclusive with rule.priority.
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}
Flat Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/addRule
HTTP Method : POST
Description : Inserts a rule into a network firewall policy.
Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/addRule
Apiversion : 2026-10-01-preview
Scopes :
Parameter Order :
▼ ▲ compute.regionNetworkFirewallPolicies.removeRule
Scopes :
Apiversion : 2026-10-01-preview
HTTP Method : POST
Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/removeRule
Description : Deletes a rule of the specified priority.
Parameter Order :
Flat Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/removeRule
Parameters :
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 update.
Type : string
Location : path
region
Location : path
Type : string
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Name of the region scoping this request.
priority
Description : The priority of the rule to remove from the firewall policy.
Format : int32
Location : query
Type : integer
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.
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.regionNetworkFirewallPolicies.getAssociation
Parameter Order :
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/getAssociation
HTTP Method : GET
Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/getAssociation
Scopes :
Description : Gets an association with the specified name.
Parameters :
firewallPolicy
Description : Name of the firewall policy to which the queried association belongs.
Location : path
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])?
Description : Name of the region scoping this request.
Required : Yes
Type : string
Location : path
name
Description : The name of the association to get from the firewall policy.
Location : query
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
▼ ▲ compute.regionNetworkFirewallPolicies.patchAssociation
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/patchAssociation
HTTP Method : POST
Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/patchAssociation
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
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])?
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).
firewallPolicy
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 firewall policy to update.
Description : Updates an association for the specified network firewall policy.
▼ ▲ compute.regionNetworkFirewallPolicies.delete
Scopes :
Apiversion : 2026-10-01-preview
HTTP Method : DELETE
Flat Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}
Description : Deletes the specified network firewall policy.
Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}
Parameters :
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
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
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
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 :
▼ ▲ compute.regionNetworkFirewallPolicies.getIamPolicy
Scopes :
Flat Path : projects/{project}/regions/{region}/firewallPolicies/{resource}/getIamPolicy
Apiversion : 2026-10-01-preview
HTTP Method : GET
Description : Gets the access control policy for a resource. May be empty if no such policy or resource exists.
Parameter Order :
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
Type : string
Location : path
optionsRequestedPolicyVersion
Format : int32
Location : query
Description : Requested IAM Policy version.
Type : integer
region
Description : The 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
Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-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
Path : projects/{project}/regions/{region}/firewallPolicies/{resource}/getIamPolicy
▼ ▲ compute.regionNetworkFirewallPolicies.patchRule
Parameters :
priority
Description : The priority of the rule to patch.
Location : query
Type : integer
Format : int32
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
Description : Name of the region scoping this request.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
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])?))
firewallPolicy
Description : Name of the firewall policy 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
Parameter Order :
Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/patchRule
Scopes :
Description : Patches a rule of the specified priority.
HTTP Method : POST
Flat Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/patchRule
Apiversion : 2026-10-01-preview
▼ ▲ compute.regionNetworkFirewallPolicies.getEffectiveFirewalls
Scopes :
Description : Returns the effective firewalls on a given network.
Path : projects/{project}/regions/{region}/firewallPolicies/getEffectiveFirewalls
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
network
Location : query
Required : Yes
Type : string
Description : Network reference
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])?))
Flat Path : projects/{project}/regions/{region}/firewallPolicies/getEffectiveFirewalls
HTTP Method : GET
Apiversion : 2026-10-01-preview
Parameter Order :
▼ ▲ compute.regionNetworkFirewallPolicies.removeAssociation
Description : Removes an association for the specified network firewall policy.
Parameter Order :
Parameters :
firewallPolicy
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 firewall policy to update.
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.
Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-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
Description : Name of the region scoping this request.
Location : path
Type : string
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
name
Location : query
Description : Name for the association that will be removed.
Type : string
Flat Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/removeAssociation
HTTP Method : POST
Apiversion : 2026-10-01-preview
Scopes :
Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/removeAssociation
▼ ▲ compute.regionNetworkFirewallPolicies.get
Apiversion : 2026-10-01-preview
HTTP Method : GET
Scopes :
Description : Returns the specified network firewall policy.
Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}
Parameter Order :
Flat Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}
Parameters :
firewallPolicy
Description : Name of the firewall policy to get.
Type : string
Location : path
Required : Yes
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 scoping this request.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
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.regionNetworkFirewallPolicies.testIamPermissions
Parameter Order :
Path : projects/{project}/regions/{region}/firewallPolicies/{resource}/testIamPermissions
Apiversion : 2026-10-01-preview
Description : Returns permissions that a caller has on the specified resource.
Scopes :
HTTP Method : POST
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
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
region
Required : Yes
Type : string
Location : path
Description : The name of the region for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Flat Path : projects/{project}/regions/{region}/firewallPolicies/{resource}/testIamPermissions
▼ ▲ compute.regionNetworkFirewallPolicies.getRule
Parameter Order :
Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/getRule
Scopes :
Description : Gets a rule of the specified priority.
Parameters :
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
Description : Name of the region scoping this request.
Required : Yes
Pattern : [a-z](?:[-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
Type : string
Description : Name of the firewall policy to which the queried rule belongs.
Location : path
priority
Format : int32
Type : integer
Location : query
Description : The priority of the rule to get from the firewall policy.
HTTP Method : GET
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/getRule
▼ ▲ compute.regionNetworkFirewallPolicies.patch
Parameter Order :
Description : Patches the specified network firewall policy.
Parameters :
firewallPolicy
Location : path
Type : string
Description : Name of the firewall policy to update.
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
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
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])?))
Flat Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}
HTTP Method : PATCH
Scopes :
Apiversion : 2026-10-01-preview
Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}
▼ ▲ compute.regionNetworkFirewallPolicies.addAssociation
Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/addAssociation
Scopes :
Parameter Order :
HTTP Method : POST
Apiversion : 2026-10-01-preview
Parameters :
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Location : path
Description : Name of the region scoping this request.
Type : string
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'.
Location : query
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
firewallPolicy
Location : path
Type : string
Description : Name of the firewall policy to update.
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.
Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-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
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).
replaceExistingAssociation
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.
Type : boolean
Location : query
Description : Inserts an association for the specified network firewall policy.
Flat Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/addAssociation
▼ ▲ compute.regionNetworkFirewallPolicies.list
Description : Lists all the network firewall policies that have been configured for the specified project in the given region.
Flat Path : projects/{project}/regions/{region}/firewallPolicies
Parameter Order :
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
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
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
maxResults
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`)
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
Path : projects/{project}/regions/{region}/firewallPolicies
HTTP Method : GET
Apiversion : 2026-10-01-preview
Scopes :
▼ ▲ compute.regionNetworkFirewallPolicies.cloneRules
Scopes :
Parameter Order :
Apiversion : 2026-10-01-preview
HTTP Method : POST
Flat Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/cloneRules
Path : projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/cloneRules
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
Description : The firewall policy from which to copy rules.
Type : string
firewallPolicy
Description : Name of the firewall policy to update.
Required : Yes
Location : path
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
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
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])?
Description : Copies rules to the specified network firewall policy.
▼ ▲ compute.regionNetworkFirewallPolicies.insert
Path : projects/{project}/regions/{region}/firewallPolicies
Parameter Order :
Description : Creates a new network firewall policy in the specified project and region.
Scopes :
Parameters :
region
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Description : Name of the region scoping this request.
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])?))
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-10-01-preview
HTTP Method : POST
Flat Path : projects/{project}/regions/{region}/firewallPolicies
▼ ▲ compute.futureReservations.get
Scopes :
Flat Path : projects/{project}/zones/{zone}/futureReservations/{futureReservation}
Apiversion : 2026-10-01-preview
Parameter Order :
HTTP Method : GET
Path : projects/{project}/zones/{zone}/futureReservations/{futureReservation}
Parameters :
zone
Type : string
Description : Name of the zone for this request. Name should conform to RFC1035.
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])?))
Required : Yes
Type : string
Location : path
futureReservation
Type : string
Description : Name of the future reservation to retrieve. Name should conform to RFC1035.
Location : path
Required : Yes
Description : Retrieves information about the specified future reservation.
▼ ▲ compute.futureReservations.update
HTTP Method : PATCH
Path : projects/{project}/zones/{zone}/futureReservations/{futureReservation}
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/zones/{zone}/futureReservations/{futureReservation}
Parameter Order :
Description : Updates the specified future reservation.
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])?))
updateMask
Type : string
Location : query
Description : update_mask indicates fields to be updated as part of this request.
Format : google-fieldmask
futureReservation
Description : Name of the reservation to update. Name should conform to RFC1035.
Location : path
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
zone
Required : Yes
Location : path
Type : string
Description : Name of the zone for this request. Name should conform to RFC1035.
Scopes :
▼ ▲ compute.futureReservations.insert
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.
Required : Yes
Type : string
requestId
Location : query
Type : string
Description : An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
zone
Description : Name of the zone for this request. Name should conform to RFC1035.
Type : string
Location : path
Required : Yes
Path : projects/{project}/zones/{zone}/futureReservations
Flat Path : projects/{project}/zones/{zone}/futureReservations
Scopes :
Apiversion : 2026-10-01-preview
HTTP Method : POST
Description : Creates a new Future Reservation.
▼ ▲ compute.futureReservations.delete
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.
zone
Required : Yes
Type : string
Location : path
Description : Name of the zone for this request. Name should conform to RFC1035.
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.
Required : Yes
Type : string
Location : path
Path : projects/{project}/zones/{zone}/futureReservations/{futureReservation}
Description : Deletes the specified future reservation.
Scopes :
Parameter Order :
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/zones/{zone}/futureReservations/{futureReservation}
HTTP Method : DELETE
▼ ▲ compute.futureReservations.aggregatedList
Scopes :
HTTP Method : GET
Flat Path : projects/{project}/aggregated/futureReservations
Apiversion : 2026-10-01-preview
Description : Retrieves an aggregated list of future reservations. To prevent failure, it is recommended that you set the `returnPartialSuccess` parameter to `true`.
Path : projects/{project}/aggregated/futureReservations
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
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
Default : 500
Type : integer
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
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
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.
Location : query
Type : string
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.
Parameter Order : project
▼ ▲ compute.futureReservations.cancel
Description : Cancel the specified future reservation.
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).
Type : string
Location : query
zone
Required : Yes
Location : path
Type : string
Description : Name of the zone for this request. Name should conform to RFC1035.
futureReservation
Location : path
Required : Yes
Type : string
Description : Name of the future reservation to retrieve. Name should conform to RFC1035.
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
Apiversion : 2026-10-01-preview
Path : projects/{project}/zones/{zone}/futureReservations/{futureReservation}/cancel
HTTP Method : POST
Flat Path : projects/{project}/zones/{zone}/futureReservations/{futureReservation}/cancel
▼ ▲ compute.futureReservations.list
Parameters :
maxResults
Minimum : 0
Type : integer
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`)
Format : uint32
zone
Required : Yes
Description : Name of the zone for this request. Name should conform to RFC1035.
Location : path
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
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
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
Flat Path : projects/{project}/zones/{zone}/futureReservations
Parameter Order :
Scopes :
Description : A list of all the future reservations that have been configured for the specified project in specified zone.
Path : projects/{project}/zones/{zone}/futureReservations
HTTP Method : GET
Apiversion : 2026-10-01-preview
▼ ▲ compute.storagePoolTypes.list
Parameter Order :
Scopes :
Path : projects/{project}/zones/{zone}/storagePoolTypes
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
Type : integer
Minimum : 0
Format : uint32
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`)
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
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
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
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])?))
Description : Project ID for this request.
Type : string
Description : Retrieves a list of storage pool types available to the specified project.
Flat Path : projects/{project}/zones/{zone}/storagePoolTypes
Apiversion : 2026-10-01-preview
HTTP Method : GET
▼ ▲ compute.storagePoolTypes.get
Parameters :
zone
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : The name of the zone for this request.
Location : path
Required : Yes
storagePoolType
Required : Yes
Type : string
Description : Name of the storage pool type to return.
Location : path
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
Path : projects/{project}/zones/{zone}/storagePoolTypes/{storagePoolType}
Flat Path : projects/{project}/zones/{zone}/storagePoolTypes/{storagePoolType}
HTTP Method : GET
Scopes :
Apiversion : 2026-10-01-preview
Parameter Order :
Description : Returns the specified storage pool type.
▼ ▲ compute.storagePoolTypes.aggregatedList
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
Parameters :
serviceProjectNumber
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
Format : int64
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
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
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 : 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
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 :
HTTP Method : GET
Apiversion : 2026-10-01-preview
Path : projects/{project}/aggregated/storagePoolTypes
Parameter Order : project
▼ ▲ compute.regionZones.list
Description : Retrieves the list of Zone resources under the specific region available to the specified project.
Path : projects/{project}/regions/{region}/zones
Scopes :
Flat Path : projects/{project}/regions/{region}/zones
Parameters :
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`)
Type : integer
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])?))
Location : path
Description : Project ID for this request.
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
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
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Region for this request.
Location : path
Type : string
Required : Yes
Apiversion : 2026-10-01-preview
HTTP Method : GET
Parameter Order :
▼ ▲ compute.rolloutPlans.insert
Apiversion : 2026-10-01-preview
Path : projects/{project}/global/rolloutPlans
Scopes :
Description : Creates a new RolloutPlan in a given project and location.
HTTP Method : POST
Flat Path : projects/{project}/global/rolloutPlans
Parameter Order : project
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.
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
▼ ▲ compute.rolloutPlans.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).
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
rolloutPlan
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 RolloutPlan resource to delete.
Description : Deletes a RolloutPlan.
Path : projects/{project}/global/rolloutPlans/{rolloutPlan}
Flat Path : projects/{project}/global/rolloutPlans/{rolloutPlan}
Parameter Order :
Scopes :
HTTP Method : DELETE
Apiversion : 2026-10-01-preview
▼ ▲ compute.rolloutPlans.list
Description : Lists RolloutPlans in a given project and location.
Path : projects/{project}/global/rolloutPlans
Flat Path : projects/{project}/global/rolloutPlans
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
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
maxResults
Type : integer
Location : query
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`)
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
HTTP Method : GET
Apiversion : 2026-10-01-preview
Parameter Order : project
Scopes :
▼ ▲ compute.rolloutPlans.get
Path : projects/{project}/global/rolloutPlans/{rolloutPlan}
Scopes :
HTTP Method : GET
Flat Path : projects/{project}/global/rolloutPlans/{rolloutPlan}
Apiversion : 2026-10-01-preview
Parameter Order :
Parameters :
rolloutPlan
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 persistent rollout plan to return.
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])?))
Description : Gets details of a single project-scoped RolloutPlan.
▼ ▲ compute.regionInstanceGroups.get
Parameters :
region
Description : Name of the region scoping this request.
Type : string
Required : Yes
Location : path
instanceGroup
Type : string
Description : Name of the instance group resource to return.
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])?))
Description : Project ID for this request.
Required : Yes
Type : string
Parameter Order :
Flat Path : projects/{project}/regions/{region}/instanceGroups/{instanceGroup}
Scopes :
HTTP Method : GET
Path : projects/{project}/regions/{region}/instanceGroups/{instanceGroup}
Description : Returns the specified instance group resource.
Apiversion : 2026-10-01-preview
▼ ▲ compute.regionInstanceGroups.list
Description : Retrieves the list of instance group resources contained within the specified region.
Path : projects/{project}/regions/{region}/instanceGroups
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
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
Location : path
Description : Name of the region scoping this request.
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.
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
Default : 500
Format : uint32
Minimum : 0
Type : integer
Flat Path : projects/{project}/regions/{region}/instanceGroups
Parameter Order :
Scopes :
HTTP Method : GET
Apiversion : 2026-10-01-preview
▼ ▲ compute.regionInstanceGroups.listInstances
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.
Path : projects/{project}/regions/{region}/instanceGroups/{instanceGroup}/listInstances
Scopes :
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
instanceGroup
Description : Name of the regional instance group for which we want to list the instances.
Location : path
Required : Yes
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
Type : integer
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
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
Description : Name of the region scoping this request.
Type : string
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])?))
Location : path
Type : string
Description : Project ID for this request.
Required : Yes
Parameter Order :
Flat Path : projects/{project}/regions/{region}/instanceGroups/{instanceGroup}/listInstances
HTTP Method : POST
Apiversion : 2026-10-01-preview
▼ ▲ compute.regionInstanceGroups.testIamPermissions
Flat Path : projects/{project}/regions/{region}/instanceGroups/{resource}/testIamPermissions
Parameters :
resource
Description : Name or id of the resource for this request.
Required : Yes
Location : path
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
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.
project
Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Location : path
Required : Yes
Type : string
Description : Project ID for this request.
Parameter Order :
Path : projects/{project}/regions/{region}/instanceGroups/{resource}/testIamPermissions
Apiversion : 2026-10-01-preview
HTTP Method : POST
Description : Returns permissions that a caller has on the specified resource.
Scopes :
▼ ▲ compute.regionInstanceGroups.setNamedPorts
Scopes :
HTTP Method : POST
Apiversion : 2026-10-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
Location : path
Description : Name of the region scoping this request.
Required : Yes
Type : string
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.
instanceGroup
Required : Yes
Location : path
Type : string
Description : The name of the regional instance group where the named ports are updated.
Parameter Order :
Path : projects/{project}/regions/{region}/instanceGroups/{instanceGroup}/setNamedPorts
Description : Sets the named ports for the specified regional instance group.
Flat Path : projects/{project}/regions/{region}/instanceGroups/{instanceGroup}/setNamedPorts
▼ ▲ compute.regionHealthAggregationPolicies.list
Flat Path : projects/{project}/regions/{region}/healthAggregationPolicies
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
region
Location : path
Description : Name of the region scoping this request.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
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`)
Location : query
Type : integer
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.
Location : path
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
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.
Scopes :
HTTP Method : GET
Description : Lists the HealthAggregationPolicies for a project in the given region.
Path : projects/{project}/regions/{region}/healthAggregationPolicies
Apiversion : 2026-10-01-preview
Parameter Order :
▼ ▲ compute.regionHealthAggregationPolicies.get
Parameter Order :
Apiversion : 2026-10-01-preview
HTTP Method : GET
Description : Returns the specified HealthAggregationPolicy resource in the given region.
Scopes :
Parameters :
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Required : Yes
Description : Name of the region scoping this request.
Location : path
healthAggregationPolicy
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 HealthAggregationPolicy resource to return.
Type : string
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
Path : projects/{project}/regions/{region}/healthAggregationPolicies/{healthAggregationPolicy}
Flat Path : projects/{project}/regions/{region}/healthAggregationPolicies/{healthAggregationPolicy}
▼ ▲ compute.regionHealthAggregationPolicies.insert
Parameter Order :
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.
Scopes :
Apiversion : 2026-10-01-preview
HTTP Method : POST
Path : projects/{project}/regions/{region}/healthAggregationPolicies
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 scoping this request.
Type : string
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])?))
Type : string
Location : path
Description : Project ID for this request.
▼ ▲ compute.regionHealthAggregationPolicies.delete
Description : Deletes the specified HealthAggregationPolicy in the given region.
Parameters :
healthAggregationPolicy
Location : path
Description : Name of the HealthAggregationPolicy resource to delete.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
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
Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-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
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Name of the region scoping this request.
Location : path
Type : string
Path : projects/{project}/regions/{region}/healthAggregationPolicies/{healthAggregationPolicy}
Parameter Order :
Flat Path : projects/{project}/regions/{region}/healthAggregationPolicies/{healthAggregationPolicy}
HTTP Method : DELETE
Apiversion : 2026-10-01-preview
Scopes :
▼ ▲ compute.regionHealthAggregationPolicies.testIamPermissions
HTTP Method : POST
Apiversion : 2026-10-01-preview
Scopes :
Path : projects/{project}/regions/{region}/healthAggregationPolicies/{resource}/testIamPermissions
Flat Path : projects/{project}/regions/{region}/healthAggregationPolicies/{resource}/testIamPermissions
Description : Returns permissions that a caller has on the specified resource.
Parameters :
region
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Required : Yes
Description : The name of the region for this request.
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
Description : Name or id of the resource for this request.
Required : Yes
Location : path
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Parameter Order :
▼ ▲ compute.regionHealthAggregationPolicies.aggregatedList
Parameter Order : project
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
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
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
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
Format : uint32
Location : query
Default : 500
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
Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-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.
Required : Yes
Location : path
Scopes :
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`.
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/aggregated/healthAggregationPolicies
Path : projects/{project}/aggregated/healthAggregationPolicies
HTTP Method : GET
▼ ▲ compute.regionHealthAggregationPolicies.patch
Scopes :
Flat Path : projects/{project}/regions/{region}/healthAggregationPolicies/{healthAggregationPolicy}
HTTP Method : PATCH
Apiversion : 2026-10-01-preview
Path : projects/{project}/regions/{region}/healthAggregationPolicies/{healthAggregationPolicy}
Parameters :
healthAggregationPolicy
Required : Yes
Type : string
Description : Name of the HealthAggregationPolicy to update. The name must be 1-63 characters long, and comply with RFC1035.
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
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])?))
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
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.
Parameter Order :
▼ ▲ compute.zones.list
HTTP Method : GET
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/zones
Scopes :
Description : Retrieves the list of Zone resources available to the specified project.
Path : projects/{project}/zones
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
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
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
Minimum : 0
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`)
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
Parameter Order : project
▼ ▲ compute.zones.get
Parameter Order :
Scopes :
Parameters :
zone
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 zone resource to return.
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 : Returns the specified Zone resource.
HTTP Method : GET
Path : projects/{project}/zones/{zone}
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/zones/{zone}
▼ ▲ compute.licenseCodes.testIamPermissions
HTTP Method : POST
Parameter Order :
Apiversion : 2026-10-01-preview
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 :
Path : projects/{project}/global/licenseCodes/{resource}/testIamPermissions
Flat Path : projects/{project}/global/licenseCodes/{resource}/testIamPermissions
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
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.licenseCodes.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 :
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
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 :
Parameter Order :
Path : projects/{project}/global/licenseCodes/{resource}/setIamPolicy
Flat Path : projects/{project}/global/licenseCodes/{resource}/setIamPolicy
HTTP Method : POST
Apiversion : 2026-10-01-preview
▼ ▲ compute.licenseCodes.getIamPolicy
Parameter Order :
Scopes :
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.
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
Format : int32
Type : integer
Description : Requested IAM Policy version.
Location : query
Flat Path : projects/{project}/global/licenseCodes/{resource}/getIamPolicy
HTTP Method : GET
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.
Apiversion : 2026-10-01-preview
Path : projects/{project}/global/licenseCodes/{resource}/getIamPolicy
▼ ▲ compute.licenseCodes.get
Apiversion : 2026-10-01-preview
HTTP Method : GET
Scopes :
Parameter Order :
Path : projects/{project}/global/licenseCodes/{licenseCode}
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.
Flat Path : projects/{project}/global/licenseCodes/{licenseCode}
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
licenseCode
Pattern : [0-9]{0,61}?
Description : Number corresponding to the License code resource to return.
Required : Yes
Type : string
Location : path
▼ ▲ compute.globalFrontendSettings.get
Parameters :
project
Required : Yes
Description : Required. Project ID for this request.
Location : path
Type : string
Parameter Order : project
Scopes :
Description : Gets the Global Frontend Billing Bundle Settings for a project.
Path : projects/{project}/global/globalFrontendSettings
Flat Path : projects/{project}/global/globalFrontendSettings
HTTP Method : GET
Apiversion : 2026-10-01-preview
▼ ▲ compute.globalFrontendSettings.patch
Apiversion : 2026-10-01-preview
HTTP Method : PATCH
Scopes :
Description : Updates the Global Frontend Billing Bundle Settings for a project.
Path : projects/{project}/global/globalFrontendSettings
Parameters :
project
Description : Required. Project ID for this request.
Type : string
Location : path
Required : Yes
requestId
Description : An optional request ID to identify requests.
Location : query
Type : string
updateMask
Location : query
Description : Field mask to support patch. E.g., "type".
Type : string
Format : google-fieldmask
Flat Path : projects/{project}/global/globalFrontendSettings
Parameter Order : project
▼ ▲ compute.nodeTemplates.getIamPolicy
Apiversion : 2026-10-01-preview
HTTP Method : GET
Path : projects/{project}/regions/{region}/nodeTemplates/{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}/regions/{region}/nodeTemplates/{resource}/getIamPolicy
Scopes :
Parameter Order :
Parameters :
optionsRequestedPolicyVersion
Description : Requested IAM Policy version.
Location : query
Type : integer
Format : int32
region
Description : The 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])?))
Type : string
Location : path
Required : Yes
Description : Project ID for this request.
resource
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 or id of the resource for this request.
▼ ▲ compute.nodeTemplates.get
Scopes :
Apiversion : 2026-10-01-preview
HTTP Method : GET
Flat Path : projects/{project}/regions/{region}/nodeTemplates/{nodeTemplate}
Parameter Order :
Parameters :
nodeTemplate
Location : path
Description : Name of the node template to return.
Type : string
Required : Yes
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.
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])?))
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Location : path
Required : Yes
Description : The name of the region for this request.
Description : Returns the specified node template.
Path : projects/{project}/regions/{region}/nodeTemplates/{nodeTemplate}
▼ ▲ compute.nodeTemplates.testIamPermissions
Flat Path : projects/{project}/regions/{region}/nodeTemplates/{resource}/testIamPermissions
Path : projects/{project}/regions/{region}/nodeTemplates/{resource}/testIamPermissions
HTTP Method : POST
Scopes :
Apiversion : 2026-10-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
Description : Project ID for this request.
Required : Yes
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Description : The name of the region for this request.
Type : string
Location : path
Parameter Order :
Description : Returns permissions that a caller has on the specified resource.
▼ ▲ compute.nodeTemplates.aggregatedList
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`.
HTTP Method : GET
Apiversion : 2026-10-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.
Type : string
Location : query
Format : int64
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])?))
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
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
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
Location : query
Format : uint32
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
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
Scopes :
Flat Path : projects/{project}/aggregated/nodeTemplates
Parameter Order : project
▼ ▲ compute.nodeTemplates.list
Parameter Order :
Description : Retrieves a list of node templates available to the specified project.
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
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
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
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
maxResults
Format : uint32
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`)
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])?))
Required : Yes
Description : Project ID for this request.
Location : path
HTTP Method : GET
Flat Path : projects/{project}/regions/{region}/nodeTemplates
Path : projects/{project}/regions/{region}/nodeTemplates
Apiversion : 2026-10-01-preview
Scopes :
▼ ▲ compute.nodeTemplates.insert
Scopes :
Description : Creates a NodeTemplate resource in the specified project using the data included in the request.
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])?))
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 : The name of the region for this request.
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Path : projects/{project}/regions/{region}/nodeTemplates
Parameter Order :
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/regions/{region}/nodeTemplates
HTTP Method : POST
▼ ▲ compute.nodeTemplates.delete
Description : Deletes the specified NodeTemplate resource.
Flat Path : projects/{project}/regions/{region}/nodeTemplates/{nodeTemplate}
Parameter Order :
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
Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-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
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])?
nodeTemplate
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 NodeTemplate resource to delete.
Required : Yes
HTTP Method : DELETE
Path : projects/{project}/regions/{region}/nodeTemplates/{nodeTemplate}
Apiversion : 2026-10-01-preview
▼ ▲ compute.nodeTemplates.setIamPolicy
Parameter Order :
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.
Location : path
Required : Yes
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 : The name of the region for this request.
Type : string
Location : path
Description : Sets the access control policy on the specified resource. Replaces any existing policy.
Scopes :
Flat Path : projects/{project}/regions/{region}/nodeTemplates/{resource}/setIamPolicy
HTTP Method : POST
Path : projects/{project}/regions/{region}/nodeTemplates/{resource}/setIamPolicy
Apiversion : 2026-10-01-preview
▼ ▲ compute.regionTargetTcpProxies.list
HTTP Method : GET
Scopes :
Apiversion : 2026-10-01-preview
Path : projects/{project}/regions/{region}/targetTcpProxies
Flat Path : projects/{project}/regions/{region}/targetTcpProxies
Description : Retrieves a list of TargetTcpProxy resources available to the specified project in a given region.
Parameters :
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
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
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`)
Format : uint32
Default : 500
Type : integer
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.
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
Parameter Order :
▼ ▲ compute.regionTargetTcpProxies.insert
Parameter Order :
Scopes :
Apiversion : 2026-10-01-preview
HTTP Method : POST
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])?))
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
Flat Path : projects/{project}/regions/{region}/targetTcpProxies
Path : projects/{project}/regions/{region}/targetTcpProxies
Description : Creates a TargetTcpProxy resource in the specified project and region using the data included in the request.
▼ ▲ compute.regionTargetTcpProxies.delete
Parameters :
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
targetTcpProxy
Location : path
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
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
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}/regions/{region}/targetTcpProxies/{targetTcpProxy}
HTTP Method : DELETE
Scopes :
Apiversion : 2026-10-01-preview
Path : projects/{project}/regions/{region}/targetTcpProxies/{targetTcpProxy}
Parameter Order :
Description : Deletes the specified TargetTcpProxy resource.
▼ ▲ compute.regionTargetTcpProxies.get
HTTP Method : GET
Apiversion : 2026-10-01-preview
Description : Returns the specified TargetTcpProxy resource.
Scopes :
Parameter Order :
Flat Path : projects/{project}/regions/{region}/targetTcpProxies/{targetTcpProxy}
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
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
targetTcpProxy
Description : Name of the TargetTcpProxy resource to return.
Required : Yes
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Path : projects/{project}/regions/{region}/targetTcpProxies/{targetTcpProxy}
▼ ▲ compute.regionInstances.bulkInsert
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/regions/{region}/instances/bulkInsert
Scopes :
HTTP Method : POST
Parameters :
region
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Type : string
Description : The name of the region 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
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
Path : projects/{project}/regions/{region}/instances/bulkInsert
Description : Creates multiple instances in a given region. Count specifies the number of instances to create.
Parameter Order :
▼ ▲ compute.licenses.testIamPermissions
Flat Path : projects/{project}/global/licenses/{resource}/testIamPermissions
Scopes :
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
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
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
Apiversion : 2026-10-01-preview
Parameter Order :
Path : projects/{project}/global/licenses/{resource}/testIamPermissions
▼ ▲ compute.licenses.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
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])?))
license
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the license resource to delete.
Required : Yes
Type : string
Scopes :
Apiversion : 2026-10-01-preview
Parameter Order :
HTTP Method : DELETE
Path : projects/{project}/global/licenses/{license}
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}
▼ ▲ compute.licenses.insert
Scopes :
Apiversion : 2026-10-01-preview
HTTP Method : POST
Flat Path : projects/{project}/global/licenses
Parameter Order : project
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.
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.
Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-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
▼ ▲ compute.licenses.setIamPolicy
Apiversion : 2026-10-01-preview
Parameter Order :
HTTP Method : POST
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.
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}
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
▼ ▲ compute.licenses.getIamPolicy
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.
Path : projects/{project}/global/licenses/{resource}/getIamPolicy
Flat Path : projects/{project}/global/licenses/{resource}/getIamPolicy
Parameters :
optionsRequestedPolicyVersion
Type : integer
Description : Requested IAM Policy version.
Location : query
Format : int32
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
resource
Description : Name or id of the resource for this request.
Required : Yes
Location : path
Type : string
Pattern : [a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Scopes :
Parameter Order :
HTTP Method : GET
Apiversion : 2026-10-01-preview
▼ ▲ compute.licenses.list
Flat Path : projects/{project}/global/licenses
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.
HTTP Method : GET
Path : projects/{project}/global/licenses
Apiversion : 2026-10-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
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
Format : uint32
Location : query
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.
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])?))
Type : string
Location : path
Description : Project ID for this request.
Parameter Order : project
Scopes :
▼ ▲ compute.licenses.update
Flat Path : projects/{project}/global/licenses/{license}
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
updateMask
Type : string
Format : google-fieldmask
Description : update_mask indicates fields to be updated as part of this request.
Location : query
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])?))
license
Description : The license 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
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
Scopes :
Apiversion : 2026-10-01-preview
▼ ▲ compute.licenses.get
Apiversion : 2026-10-01-preview
Description : Returns the specified License resource. *Caution* This resource is intended for use only by third-party partners who are creatingCloud Marketplace images.
HTTP Method : GET
Flat Path : projects/{project}/global/licenses/{license}
Parameter Order :
Parameters :
license
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 License resource to return.
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
Path : projects/{project}/global/licenses/{license}
Scopes :
▼ ▲ compute.backendServices.getIamPolicy
Parameters :
optionsRequestedPolicyVersion
Location : query
Description : Requested IAM Policy version.
Format : int32
Type : integer
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])?))
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/backendServices/{resource}/getIamPolicy
Scopes :
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}/global/backendServices/{resource}/getIamPolicy
Apiversion : 2026-10-01-preview
HTTP Method : GET
▼ ▲ compute.backendServices.listUsable
Parameter Order : project
Apiversion : 2026-10-01-preview
HTTP Method : GET
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.
Scopes :
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
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
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
Type : integer
Format : uint32
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
Flat Path : projects/{project}/global/backendServices/listUsable
Path : projects/{project}/global/backendServices/listUsable
▼ ▲ compute.backendServices.get
Description : Returns the specified BackendService resource.
HTTP Method : GET
Parameter Order :
Scopes :
Apiversion : 2026-10-01-preview
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
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 return.
Path : projects/{project}/global/backendServices/{backendService}
Flat Path : projects/{project}/global/backendServices/{backendService}
▼ ▲ compute.backendServices.testIamPermissions
Scopes :
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])?))
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
Flat Path : projects/{project}/global/backendServices/{resource}/testIamPermissions
Description : Returns permissions that a caller has on the specified resource.
Apiversion : 2026-10-01-preview
Path : projects/{project}/global/backendServices/{resource}/testIamPermissions
HTTP Method : POST
▼ ▲ compute.backendServices.insert
Apiversion : 2026-10-01-preview
Scopes :
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.
Parameter Order : project
Path : projects/{project}/global/backendServices
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
Description : Project ID for this request.
Location : path
▼ ▲ compute.backendServices.setSecurityPolicy
Path : projects/{project}/global/backendServices/{backendService}/setSecurityPolicy
Apiversion : 2026-10-01-preview
HTTP Method : POST
Parameter Order :
Flat Path : projects/{project}/global/backendServices/{backendService}/setSecurityPolicy
Scopes :
Description : Sets the Google Cloud Armor security policy for the specified backend service. For more information, seeGoogle Cloud Armor Overview
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
backendService
Required : Yes
Location : path
Type : string
Description : Name of the BackendService resource to which the security policy should be set. The name should conform to RFC1035.
▼ ▲ compute.backendServices.patch
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])?))
Location : path
Type : string
Description : Project ID for this request.
Required : Yes
backendService
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 patch.
Type : string
Required : Yes
Parameter Order :
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.
Path : projects/{project}/global/backendServices/{backendService}
HTTP Method : PATCH
Scopes :
Flat Path : projects/{project}/global/backendServices/{backendService}
Apiversion : 2026-10-01-preview
▼ ▲ compute.backendServices.getEffectiveSecurityPolicies
Flat Path : projects/{project}/global/backendServices/{backendService}/getEffectiveSecurityPolicies
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])?))
Type : string
Location : path
Description : Project ID for this request.
Required : Yes
backendService
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Description : Name of the Backend Service for this request.
Location : path
Path : projects/{project}/global/backendServices/{backendService}/getEffectiveSecurityPolicies
Apiversion : 2026-10-01-preview
Description : Returns effective security policies applied to this backend service.
Scopes :
HTTP Method : GET
▼ ▲ compute.backendServices.deleteSignedUrlKey
Description : Deletes a key for validating requests with signed URLs for this backend service.
HTTP Method : POST
Path : projects/{project}/global/backendServices/{backendService}/deleteSignedUrlKey
Parameter Order :
Flat Path : projects/{project}/global/backendServices/{backendService}/deleteSignedUrlKey
Scopes :
Apiversion : 2026-10-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
keyName
Description : The name of the Signed URL Key to delete.
Location : query
Required : Yes
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
backendService
Type : string
Required : Yes
Location : path
Description : Name of the BackendService resource to which the Signed URL Key should be added. The name should conform to RFC1035.
▼ ▲ compute.backendServices.delete
Path : projects/{project}/global/backendServices/{backendService}
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
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])?))
backendService
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Location : path
Required : Yes
Description : Name of the BackendService resource to delete.
Description : Deletes the specified BackendService resource.
Scopes :
Flat Path : projects/{project}/global/backendServices/{backendService}
Apiversion : 2026-10-01-preview
HTTP Method : DELETE
Parameter Order :
▼ ▲ compute.backendServices.setEdgeSecurityPolicy
Flat Path : projects/{project}/global/backendServices/{backendService}/setEdgeSecurityPolicy
Path : projects/{project}/global/backendServices/{backendService}/setEdgeSecurityPolicy
Apiversion : 2026-10-01-preview
HTTP Method : POST
Parameter Order :
Description : Sets the edge security policy for the specified backend service.
Parameters :
backendService
Type : string
Required : Yes
Description : Name of the BackendService resource to which the edge security policy should be set. The name should conform to RFC1035.
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
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
Scopes :
▼ ▲ compute.backendServices.setIamPolicy
Apiversion : 2026-10-01-preview
HTTP Method : POST
Parameters :
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
Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-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
Description : Sets the access control policy on the specified resource. Replaces any existing policy.
Flat Path : projects/{project}/global/backendServices/{resource}/setIamPolicy
Path : projects/{project}/global/backendServices/{resource}/setIamPolicy
Parameter Order :
Scopes :
▼ ▲ compute.backendServices.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.
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
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
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.
maxResults
Format : uint32
Type : integer
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
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 : Name of the project scoping this request.
Required : Yes
Type : string
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`.
Flat Path : projects/{project}/aggregated/backendServices
Scopes :
Path : projects/{project}/aggregated/backendServices
HTTP Method : GET
Parameter Order : project
Apiversion : 2026-10-01-preview
▼ ▲ compute.backendServices.getHealth
Path : projects/{project}/global/backendServices/{backendService}/getHealth
Flat Path : projects/{project}/global/backendServices/{backendService}/getHealth
HTTP Method : POST
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-10-01-preview
Scopes :
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
backendService
Location : path
Type : string
Description : Name of the BackendService resource to which the queried instance belongs.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Parameter Order :
▼ ▲ compute.backendServices.addSignedUrlKey
Flat Path : projects/{project}/global/backendServices/{backendService}/addSignedUrlKey
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).
Type : string
Location : query
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
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.
HTTP Method : POST
Description : Adds a key for validating requests with signed URLs for this backend service.
Apiversion : 2026-10-01-preview
Path : projects/{project}/global/backendServices/{backendService}/addSignedUrlKey
▼ ▲ compute.backendServices.update
HTTP Method : PUT
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/global/backendServices/{backendService}
Parameters :
backendService
Location : path
Type : string
Description : Name of the BackendService resource to update.
Required : Yes
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.
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 :
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.
Scopes :
▼ ▲ compute.backendServices.list
Scopes :
Flat Path : projects/{project}/global/backendServices
Path : projects/{project}/global/backendServices
Apiversion : 2026-10-01-preview
Parameter Order : project
HTTP Method : GET
Description : Retrieves the list of BackendService resources available to the specified project.
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
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])?))
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
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
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
Location : query
▼ ▲ compute.regionCompositeHealthChecks.testIamPermissions
Description : Returns permissions that a caller has on the specified resource.
Parameter Order :
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}
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
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 : POST
Flat Path : projects/{project}/regions/{region}/compositeHealthChecks/{resource}/testIamPermissions
Apiversion : 2026-10-01-preview
Path : projects/{project}/regions/{region}/compositeHealthChecks/{resource}/testIamPermissions
Scopes :
▼ ▲ compute.regionCompositeHealthChecks.insert
Apiversion : 2026-10-01-preview
Parameter Order :
Flat Path : projects/{project}/regions/{region}/compositeHealthChecks
HTTP Method : POST
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
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).
Location : query
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
Path : projects/{project}/regions/{region}/compositeHealthChecks
Description : Create a CompositeHealthCheck in the specified project in the given region using the parameters that are included in the request.
▼ ▲ compute.regionCompositeHealthChecks.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
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
compositeHealthCheck
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 CompositeHealthCheck resource to delete.
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
Scopes :
Flat Path : projects/{project}/regions/{region}/compositeHealthChecks/{compositeHealthCheck}
Parameter Order :
Description : Deletes the specified CompositeHealthCheck in the given region
Path : projects/{project}/regions/{region}/compositeHealthChecks/{compositeHealthCheck}
Apiversion : 2026-10-01-preview
HTTP Method : DELETE
▼ ▲ compute.regionCompositeHealthChecks.patch
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
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
compositeHealthCheck
Description : Name of the CompositeHealthCheck to update. The name must be 1-63 characters long, and comply with RFC1035.
Location : path
Type : string
Required : Yes
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
Flat Path : projects/{project}/regions/{region}/compositeHealthChecks/{compositeHealthCheck}
Parameter Order :
Path : projects/{project}/regions/{region}/compositeHealthChecks/{compositeHealthCheck}
HTTP Method : PATCH
Apiversion : 2026-10-01-preview
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.
Scopes :
▼ ▲ compute.regionCompositeHealthChecks.list
Description : Lists the CompositeHealthChecks for a project in the given region.
Scopes :
Flat Path : projects/{project}/regions/{region}/compositeHealthChecks
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
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
region
Type : string
Description : Name of the region scoping this request.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
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
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
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-10-01-preview
Parameter Order :
HTTP Method : GET
Path : projects/{project}/regions/{region}/compositeHealthChecks
▼ ▲ compute.regionCompositeHealthChecks.getHealth
Path : projects/{project}/regions/{region}/compositeHealthChecks/{compositeHealthCheck}/getHealth
Parameters :
compositeHealthCheck
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}
Required : Yes
Type : string
Location : path
region
Description : Name of the region scoping this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
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
Type : string
Required : Yes
Description : Name of the project scoping this request.
Parameter Order :
Flat Path : projects/{project}/regions/{region}/compositeHealthChecks/{compositeHealthCheck}/getHealth
Scopes :
HTTP Method : GET
Description : Gets the most recent health check results for this regional CompositeHealthCheck.
Apiversion : 2026-10-01-preview
▼ ▲ compute.regionCompositeHealthChecks.get
Description : Returns the specified CompositeHealthCheck resource in the given region.
Parameters :
region
Type : string
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Name of the region scoping this request.
Location : path
compositeHealthCheck
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the CompositeHealthCheck resource to return.
Required : Yes
Type : string
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}/compositeHealthChecks/{compositeHealthCheck}
Parameter Order :
Path : projects/{project}/regions/{region}/compositeHealthChecks/{compositeHealthCheck}
Scopes :
Apiversion : 2026-10-01-preview
HTTP Method : GET
▼ ▲ compute.regionCompositeHealthChecks.aggregatedList
Apiversion : 2026-10-01-preview
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
Scopes :
Path : projects/{project}/aggregated/compositeHealthChecks
Parameter Order : project
Flat Path : projects/{project}/aggregated/compositeHealthChecks
Parameters :
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
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])?))
Location : path
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
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
Format : uint32
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`)
Default : 500
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.regionOperations.delete
Description : Deletes the specified region-specific Operations 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.
Location : path
Required : Yes
Type : string
operation
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 Operations resource to delete, or its unique numeric identifier.
Required : Yes
region
Description : Name of the region for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Required : Yes
Location : path
Scopes :
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/regions/{region}/operations/{operation}
HTTP Method : DELETE
Parameter Order :
Path : projects/{project}/regions/{region}/operations/{operation}
▼ ▲ compute.regionOperations.wait
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
operation
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Description : Name of the Operations resource to return, or its unique numeric identifier.
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])?))
Description : Project ID for this request.
Required : Yes
Type : string
Path : projects/{project}/regions/{region}/operations/{operation}/wait
Flat Path : projects/{project}/regions/{region}/operations/{operation}/wait
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`.
HTTP Method : POST
Parameter Order :
Apiversion : 2026-10-01-preview
Scopes :
▼ ▲ compute.regionOperations.get
HTTP Method : GET
Apiversion : 2026-10-01-preview
Description : Retrieves the specified region-specific Operations resource.
Scopes :
Path : projects/{project}/regions/{region}/operations/{operation}
Flat Path : projects/{project}/regions/{region}/operations/{operation}
Parameters :
region
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Name of the region for this request.
Type : string
Required : Yes
operation
Required : Yes
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}
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
Description : Project ID for this request.
Location : path
Parameter Order :
▼ ▲ compute.regionOperations.list
Scopes :
Flat Path : projects/{project}/regions/{region}/operations
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
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
Required : Yes
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Name of the region for this request.
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
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`)
Default : 500
Location : query
Format : uint32
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.
Path : projects/{project}/regions/{region}/operations
HTTP Method : GET
Description : Retrieves a list of Operation resources contained within the specified region.
Apiversion : 2026-10-01-preview
Parameter Order :
▼ ▲ compute.reservationSubBlocks.setIamPolicy
Parameter Order :
Scopes :
Parameters :
zone
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : The name of the zone for this request.
Type : string
Required : Yes
Location : path
parentResource
Type : string
Description : Name or id of parent resource of the resource for this request.
Location : path
Pattern : [a-z](?:[-a-zA-Z0-9/]{0,255}[a-zA-Z0-9])?
Required : Yes
resource
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}
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
Required : Yes
Type : string
Description : Project ID for this request.
Path : projects/{project}/zones/{zone}/{+parentResource}/reservationSubBlocks/{resource}/setIamPolicy
Flat Path : projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks/{resource}/setIamPolicy
Apiversion : 2026-10-01-preview
HTTP Method : POST
Description : Sets the access control policy on the specified resource. Replaces any existing policy.
▼ ▲ compute.reservationSubBlocks.getVersion
Scopes :
Parameter Order :
Description : Allows customers to get SBOM versions of a reservation subBlock.
Parameters :
parentName
Pattern : ^reservations/[^/]+/reservationBlocks/[^/]+$
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
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
reservationSubBlock
Location : path
Required : Yes
Description : The name of the reservation subBlock. Name should conform to RFC1035 or be a resource ID.
Type : string
project
Required : Yes
Location : path
Description : Project ID for this request.
Type : string
zone
Location : path
Type : string
Description : Name of the zone for this request. Zone name should conform to RFC1035.
Required : Yes
Apiversion : 2026-10-01-preview
Path : projects/{project}/zones/{zone}/{+parentName}/reservationSubBlocks/{reservationSubBlock}/getVersion
Flat Path : projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks/{reservationSubBlock}/getVersion
HTTP Method : POST
▼ ▲ compute.reservationSubBlocks.list
Parameter Order :
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.
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
Type : string
Description : Project ID for this request.
Location : path
Required : Yes
maxResults
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`)
Format : uint32
Default : 500
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}
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.
Type : string
Location : query
zone
Type : string
Description : Name of the zone for this request. Zone name should conform to RFC1035.
Required : Yes
Location : path
Scopes :
Description : Retrieves a list of reservation subBlocks under a single reservation.
Apiversion : 2026-10-01-preview
HTTP Method : GET
Flat Path : projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks
Path : projects/{project}/zones/{zone}/{+parentName}/reservationSubBlocks
▼ ▲ compute.reservationSubBlocks.getIamPolicy
Scopes :
Path : projects/{project}/zones/{zone}/{+parentResource}/reservationSubBlocks/{resource}/getIamPolicy
Parameters :
parentResource
Location : path
Required : Yes
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.
Type : string
optionsRequestedPolicyVersion
Type : integer
Location : query
Description : Requested IAM Policy version.
Format : int32
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
zone
Description : The name of the zone for this request.
Location : path
Type : string
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])?))
Required : Yes
Type : string
Description : Project ID for this request.
Location : path
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}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks/{resource}/getIamPolicy
HTTP Method : GET
Apiversion : 2026-10-01-preview
▼ ▲ compute.reservationSubBlocks.get
Description : Retrieves information about the specified reservation subBlock.
Scopes :
HTTP Method : GET
Apiversion : 2026-10-01-preview
Path : projects/{project}/zones/{zone}/{+parentName}/reservationSubBlocks/{reservationSubBlock}
Parameter Order :
Parameters :
view
Location : query
Description : View of the subBlock.
Enum :
Type : string
Enum Descriptions :
zone
Description : Name of the zone for this request. Zone name should conform to RFC1035.
Type : string
Required : Yes
Location : path
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}
Type : string
Location : path
project
Description : Project ID for this request.
Location : path
Required : Yes
Type : string
reservationSubBlock
Required : Yes
Description : The name of the reservation subBlock. Name should conform to RFC1035 or be a resource ID.
Location : path
Type : string
Flat Path : projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks/{reservationSubBlock}
▼ ▲ compute.reservationSubBlocks.testIamPermissions
Apiversion : 2026-10-01-preview
Parameter Order :
HTTP Method : POST
Path : projects/{project}/zones/{zone}/{+parentResource}/reservationSubBlocks/{resource}/testIamPermissions
Description : Returns permissions that a caller has on the specified resource.
Scopes :
Flat Path : projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks/{resource}/testIamPermissions
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
parentResource
Pattern : [a-z](?:[-a-zA-Z0-9/]{0,255}[a-zA-Z0-9])?
Required : Yes
Type : string
Location : path
Description : Name or id of parent resource of the resource for this request.
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
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])?))
Required : Yes
Type : string
Location : path
▼ ▲ compute.reservationSubBlocks.performMaintenance
HTTP Method : POST
Description : Allows customers to perform maintenance on a reservation subBlock
Apiversion : 2026-10-01-preview
Parameter Order :
Parameters :
zone
Type : string
Description : Name of the zone for this request. Zone name should conform to RFC1035.
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
parentName
Description : The name of the parent reservation and parent block. In the format of reservations/{reservation_name}/reservationBlocks/{reservation_block_name}
Required : Yes
Type : string
Location : path
Pattern : ^reservations/[^/]+/reservationBlocks/[^/]+$
project
Type : string
Location : path
Description : Project ID for this request.
Required : Yes
reservationSubBlock
Description : The name of the reservation subBlock. Name should conform to RFC1035 or be a resource ID.
Type : string
Required : Yes
Location : path
Flat Path : projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks/{reservationSubBlock}/performMaintenance
Scopes :
Path : projects/{project}/zones/{zone}/{+parentName}/reservationSubBlocks/{reservationSubBlock}/performMaintenance
▼ ▲ compute.reservationSubBlocks.reportFaulty
Description : Allows customers to report a faulty subBlock.
Apiversion : 2026-10-01-preview
Path : projects/{project}/zones/{zone}/{+parentName}/reservationSubBlocks/{reservationSubBlock}/reportFaulty
HTTP Method : POST
Scopes :
Parameters :
parentName
Pattern : ^reservations/[^/]+/reservationBlocks/[^/]+$
Type : string
Location : path
Description : The name of the parent reservation and parent block. In the format of reservations/{reservation_name}/reservationBlocks/{reservation_block_name}
Required : Yes
project
Type : string
Description : Project ID for this request.
Required : Yes
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
zone
Description : Name of the zone for this request. Zone name should conform to RFC1035.
Type : string
Required : Yes
Location : path
reservationSubBlock
Required : Yes
Type : string
Location : path
Description : The name of the reservation subBlock. Name should conform to RFC1035 or be a resource ID.
Parameter Order :
Flat Path : projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks/{reservationSubBlock}/reportFaulty
▼ ▲ compute.regionBackendBuckets.list
Flat Path : projects/{project}/regions/{region}/backendBuckets
Parameter Order :
Description : Retrieves the list of BackendBucket resources available to the specified project in the given region.
Apiversion : 2026-10-01-preview
Scopes :
HTTP Method : GET
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
maxResults
Type : integer
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
region
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Description : Name of the region of 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])?))
Type : string
Required : Yes
Location : path
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
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.
Path : projects/{project}/regions/{region}/backendBuckets
▼ ▲ compute.regionBackendBuckets.getIamPolicy
Scopes :
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}/regions/{region}/backendBuckets/{resource}/getIamPolicy
Apiversion : 2026-10-01-preview
Path : projects/{project}/regions/{region}/backendBuckets/{resource}/getIamPolicy
Parameters :
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.
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.
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}
optionsRequestedPolicyVersion
Type : integer
Description : Requested IAM Policy version.
Location : query
Format : int32
Parameter Order :
▼ ▲ compute.regionBackendBuckets.testIamPermissions
Scopes :
Flat Path : projects/{project}/regions/{region}/backendBuckets/{resource}/testIamPermissions
HTTP Method : POST
Path : projects/{project}/regions/{region}/backendBuckets/{resource}/testIamPermissions
Description : Returns permissions that a caller has on the specified resource.
Apiversion : 2026-10-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
Description : Project ID for this request.
Required : Yes
Location : path
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Location : path
Description : The name of the region for this request.
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
Parameter Order :
▼ ▲ compute.regionBackendBuckets.setIamPolicy
Scopes :
HTTP Method : POST
Path : projects/{project}/regions/{region}/backendBuckets/{resource}/setIamPolicy
Apiversion : 2026-10-01-preview
Parameter Order :
Parameters :
region
Location : path
Type : string
Required : Yes
Description : The name of the region for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
resource
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.
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.
Flat Path : projects/{project}/regions/{region}/backendBuckets/{resource}/setIamPolicy
Description : Sets the access control policy on the specified resource. Replaces any existing policy.
▼ ▲ compute.regionBackendBuckets.get
Scopes :
Path : projects/{project}/regions/{region}/backendBuckets/{backendBucket}
Parameter Order :
Parameters :
backendBucket
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 BackendBucket resource to return.
region
Type : string
Description : Name of the region 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])?))
Required : Yes
Type : string
Description : Project ID for this request.
Apiversion : 2026-10-01-preview
Description : Returns the specified regional BackendBucket resource.
HTTP Method : GET
Flat Path : projects/{project}/regions/{region}/backendBuckets/{backendBucket}
▼ ▲ compute.regionBackendBuckets.patch
Parameters :
backendBucket
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 BackendBucket resource to patch.
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
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
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
Parameter Order :
Path : projects/{project}/regions/{region}/backendBuckets/{backendBucket}
Flat Path : projects/{project}/regions/{region}/backendBuckets/{backendBucket}
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.
Scopes :
HTTP Method : PATCH
Apiversion : 2026-10-01-preview
▼ ▲ compute.regionBackendBuckets.listUsable
Description : Retrieves a list of all usable backend buckets in the specified project in the given region.
Parameters :
region
Type : string
Location : path
Description : Name of the region scoping this request. It must be a string that meets the requirements in RFC1035.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
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.
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
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
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
Parameter Order :
Flat Path : projects/{project}/regions/{region}/backendBuckets/listUsable
Path : projects/{project}/regions/{region}/backendBuckets/listUsable
Apiversion : 2026-10-01-preview
Scopes :
HTTP Method : GET
▼ ▲ compute.regionBackendBuckets.insert
Parameter Order :
Scopes :
Flat Path : projects/{project}/regions/{region}/backendBuckets
Parameters :
region
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Type : string
Description : Name of the region 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).
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
Path : projects/{project}/regions/{region}/backendBuckets
Apiversion : 2026-10-01-preview
HTTP Method : POST
Description : Creates a RegionBackendBucket in the specified project in the given scope using the parameters that are included in the request.
▼ ▲ compute.regionBackendBuckets.delete
Description : Deletes the specified regional BackendBucket resource.
Path : projects/{project}/regions/{region}/backendBuckets/{backendBucket}
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). end_interface: MixerMutationRequestBuilder
Type : string
region
Required : Yes
Type : string
Location : path
Description : Name of the region scoping this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
backendBucket
Location : path
Description : Name of the BackendBucket resource to delete.
Type : string
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
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/regions/{region}/backendBuckets/{backendBucket}
Parameter Order :
HTTP Method : DELETE
Scopes :
▼ ▲ compute.previewFeatures.list
Path : projects/{project}/global/previewFeatures
Parameters :
maxResults
Default : 500
Location : query
Type : integer
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`)
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
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
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
Parameter Order : project
Flat Path : projects/{project}/global/previewFeatures
Apiversion : 2026-10-01-preview
Scopes :
HTTP Method : GET
Description : Returns the details of the given PreviewFeature.
▼ ▲ compute.previewFeatures.update
Parameters :
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])?))
previewFeature
Required : Yes
Location : path
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
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}/global/previewFeatures/{previewFeature}
Description : Patches the given PreviewFeature. This method is used to enable or disable a PreviewFeature.
Parameter Order :
Scopes :
HTTP Method : PATCH
Path : projects/{project}/global/previewFeatures/{previewFeature}
Apiversion : 2026-10-01-preview
▼ ▲ compute.previewFeatures.get
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])?))
previewFeature
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 PreviewFeature for this request.
Location : path
Path : projects/{project}/global/previewFeatures/{previewFeature}
Scopes :
Description : Returns the details of the given PreviewFeature.
Flat Path : projects/{project}/global/previewFeatures/{previewFeature}
HTTP Method : GET
Parameter Order :
Apiversion : 2026-10-01-preview
▼ ▲ compute.advice.calendarMode
Parameter Order :
Flat Path : projects/{project}/regions/{region}/advice/calendarMode
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.
Apiversion : 2026-10-01-preview
HTTP Method : POST
Parameters :
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
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
Scopes :
Path : projects/{project}/regions/{region}/advice/calendarMode
▼ ▲ compute.advice.capacity
Path : projects/{project}/regions/{region}/advice/capacity
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
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Name of the region for this request.
Location : path
Type : string
Required : Yes
Scopes :
Apiversion : 2026-10-01-preview
Parameter Order :
HTTP Method : POST
Flat Path : projects/{project}/regions/{region}/advice/capacity
Description : Advice on making real-time decisions (such as choosing zone or machine types) during deployment to maximize your chances of obtaining capacity.
▼ ▲ compute.advice.capacityHistory
Scopes :
Path : projects/{project}/regions/{region}/advice/capacityHistory
Description : Gets the capacity history.
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
Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-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
HTTP Method : POST
Apiversion : 2026-10-01-preview
Parameter Order :
Flat Path : projects/{project}/regions/{region}/advice/capacityHistory
▼ ▲ compute.sslPolicies.patch
Path : projects/{project}/global/sslPolicies/{sslPolicy}
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
sslPolicy
Type : string
Description : Name of the SSL policy to update. The name must be 1-63 characters long, and comply with RFC1035.
Location : path
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 : Patches the specified SSL policy with the data included in the request.
Apiversion : 2026-10-01-preview
HTTP Method : PATCH
Parameter Order :
Scopes :
Flat Path : projects/{project}/global/sslPolicies/{sslPolicy}
▼ ▲ compute.sslPolicies.listAvailableFeatures
Parameter Order : project
Description : Lists all features that can be specified in the SSL policy when using custom profile.
Apiversion : 2026-10-01-preview
HTTP Method : GET
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
maxResults
Default : 500
Location : query
Type : integer
Format : uint32
Description : The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
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.
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
Flat Path : projects/{project}/global/sslPolicies/listAvailableFeatures
Path : projects/{project}/global/sslPolicies/listAvailableFeatures
Scopes :
▼ ▲ compute.sslPolicies.get
Parameter Order :
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])?))
sslPolicy
Description : Name of the SSL policy to update. The name must be 1-63 characters long, and comply with RFC1035.
Required : Yes
Type : string
Location : path
Description : Lists all of the ordered rules present in a single specified policy.
Apiversion : 2026-10-01-preview
HTTP Method : GET
Flat Path : projects/{project}/global/sslPolicies/{sslPolicy}
Scopes :
Path : projects/{project}/global/sslPolicies/{sslPolicy}
▼ ▲ compute.sslPolicies.aggregatedList
Path : projects/{project}/aggregated/sslPolicies
HTTP Method : GET
Apiversion : 2026-10-01-preview
Parameter Order : project
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`.
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 : Name of the project scoping this request.
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.
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
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
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
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
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`)
Minimum : 0
Format : uint32
Location : query
Type : integer
Default : 500
Scopes :
▼ ▲ compute.sslPolicies.insert
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
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}/global/sslPolicies
Flat Path : projects/{project}/global/sslPolicies
Description : Returns the specified SSL policy resource.
Apiversion : 2026-10-01-preview
Parameter Order : project
HTTP Method : POST
▼ ▲ compute.sslPolicies.delete
Parameter Order :
Scopes :
Parameters :
sslPolicy
Type : string
Location : path
Description : Name of the SSL policy to delete. The name must be 1-63 characters long, and comply with RFC1035.
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
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/sslPolicies/{sslPolicy}
Apiversion : 2026-10-01-preview
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.
Path : projects/{project}/global/sslPolicies/{sslPolicy}
HTTP Method : DELETE
▼ ▲ compute.sslPolicies.list
Path : projects/{project}/global/sslPolicies
Parameter Order : project
Parameters :
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`)
Format : uint32
Minimum : 0
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
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])?))
Required : Yes
Location : path
Type : string
Description : Project ID for this request.
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.
Scopes :
HTTP Method : GET
Flat Path : projects/{project}/global/sslPolicies
Apiversion : 2026-10-01-preview
Description : Lists all the SSL policies that have been configured for the specified project.
▼ ▲ compute.reliabilityRisks.list
Apiversion : 2026-10-01-preview
HTTP Method : GET
Scopes :
Description : Retrieves the list of reliabilityRisks available in the specified project.
Path : projects/{project}/global/reliabilityRisks
Parameter Order : project
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
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`)
Minimum : 0
Location : query
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.
Location : query
Type : string
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
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}/global/reliabilityRisks
▼ ▲ compute.reliabilityRisks.get
HTTP Method : GET
Apiversion : 2026-10-01-preview
Path : projects/{project}/global/reliabilityRisks/{reliabilityRisk}
Description : Returns the specified ReliabilityRisk resource.
Flat Path : projects/{project}/global/reliabilityRisks/{reliabilityRisk}
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.
Required : Yes
Type : string
reliabilityRisk
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 ReliabilityRisk resource to return.
Scopes :
▼ ▲ compute.regionTargetHttpsProxies.insert
HTTP Method : POST
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/regions/{region}/targetHttpsProxies
Description : Creates a TargetHttpsProxy resource in the specified project and region using the data included in the request.
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).
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
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])?
Path : projects/{project}/regions/{region}/targetHttpsProxies
▼ ▲ compute.regionTargetHttpsProxies.delete
Path : projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}
Parameter Order :
Description : Deletes the specified TargetHttpsProxy resource.
HTTP Method : DELETE
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}
Parameters :
targetHttpsProxy
Location : path
Type : string
Description : Name of the TargetHttpsProxy resource to delete.
Required : Yes
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
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
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])?
Scopes :
▼ ▲ compute.regionTargetHttpsProxies.patch
Parameter Order :
Path : projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}
Scopes :
Flat Path : projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}
Parameters :
targetHttpsProxy
Description : Name of the TargetHttpsProxy resource to patch.
Type : string
Required : Yes
Location : path
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.
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
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
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Description : Name of the region for this request.
Type : string
Apiversion : 2026-10-01-preview
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.
HTTP Method : PATCH
▼ ▲ compute.regionTargetHttpsProxies.list
Parameter Order :
Path : projects/{project}/regions/{region}/targetHttpsProxies
HTTP Method : GET
Apiversion : 2026-10-01-preview
Description : Retrieves the list of TargetHttpsProxy resources available to the specified project in the specified region.
Scopes :
Parameters :
maxResults
Format : uint32
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`)
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.
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
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
Type : string
Description : Name of the region scoping this request.
Required : Yes
Pattern : [a-z](?:[-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
Flat Path : projects/{project}/regions/{region}/targetHttpsProxies
▼ ▲ compute.regionTargetHttpsProxies.setSslCertificates
Parameters :
region
Type : string
Required : Yes
Location : path
Description : Name of the region scoping this request.
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
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
targetHttpsProxy
Description : Name of the TargetHttpsProxy resource to set an SslCertificates resource for.
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}/targetHttpsProxies/{targetHttpsProxy}/setSslCertificates
Parameter Order :
Scopes :
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}/setSslCertificates
Description : Replaces SslCertificates for TargetHttpsProxy.
HTTP Method : POST
▼ ▲ compute.regionTargetHttpsProxies.get
Apiversion : 2026-10-01-preview
HTTP Method : GET
Flat Path : projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}
Parameter Order :
Scopes :
Path : projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}
Description : Returns the specified TargetHttpsProxy resource in the specified region.
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
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])?))
targetHttpsProxy
Required : Yes
Type : string
Description : Name of the TargetHttpsProxy resource to return.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
▼ ▲ compute.regionTargetHttpsProxies.setUrlMap
Scopes :
HTTP Method : POST
Apiversion : 2026-10-01-preview
Path : projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}/setUrlMap
Parameter Order :
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])?))
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
targetHttpsProxy
Location : path
Description : Name of the TargetHttpsProxy to set a URL map for.
Type : string
Required : Yes
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.
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Description : Changes the URL map for TargetHttpsProxy.
Flat Path : projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}/setUrlMap
▼ ▲ compute.regionNotificationEndpoints.testIamPermissions
Scopes :
Parameter Order :
Apiversion : 2026-10-01-preview
HTTP Method : POST
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
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
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.
Flat Path : projects/{project}/regions/{region}/notificationEndpoints/{resource}/testIamPermissions
Description : Returns permissions that a caller has on the specified resource.
Path : projects/{project}/regions/{region}/notificationEndpoints/{resource}/testIamPermissions
▼ ▲ compute.regionNotificationEndpoints.insert
Description : Create a NotificationEndpoint in the specified project in the given region using the parameters that are included in the request.
HTTP Method : POST
Scopes :
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/regions/{region}/notificationEndpoints
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])?))
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
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Parameter Order :
Path : projects/{project}/regions/{region}/notificationEndpoints
▼ ▲ compute.regionNotificationEndpoints.delete
Description : Deletes the specified NotificationEndpoint in the given region
Flat Path : projects/{project}/regions/{region}/notificationEndpoints/{notificationEndpoint}
Parameters :
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
notificationEndpoint
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 NotificationEndpoint resource to delete.
Location : path
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
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}/regions/{region}/notificationEndpoints/{notificationEndpoint}
Apiversion : 2026-10-01-preview
HTTP Method : DELETE
Scopes :
▼ ▲ compute.regionNotificationEndpoints.list
Path : projects/{project}/regions/{region}/notificationEndpoints
Description : Lists the NotificationEndpoints for a project in the given region.
HTTP Method : GET
Parameter Order :
Apiversion : 2026-10-01-preview
Scopes :
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`)
Minimum : 0
Type : integer
Location : query
Default : 500
Format : uint32
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
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
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])?
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.
Type : string
Location : query
Flat Path : projects/{project}/regions/{region}/notificationEndpoints
▼ ▲ compute.regionNotificationEndpoints.aggregatedList
HTTP Method : GET
Apiversion : 2026-10-01-preview
Path : projects/{project}/aggregated/notificationEndpoints
Flat Path : projects/{project}/aggregated/notificationEndpoints
Scopes :
Parameter Order : project
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
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.
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.
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`)
Minimum : 0
Default : 500
Type : integer
Location : query
Format : uint32
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
Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-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 : Name of the project scoping this request.
Location : path
Description : Retrieves the list of all NotificationEndpoint resources, regional and global, available to the specified project.
▼ ▲ compute.regionNotificationEndpoints.get
Parameter Order :
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/regions/{region}/notificationEndpoints/{notificationEndpoint}
Description : Returns the specified NotificationEndpoint resource in the given region.
HTTP Method : GET
Scopes :
Path : projects/{project}/regions/{region}/notificationEndpoints/{notificationEndpoint}
Parameters :
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])?
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])?))
notificationEndpoint
Location : path
Type : string
Required : Yes
Description : Name of the NotificationEndpoint resource to return.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
▼ ▲ compute.regionBackendServices.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
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
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.
Scopes :
Path : projects/{project}/regions/{region}/backendServices
HTTP Method : POST
Apiversion : 2026-10-01-preview
Parameter Order :
Description : Creates a regional BackendService resource in the specified project using the data included in the request. For more information, see Backend services overview.
Flat Path : projects/{project}/regions/{region}/backendServices
▼ ▲ compute.regionBackendServices.delete
Flat Path : projects/{project}/regions/{region}/backendServices/{backendService}
Scopes :
Parameters :
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 delete.
Location : path
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
Description : An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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
Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-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 : Deletes the specified regional BackendService resource.
Path : projects/{project}/regions/{region}/backendServices/{backendService}
Apiversion : 2026-10-01-preview
Parameter Order :
HTTP Method : DELETE
▼ ▲ compute.regionBackendServices.listUsable
Parameter Order :
Parameters :
maxResults
Location : query
Type : integer
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`)
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
Type : string
Description : Name of the region scoping this request. It must be a string that meets the requirements in RFC1035.
Required : Yes
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.
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
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
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.
Path : projects/{project}/regions/{region}/backendServices/listUsable
Apiversion : 2026-10-01-preview
Scopes :
Flat Path : projects/{project}/regions/{region}/backendServices/listUsable
HTTP Method : GET
▼ ▲ compute.regionBackendServices.getHealth
Description : Gets the most recent health check results for this regional BackendService.
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/regions/{region}/backendServices/{backendService}/getHealth
HTTP Method : POST
Parameter Order :
Path : projects/{project}/regions/{region}/backendServices/{backendService}/getHealth
Parameters :
backendService
Description : Name of the BackendService resource for which to get health.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
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
Required : Yes
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
Scopes :
▼ ▲ compute.regionBackendServices.patch
Parameter Order :
Parameters :
backendService
Type : string
Location : path
Description : Name of the BackendService resource to patch.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
region
Location : path
Type : string
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Name of the region scoping 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
Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-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 : 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.
Flat Path : projects/{project}/regions/{region}/backendServices/{backendService}
Scopes :
Path : projects/{project}/regions/{region}/backendServices/{backendService}
Apiversion : 2026-10-01-preview
HTTP Method : PATCH
▼ ▲ compute.regionBackendServices.testIamPermissions
Scopes :
Description : Returns permissions that a caller has on the specified resource.
Apiversion : 2026-10-01-preview
HTTP Method : POST
Parameter Order :
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}
Description : Name or id of the resource for this request.
Location : path
Type : string
Required : Yes
region
Type : string
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : The name of the region for this request.
Location : path
Path : projects/{project}/regions/{region}/backendServices/{resource}/testIamPermissions
Flat Path : projects/{project}/regions/{region}/backendServices/{resource}/testIamPermissions
▼ ▲ compute.regionBackendServices.setIamPolicy
Flat Path : projects/{project}/regions/{region}/backendServices/{resource}/setIamPolicy
Scopes :
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.
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
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 : Sets the access control policy on the specified resource. Replaces any existing policy.
Path : projects/{project}/regions/{region}/backendServices/{resource}/setIamPolicy
Apiversion : 2026-10-01-preview
HTTP Method : POST
Parameter Order :
▼ ▲ compute.regionBackendServices.update
Path : projects/{project}/regions/{region}/backendServices/{backendService}
Apiversion : 2026-10-01-preview
HTTP Method : PUT
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
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Required : Yes
Type : string
Description : Name of the region scoping this request.
backendService
Description : Name of the BackendService resource 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
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.
Flat Path : projects/{project}/regions/{region}/backendServices/{backendService}
Parameter Order :
Description : Updates the specified regional BackendService resource with the data included in the request. For more information, see Backend services overview.
▼ ▲ compute.regionBackendServices.setSecurityPolicy
Flat Path : projects/{project}/regions/{region}/backendServices/{backendService}/setSecurityPolicy
Path : projects/{project}/regions/{region}/backendServices/{backendService}/setSecurityPolicy
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).
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
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
Description : Name of the region scoping this request.
Location : path
Type : string
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Scopes :
Apiversion : 2026-10-01-preview
Parameter Order :
HTTP Method : POST
Description : Sets the Google Cloud Armor security policy for the specified backend service. For more information, seeGoogle Cloud Armor Overview
▼ ▲ compute.regionBackendServices.getIamPolicy
HTTP Method : GET
Apiversion : 2026-10-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])?))
Type : string
Location : path
Description : Project ID for this request.
Required : Yes
optionsRequestedPolicyVersion
Description : Requested IAM Policy version.
Format : int32
Location : query
Type : integer
region
Description : The name of 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
Type : string
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}
Path : projects/{project}/regions/{region}/backendServices/{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}/regions/{region}/backendServices/{resource}/getIamPolicy
Scopes :
▼ ▲ compute.regionBackendServices.list
Description : Retrieves the list of regional BackendService resources available to the specified project in the given region.
Path : projects/{project}/regions/{region}/backendServices
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
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
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
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
Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-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.
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 :
Flat Path : projects/{project}/regions/{region}/backendServices
Apiversion : 2026-10-01-preview
HTTP Method : GET
▼ ▲ compute.regionBackendServices.get
Apiversion : 2026-10-01-preview
Scopes :
Parameter Order :
HTTP Method : GET
Path : projects/{project}/regions/{region}/backendServices/{backendService}
Description : Returns the specified regional BackendService resource.
Flat Path : projects/{project}/regions/{region}/backendServices/{backendService}
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.
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
backendService
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 to return.
Required : Yes
Type : string
▼ ▲ compute.publicAdvertisedPrefixes.get
Apiversion : 2026-10-01-preview
HTTP Method : GET
Path : projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}
Flat Path : projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}
Parameter Order :
Description : Returns the specified PublicAdvertisedPrefix resource.
Scopes :
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])?))
publicAdvertisedPrefix
Required : Yes
Description : Name of the PublicAdvertisedPrefix resource to return.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Type : string
▼ ▲ compute.publicAdvertisedPrefixes.list
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
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.
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
Type : integer
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`)
Description : Lists the PublicAdvertisedPrefixes for a project.
Scopes :
Flat Path : projects/{project}/global/publicAdvertisedPrefixes
Parameter Order : project
Apiversion : 2026-10-01-preview
Path : projects/{project}/global/publicAdvertisedPrefixes
HTTP Method : GET
▼ ▲ compute.publicAdvertisedPrefixes.announce
Parameters :
publicAdvertisedPrefix
Location : path
Required : Yes
Type : string
Description : The name of the public advertised prefix. It should comply with 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
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])?))
Scopes :
Path : projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}/announce
HTTP Method : POST
Flat Path : projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}/announce
Apiversion : 2026-10-01-preview
Parameter Order :
Description : Announces the specified PublicAdvertisedPrefix
▼ ▲ compute.publicAdvertisedPrefixes.withdraw
Scopes :
Flat Path : projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}/withdraw
HTTP Method : POST
Apiversion : 2026-10-01-preview
Parameter Order :
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
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
publicAdvertisedPrefix
Description : The name of the public advertised prefix. It should comply with RFC1035.
Location : path
Type : string
Required : Yes
Path : projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}/withdraw
Description : Withdraws the specified PublicAdvertisedPrefix
▼ ▲ compute.publicAdvertisedPrefixes.insert
Path : projects/{project}/global/publicAdvertisedPrefixes
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
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 : Creates a PublicAdvertisedPrefix in the specified project using the parameters that are included in the request.
Parameter Order : project
HTTP Method : POST
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/global/publicAdvertisedPrefixes
▼ ▲ compute.publicAdvertisedPrefixes.delete
Scopes :
HTTP Method : DELETE
Apiversion : 2026-10-01-preview
Parameter Order :
Path : projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}
Description : Deletes the specified PublicAdvertisedPrefix
Parameters :
publicAdvertisedPrefix
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 PublicAdvertisedPrefix resource to delete.
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
Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-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
Flat Path : projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}
▼ ▲ compute.publicAdvertisedPrefixes.patch
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
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])?))
publicAdvertisedPrefix
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 PublicAdvertisedPrefix resource to patch.
Scopes :
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.
Parameter Order :
Path : projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}
Flat Path : projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}
HTTP Method : PATCH
Apiversion : 2026-10-01-preview
▼ ▲ compute.haControllers.failover
Path : projects/{project}/regions/{region}/haControllers/{haController}/failover
Apiversion : 2026-10-01-preview
Parameter Order :
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
Parameters :
region
Description : Name of the region for this request.
Type : string
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
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])?))
haController
Required : Yes
Type : string
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}
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.
Location : query
Type : string
Scopes :
▼ ▲ compute.haControllers.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])?))
Location : path
Type : string
Description : Project ID for this request.
Required : Yes
haController
Description : Name of the HaController resource to return.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Required : Yes
Location : path
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
Parameter Order :
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/regions/{region}/haControllers/{haController}
Description : Returns all the details of a specific HaController.
HTTP Method : GET
Path : projects/{project}/regions/{region}/haControllers/{haController}
▼ ▲ compute.haControllers.insert
Description : Creates HaController in the specified project.
Path : projects/{project}/regions/{region}/haControllers
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
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.
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
Flat Path : projects/{project}/regions/{region}/haControllers
Apiversion : 2026-10-01-preview
Parameter Order :
HTTP Method : POST
Scopes :
▼ ▲ compute.haControllers.delete
Flat Path : projects/{project}/regions/{region}/haControllers/{haController}
Path : projects/{project}/regions/{region}/haControllers/{haController}
Parameters :
region
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Required : Yes
Description : Name of the region for this request.
force
Type : boolean
Location : query
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.
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
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
haController
Description : Name of the HaController resource to delete.
Required : Yes
Location : path
Type : string
Scopes :
Apiversion : 2026-10-01-preview
Description : Deletes an HaController in the specified project.
HTTP Method : DELETE
Parameter Order :
▼ ▲ compute.haControllers.list
Description : Lists all HaControllers in the specified project in the specified region.
Parameters :
region
Type : string
Location : path
Description : Name of the region for this request.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
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
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
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
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.
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-10-01-preview
HTTP Method : GET
Flat Path : projects/{project}/regions/{region}/haControllers
Scopes :
Parameter Order :
Path : projects/{project}/regions/{region}/haControllers
▼ ▲ compute.haControllers.aggregatedList
HTTP Method : GET
Apiversion : 2026-10-01-preview
Parameter Order : project
Flat Path : projects/{project}/aggregated/haControllers
Scopes :
Path : projects/{project}/aggregated/haControllers
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
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
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
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
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
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 : Retrieves an aggregated list of all of the HaControllers in the specified project across all regions.
▼ ▲ compute.haControllers.patch
Path : projects/{project}/regions/{region}/haControllers/{haController}
Scopes :
Flat Path : projects/{project}/regions/{region}/haControllers/{haController}
Apiversion : 2026-10-01-preview
Parameter Order :
HTTP Method : PATCH
Description : Updates HaController in the specified project.
Parameters :
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])?))
updateMask
Description : update_mask indicates fields to be updated as part of this request.
Format : google-fieldmask
Location : query
Type : string
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.
haController
Required : Yes
Location : path
Description : ID of the HaController resource to update.
Type : string
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.
Type : string
▼ ▲ compute.urlMaps.update
Scopes :
Description : Updates the specified UrlMap resource with the data included in the request.
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
urlMap
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Description : Name of the UrlMap resource to update.
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])?))
Required : Yes
Description : Project ID for this request.
Location : path
Flat Path : projects/{project}/global/urlMaps/{urlMap}
Path : projects/{project}/global/urlMaps/{urlMap}
Parameter Order :
HTTP Method : PUT
Apiversion : 2026-10-01-preview
▼ ▲ compute.urlMaps.testIamPermissions
Apiversion : 2026-10-01-preview
Parameter Order :
HTTP Method : POST
Scopes :
Flat Path : projects/{project}/global/urlMaps/{resource}/testIamPermissions
Description : Returns permissions that a caller has on the specified resource.
Path : projects/{project}/global/urlMaps/{resource}/testIamPermissions
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}
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
▼ ▲ compute.urlMaps.list
Scopes :
Path : projects/{project}/global/urlMaps
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
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
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.
maxResults
Type : integer
Location : query
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`)
Apiversion : 2026-10-01-preview
Parameter Order : project
Flat Path : projects/{project}/global/urlMaps
HTTP Method : GET
Description : Retrieves the list of UrlMap resources available to the specified project.
▼ ▲ compute.urlMaps.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
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
urlMap
Description : Name of the UrlMap scoping this request.
Required : Yes
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
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
Description : Project ID for this request.
Type : string
Flat Path : projects/{project}/global/urlMaps/{urlMap}/invalidateCache
HTTP Method : POST
Apiversion : 2026-10-01-preview
Parameter Order :
▼ ▲ compute.urlMaps.aggregatedList
Flat Path : projects/{project}/aggregated/urlMaps
Path : projects/{project}/aggregated/urlMaps
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.
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`)
Minimum : 0
Format : uint32
Type : integer
Location : query
Default : 500
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
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
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])?))
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
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`.
Parameter Order : project
HTTP Method : GET
Apiversion : 2026-10-01-preview
Scopes :
▼ ▲ compute.urlMaps.patch
Flat Path : projects/{project}/global/urlMaps/{urlMap}
Apiversion : 2026-10-01-preview
HTTP Method : PATCH
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
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])?))
urlMap
Location : path
Required : Yes
Type : string
Description : Name of the UrlMap resource to patch.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Path : projects/{project}/global/urlMaps/{urlMap}
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.
▼ ▲ compute.urlMaps.get
Parameters :
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 return.
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}/global/urlMaps/{urlMap}
Scopes :
Parameter Order :
Path : projects/{project}/global/urlMaps/{urlMap}
HTTP Method : GET
Description : Returns the specified UrlMap resource.
Apiversion : 2026-10-01-preview
▼ ▲ compute.urlMaps.insert
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
Description : An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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 UrlMap resource in the specified project using the data included in the request.
Apiversion : 2026-10-01-preview
Scopes :
Path : projects/{project}/global/urlMaps
Flat Path : projects/{project}/global/urlMaps
HTTP Method : POST
Parameter Order : project
▼ ▲ compute.urlMaps.delete
Apiversion : 2026-10-01-preview
HTTP Method : DELETE
Scopes :
Flat Path : projects/{project}/global/urlMaps/{urlMap}
Parameter Order :
Path : projects/{project}/global/urlMaps/{urlMap}
Description : Deletes the specified UrlMap 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])?))
Location : path
Description : Project ID for this request.
Required : Yes
Type : string
urlMap
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 UrlMap resource to delete.
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
▼ ▲ compute.urlMaps.validate
HTTP Method : POST
Parameter Order :
Apiversion : 2026-10-01-preview
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}/global/urlMaps/{urlMap}/validate
Scopes :
Parameters :
urlMap
Location : path
Description : Name of the UrlMap resource to be validated as.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
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
Flat Path : projects/{project}/global/urlMaps/{urlMap}/validate
▼ ▲ compute.disks.removeResourcePolicies
Scopes :
HTTP Method : POST
Apiversion : 2026-10-01-preview
Parameter Order :
Flat Path : projects/{project}/zones/{zone}/disks/{disk}/removeResourcePolicies
Parameters :
disk
Type : string
Description : The disk name for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Location : path
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
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
Description : Removes resource policies from a disk.
Path : projects/{project}/zones/{zone}/disks/{disk}/removeResourcePolicies
▼ ▲ compute.disks.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).
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
sourceImage
Type : string
Location : query
Description : Source image to restore onto a disk. This field is optional.
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
Parameter Order :
Flat Path : projects/{project}/zones/{zone}/disks
Path : projects/{project}/zones/{zone}/disks
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.
HTTP Method : POST
Apiversion : 2026-10-01-preview
▼ ▲ compute.disks.setLabels
HTTP Method : POST
Apiversion : 2026-10-01-preview
Description : Sets the labels on a disk. To learn more about labels, read theLabeling Resources documentation.
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}
Location : path
Type : string
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
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.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Flat Path : projects/{project}/zones/{zone}/disks/{resource}/setLabels
Path : projects/{project}/zones/{zone}/disks/{resource}/setLabels
Scopes :
▼ ▲ compute.disks.resize
Scopes :
Parameter Order :
Flat Path : projects/{project}/zones/{zone}/disks/{disk}/resize
Description : Resizes the specified persistent disk. You can only increase the size of the disk.
Parameters :
disk
Location : path
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 persistent disk.
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])?))
Required : Yes
Location : path
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
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-10-01-preview
HTTP Method : POST
Path : projects/{project}/zones/{zone}/disks/{disk}/resize
▼ ▲ compute.disks.addResourcePolicies
Flat Path : projects/{project}/zones/{zone}/disks/{disk}/addResourcePolicies
Path : projects/{project}/zones/{zone}/disks/{disk}/addResourcePolicies
Parameters :
disk
Required : Yes
Description : The disk name 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
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
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.
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 : Adds existing resource policies to a disk. You can only add one policy which will be applied to this disk for scheduling snapshot creation.
Parameter Order :
HTTP Method : POST
Apiversion : 2026-10-01-preview
Scopes :
▼ ▲ compute.disks.updateKmsKey
Description : Rotates the customer-managed encryption key to the latest version for the specified persistent disk.
Flat Path : projects/{project}/zones/{zone}/disks/{disk}/updateKmsKey
HTTP Method : POST
Path : projects/{project}/zones/{zone}/disks/{disk}/updateKmsKey
Parameter Order :
Apiversion : 2026-10-01-preview
Scopes :
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])?))
disk
Description : Name of the Disk resource, should conform to RFC1035.
Location : path
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
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
▼ ▲ compute.disks.bulkInsert
Path : projects/{project}/zones/{zone}/disks/bulkInsert
Parameter Order :
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])?))
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
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
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/zones/{zone}/disks/bulkInsert
Scopes :
Description : Bulk create a set of disks.
▼ ▲ compute.disks.get
Scopes :
Description : Returns the specified persistent disk.
Parameters :
disk
Description : Name of the persistent disk 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
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.
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
Path : projects/{project}/zones/{zone}/disks/{disk}
Flat Path : projects/{project}/zones/{zone}/disks/{disk}
HTTP Method : GET
Parameter Order :
Apiversion : 2026-10-01-preview
▼ ▲ compute.disks.setIamPolicy
Scopes :
Parameter Order :
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
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
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
Path : projects/{project}/zones/{zone}/disks/{resource}/setIamPolicy
Description : Sets the access control policy on the specified resource. Replaces any existing policy.
Flat Path : projects/{project}/zones/{zone}/disks/{resource}/setIamPolicy
Apiversion : 2026-10-01-preview
HTTP Method : POST
▼ ▲ compute.disks.stopAsyncReplication
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
Description : An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Description : The name of the zone for this request.
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.
Scopes :
Description : Stops asynchronous replication. Can be invoked either on the primary or on the secondary disk.
Parameter Order :
HTTP Method : POST
Flat Path : projects/{project}/zones/{zone}/disks/{disk}/stopAsyncReplication
Path : projects/{project}/zones/{zone}/disks/{disk}/stopAsyncReplication
Apiversion : 2026-10-01-preview
▼ ▲ compute.disks.aggregatedList
Scopes :
Path : projects/{project}/aggregated/disks
Apiversion : 2026-10-01-preview
Parameter Order : project
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`.
Parameters :
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`)
Location : query
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
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
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
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])?))
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.
Format : int64
Location : query
Type : string
▼ ▲ compute.disks.list
Parameter Order :
Flat Path : projects/{project}/zones/{zone}/disks
Scopes :
HTTP Method : GET
Description : Retrieves a list of persistent disks contained within the specified zone.
Apiversion : 2026-10-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.
Location : query
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
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])?))
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
maxResults
Type : integer
Minimum : 0
Format : uint32
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`)
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
Path : projects/{project}/zones/{zone}/disks
▼ ▲ compute.disks.delete
Apiversion : 2026-10-01-preview
Scopes :
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.
HTTP Method : DELETE
Path : projects/{project}/zones/{zone}/disks/{disk}
Parameters :
zone
Description : The name of the zone for this request.
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
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])?))
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
Type : string
Pattern : \S{1,66}
Required : Yes
Location : path
Description : Name of the persistent disk to delete.
Flat Path : projects/{project}/zones/{zone}/disks/{disk}
Parameter Order :
▼ ▲ compute.disks.createSnapshot
Flat Path : projects/{project}/zones/{zone}/disks/{disk}/createSnapshot
Parameter Order :
Scopes :
Parameters :
guestFlush
Type : boolean
Description : [Input Only] Whether to attempt an application consistent snapshot by informing the OS to prepare for the snapshot process.
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
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
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.
disk
Description : Name of the persistent disk to snapshot.
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 : POST
Apiversion : 2026-10-01-preview
Path : projects/{project}/zones/{zone}/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.
▼ ▲ compute.disks.bulkSetLabels
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
Required : Yes
Description : The name of the zone for this request.
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}
Location : query
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
Scopes :
Flat Path : projects/{project}/zones/{zone}/disks/bulkSetLabels
Parameter Order :
Apiversion : 2026-10-01-preview
Path : projects/{project}/zones/{zone}/disks/bulkSetLabels
HTTP Method : POST
Description : Sets the labels on many disks at once. To learn more about labels, read theLabeling Resources documentation.
▼ ▲ compute.disks.stopGroupAsyncReplication
HTTP Method : POST
Apiversion : 2026-10-01-preview
Description : Stops asynchronous replication for a consistency group of disks. Can be invoked either in the primary or secondary scope.
Flat Path : projects/{project}/zones/{zone}/disks/stopGroupAsyncReplication
Parameter Order :
Path : projects/{project}/zones/{zone}/disks/stopGroupAsyncReplication
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])?
Location : path
Type : string
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
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
Scopes :
▼ ▲ compute.disks.update
Apiversion : 2026-10-01-preview
HTTP Method : PATCH
Path : projects/{project}/zones/{zone}/disks/{disk}
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.
Flat Path : projects/{project}/zones/{zone}/disks/{disk}
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
paths
Type : string
Location : query
Repeated : Yes
updateMask
Type : string
Format : google-fieldmask
Description : update_mask indicates fields to be updated as part of this request.
Location : query
zone
Description : The name of the zone for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Required : Yes
Type : string
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
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.
▼ ▲ compute.disks.getIamPolicy
HTTP Method : GET
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/zones/{zone}/disks/{resource}/getIamPolicy
Path : projects/{project}/zones/{zone}/disks/{resource}/getIamPolicy
Description : Gets the access control policy for a resource. May be empty if no such policy or resource exists.
Parameter Order :
Parameters :
optionsRequestedPolicyVersion
Format : int32
Description : Requested IAM Policy version.
Location : query
Type : integer
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
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
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
Scopes :
▼ ▲ compute.disks.startAsyncReplication
HTTP Method : POST
Apiversion : 2026-10-01-preview
Description : Starts asynchronous replication. Must be invoked on the primary disk.
Flat Path : projects/{project}/zones/{zone}/disks/{disk}/startAsyncReplication
Path : projects/{project}/zones/{zone}/disks/{disk}/startAsyncReplication
Parameter Order :
Parameters :
disk
Description : The name of the persistent disk.
Type : string
Required : Yes
Location : path
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.
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
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
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.
Scopes :
▼ ▲ compute.disks.testIamPermissions
Scopes :
Parameter Order :
HTTP Method : POST
Apiversion : 2026-10-01-preview
Path : projects/{project}/zones/{zone}/disks/{resource}/testIamPermissions
Flat Path : projects/{project}/zones/{zone}/disks/{resource}/testIamPermissions
Parameters :
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.
Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-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
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.
Description : Returns permissions that a caller has on the specified resource.
▼ ▲ compute.regionSslCertificates.insert
Parameters :
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])?
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
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 :
Path : projects/{project}/regions/{region}/sslCertificates
Flat Path : projects/{project}/regions/{region}/sslCertificates
Scopes :
HTTP Method : POST
Description : Creates a SslCertificate resource in the specified project and region using the data included in the request
Apiversion : 2026-10-01-preview
▼ ▲ compute.regionSslCertificates.delete
HTTP Method : DELETE
Apiversion : 2026-10-01-preview
Description : Deletes the specified SslCertificate resource in the region.
Scopes :
Flat Path : projects/{project}/regions/{region}/sslCertificates/{sslCertificate}
Parameter Order :
Parameters :
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
sslCertificate
Description : Name of the SslCertificate 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}
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Type : string
Required : Yes
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).
Path : projects/{project}/regions/{region}/sslCertificates/{sslCertificate}
▼ ▲ compute.regionSslCertificates.list
Flat Path : projects/{project}/regions/{region}/sslCertificates
Parameter Order :
Path : projects/{project}/regions/{region}/sslCertificates
Apiversion : 2026-10-01-preview
HTTP Method : GET
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
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
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
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.
Type : string
Location : query
region
Location : path
Description : Name of the region scoping this request.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Scopes :
Description : Retrieves the list of SslCertificate resources available to the specified project in the specified region.
▼ ▲ compute.regionSslCertificates.get
HTTP Method : GET
Apiversion : 2026-10-01-preview
Description : Returns the specified SslCertificate resource in the specified region. Get a list of available SSL certificates by making a list() request.
Parameter Order :
Path : projects/{project}/regions/{region}/sslCertificates/{sslCertificate}
Scopes :
Flat Path : projects/{project}/regions/{region}/sslCertificates/{sslCertificate}
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
sslCertificate
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Description : Name of the SslCertificate resource to return.
Required : Yes
Location : path
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
▼ ▲ compute.addresses.move
Path : projects/{project}/regions/{region}/addresses/{address}/move
Parameter Order :
Parameters :
address
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 address resource to move.
project
Type : string
Description : Source project ID which the Address is moved from.
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
Description : An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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])?
Type : string
Location : path
Description : Name of the region for this request.
Required : Yes
Description : Moves the specified address resource.
Flat Path : projects/{project}/regions/{region}/addresses/{address}/move
Apiversion : 2026-10-01-preview
Scopes :
HTTP Method : POST
▼ ▲ compute.addresses.setLabels
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
resource
Description : Name or id of the resource for this request.
Required : Yes
Location : path
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
region
Required : Yes
Location : path
Description : The region for this request.
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
Scopes :
Flat Path : projects/{project}/regions/{region}/addresses/{resource}/setLabels
Parameter Order :
Description : Sets the labels on an Address. To learn more about labels, read theLabeling Resources documentation.
Apiversion : 2026-10-01-preview
Path : projects/{project}/regions/{region}/addresses/{resource}/setLabels
HTTP Method : POST
▼ ▲ compute.addresses.list
Flat Path : projects/{project}/regions/{region}/addresses
Description : Retrieves a list of addresses contained within the specified region.
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
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])?
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
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
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`)
Format : uint32
Minimum : 0
Type : integer
Location : query
Path : projects/{project}/regions/{region}/addresses
Apiversion : 2026-10-01-preview
HTTP Method : GET
Parameter Order :
Scopes :
▼ ▲ compute.addresses.testIamPermissions
Flat Path : projects/{project}/regions/{region}/addresses/{resource}/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
Required : Yes
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.
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 permissions that a caller has on the specified resource.
Scopes :
Path : projects/{project}/regions/{region}/addresses/{resource}/testIamPermissions
Apiversion : 2026-10-01-preview
Parameter Order :
HTTP Method : POST
▼ ▲ compute.addresses.get
HTTP Method : GET
Parameter Order :
Scopes :
Apiversion : 2026-10-01-preview
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
address
Location : path
Description : Name of the address resource to return.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Required : Yes
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}/addresses/{address}
Description : Returns the specified address resource.
Path : projects/{project}/regions/{region}/addresses/{address}
▼ ▲ compute.addresses.insert
Parameter Order :
Path : projects/{project}/regions/{region}/addresses
Parameters :
region
Type : string
Description : Name of the region for this request.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
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.
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 : Creates an address resource in the specified project by using the data included in the request.
Scopes :
Flat Path : projects/{project}/regions/{region}/addresses
Apiversion : 2026-10-01-preview
HTTP Method : POST
▼ ▲ compute.addresses.delete
Parameters :
address
Type : string
Required : Yes
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}
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
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
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}/addresses/{address}
Parameter Order :
Description : Deletes the specified address resource.
Path : projects/{project}/regions/{region}/addresses/{address}
HTTP Method : DELETE
Apiversion : 2026-10-01-preview
Scopes :
▼ ▲ compute.addresses.aggregatedList
Apiversion : 2026-10-01-preview
HTTP Method : GET
Flat Path : projects/{project}/aggregated/addresses
Description : Retrieves an aggregated list of addresses. To prevent failure, it is recommended that you set the `returnPartialSuccess` parameter to `true`.
Path : projects/{project}/aggregated/addresses
Scopes :
Parameter Order : project
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
maxResults
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
Format : uint32
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.
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
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
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
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])?))
▼ ▲ compute.instanceGroupManagers.listErrors
Scopes :
Parameter Order :
Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listErrors
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
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])?))
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`)
Location : query
Minimum : 0
Format : uint32
instanceGroupManager
Type : string
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
Location : path
zone
Description : The name of thezone where the managed instance group is located. It should conform to RFC1035.
Type : string
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
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}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/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.
Apiversion : 2026-10-01-preview
HTTP Method : GET
▼ ▲ compute.instanceGroupManagers.createInstances
Apiversion : 2026-10-01-preview
Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/createInstances
HTTP Method : POST
Scopes :
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.
Flat Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/createInstances
Parameter Order :
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
instanceGroupManager
Type : string
Location : path
Required : Yes
Description : The name of the managed instance group. It should conform to RFC1035.
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).
zone
Type : string
Location : path
Description : The name of thezone where the managed instance group is located. It should conform to RFC1035.
Required : Yes
▼ ▲ compute.instanceGroupManagers.setTargetPools
Scopes :
Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/setTargetPools
HTTP Method : POST
Apiversion : 2026-10-01-preview
Parameters :
zone
Location : path
Required : Yes
Description : The name of thezone where the managed instance group is located.
Type : string
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.
instanceGroupManager
Location : path
Type : string
Description : The name of the managed instance group.
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
Parameter Order :
Flat Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/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.
▼ ▲ compute.instanceGroupManagers.updatePerInstanceConfigs
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.
Flat Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/updatePerInstanceConfigs
Parameter Order :
Apiversion : 2026-10-01-preview
Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/updatePerInstanceConfigs
HTTP Method : POST
Parameters :
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
Description : An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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
Required : Yes
Description : The name of the managed instance group. It should conform to RFC1035.
Type : string
zone
Description : The name of thezone where the managed instance group is located. It should conform to RFC1035.
Type : string
Location : path
Required : Yes
Scopes :
▼ ▲ compute.instanceGroupManagers.resumeInstances
HTTP Method : POST
Apiversion : 2026-10-01-preview
Scopes :
Flat Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resumeInstances
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.
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).
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
zone
Description : The name of thezone where the managed instance group is located.
Location : path
Required : Yes
Type : string
instanceGroupManager
Required : Yes
Location : path
Type : string
Description : The name of the managed instance group.
▼ ▲ compute.instanceGroupManagers.aggregatedList
Parameter Order : project
Flat Path : projects/{project}/aggregated/instanceGroupManagers
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
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
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
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
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 : Project ID for this request.
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 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
Apiversion : 2026-10-01-preview
Path : projects/{project}/aggregated/instanceGroupManagers
▼ ▲ 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.
Parameters :
zone
Description : The name of the zone where you want to create the managed instance group.
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).
instanceGroupManager
Type : string
Description : The name of the instance group manager.
Required : Yes
Location : path
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])?))
Parameter Order :
Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}
Apiversion : 2026-10-01-preview
Scopes :
Flat Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}
HTTP Method : PATCH
▼ ▲ compute.instanceGroupManagers.list
Flat Path : projects/{project}/zones/{zone}/instanceGroupManagers
Parameter Order :
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
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.
zone
Description : The name of thezone where the managed instance group is located.
Location : path
Required : Yes
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
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`)
Default : 500
Location : query
Format : uint32
Minimum : 0
Type : integer
Scopes :
Apiversion : 2026-10-01-preview
Description : Retrieves a list of managed instance groups that are contained within the specified project and zone.
Path : projects/{project}/zones/{zone}/instanceGroupManagers
HTTP Method : GET
▼ ▲ compute.instanceGroupManagers.delete
HTTP Method : DELETE
Apiversion : 2026-10-01-preview
Scopes :
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.
Flat Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}
Parameter Order :
Parameters :
zone
Location : path
Type : string
Required : Yes
Description : The name of thezone where the managed instance group is located.
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).
noGracefulShutdown
Default : false
Location : query
Description : When set, graceful shutdown is skipped for instance deletion even if it's configured for the instances.
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])?))
Location : path
Type : string
Description : Project ID for this request.
instanceGroupManager
Location : path
Required : Yes
Type : string
Description : The name of the managed instance group to delete.
Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}
▼ ▲ compute.instanceGroupManagers.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.
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 thezone where the managed instance group is located.
Location : path
Required : Yes
Type : string
instanceGroupManager
Location : path
Required : Yes
Type : string
Description : The name of the managed instance group.
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
Apiversion : 2026-10-01-preview
Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/suspendInstances
HTTP Method : POST
Parameter Order :
Scopes :
▼ ▲ compute.instanceGroupManagers.abandonInstances
Parameter Order :
Flat Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/abandonInstances
Parameters :
zone
Description : The name of thezone where the managed instance group is located.
Type : string
Location : path
Required : Yes
instanceGroupManager
Required : Yes
Location : path
Type : string
Description : The name of the managed instance group.
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.
Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-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
Scopes :
Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/abandonInstances
Apiversion : 2026-10-01-preview
HTTP Method : POST
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.
▼ ▲ compute.instanceGroupManagers.deleteInstances
Apiversion : 2026-10-01-preview
HTTP Method : POST
Parameter Order :
Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/deleteInstances
Scopes :
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.
Flat Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/deleteInstances
Parameters :
noGracefulShutdown
Location : query
Description : When set, graceful shutdown is skipped for instance deletion even if it's configured for the instances.
Default : false
Type : boolean
instanceGroupManager
Location : path
Required : Yes
Type : string
Description : The name of the managed instance group.
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
Location : path
Description : The name of thezone where the managed instance group is located.
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
▼ ▲ compute.instanceGroupManagers.stopInstances
Parameter Order :
Scopes :
Apiversion : 2026-10-01-preview
HTTP Method : POST
Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/stopInstances
Parameters :
noGracefulShutdown
Default : false
Description : When set, graceful shutdown is skipped for instance stopping even if it's configured for the instances.
Location : query
Type : boolean
zone
Location : path
Description : The name of thezone where the managed instance group is located.
Required : Yes
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
instanceGroupManager
Description : The name of the managed instance group.
Location : path
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
Flat Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/stopInstances
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.
▼ ▲ compute.instanceGroupManagers.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.
Scopes :
Parameter Order :
Parameters :
instanceGroupManager
Location : path
Description : The name of the managed instance group.
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])?))
Required : Yes
Description : Project ID for this request.
Location : path
zone
Description : The name of thezone where the managed instance group is located.
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
HTTP Method : POST
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/startInstances
Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/startInstances
▼ ▲ compute.instanceGroupManagers.recreateInstances
Parameter Order :
Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/recreateInstances
HTTP Method : POST
Scopes :
Flat Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/recreateInstances
Apiversion : 2026-10-01-preview
Parameters :
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
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
Location : path
Description : The name of thezone where the managed instance group is located.
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
Description : Project ID for this request.
Required : Yes
instanceGroupManager
Description : The name of the managed instance group.
Location : path
Type : string
Required : Yes
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.instanceGroupManagers.applyUpdatesToInstances
Parameter Order :
Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/applyUpdatesToInstances
Parameters :
instanceGroupManager
Description : The name of the managed instance group, should conform to RFC1035.
Location : path
Type : string
Required : Yes
zone
Location : path
Type : string
Required : Yes
Description : The name of thezone where the managed instance group is located. Should conform to RFC1035.
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
Scopes :
Description : Applies changes to selected instances on the managed instance group. This method can be used to apply new overrides and/or new versions.
HTTP Method : POST
Flat Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/applyUpdatesToInstances
Apiversion : 2026-10-01-preview
▼ ▲ compute.instanceGroupManagers.listPerInstanceConfigs
Parameter Order :
HTTP Method : POST
Scopes :
Description : Lists all of the per-instance configurations defined for the managed instance group. The orderBy query parameter is not supported.
Apiversion : 2026-10-01-preview
Parameters :
maxResults
Type : integer
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`)
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
zone
Description : The name of thezone where the managed instance group is located. It should conform to RFC1035.
Required : Yes
Location : path
Type : string
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
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
instanceGroupManager
Type : string
Location : path
Required : Yes
Description : The name of the managed instance group. It should conform to RFC1035.
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}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listPerInstanceConfigs
Flat Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listPerInstanceConfigs
▼ ▲ compute.instanceGroupManagers.listManagedInstances
HTTP Method : POST
Apiversion : 2026-10-01-preview
Parameters :
zone
Type : string
Location : path
Description : The name of thezone where the managed instance group is located.
Required : Yes
maxResults
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`)
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])?))
Location : path
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
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
Description : The name of the managed instance group.
Type : string
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.
Type : string
Location : query
Scopes :
Flat Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listManagedInstances
Parameter Order :
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`.
▼ ▲ compute.instanceGroupManagers.setInstanceTemplate
Apiversion : 2026-10-01-preview
HTTP Method : POST
Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/setInstanceTemplate
Parameter Order :
Scopes :
Flat 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.
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
Type : string
Description : The name of the managed instance group.
Location : path
Required : Yes
zone
Required : Yes
Type : string
Description : The name of thezone where the managed instance group is located.
Location : path
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])?))
▼ ▲ compute.instanceGroupManagers.patchPerInstanceConfigs
HTTP Method : POST
Apiversion : 2026-10-01-preview
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.
Scopes :
Flat Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/patchPerInstanceConfigs
Parameter Order :
Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/patchPerInstanceConfigs
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
Type : string
Location : path
Required : Yes
Description : The name of thezone where the managed instance group is located. It should conform to RFC1035.
instanceGroupManager
Location : path
Type : string
Required : Yes
Description : The name of the managed instance group. It should conform to RFC1035.
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])?))
▼ ▲ compute.instanceGroupManagers.deletePerInstanceConfigs
Parameter Order :
Flat Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/deletePerInstanceConfigs
Parameters :
instanceGroupManager
Type : string
Description : The name of the managed instance group. It should conform to RFC1035.
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
zone
Required : Yes
Description : The name of thezone where the managed instance group is located. It should conform to RFC1035.
Location : path
Type : string
Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/deletePerInstanceConfigs
Description : Deletes selected per-instance configurations for the managed instance group.
Apiversion : 2026-10-01-preview
HTTP Method : POST
Scopes :
▼ ▲ compute.instanceGroupManagers.insert
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
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
zone
Type : string
Description : The name of the zone where you want to create the managed instance group.
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
HTTP Method : POST
Path : projects/{project}/zones/{zone}/instanceGroupManagers
Parameter Order :
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/zones/{zone}/instanceGroupManagers
Scopes :
▼ ▲ compute.instanceGroupManagers.resize
Apiversion : 2026-10-01-preview
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.
HTTP Method : POST
Scopes :
Parameter Order :
Flat Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resize
Parameters :
zone
Type : string
Required : Yes
Location : path
Description : The name of thezone where the managed instance group is located.
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
Description : The name of the managed instance group.
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
size
Location : query
Format : int32
Required : Yes
Type : integer
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.
Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resize
▼ ▲ compute.instanceGroupManagers.get
Parameter Order :
Description : Returns all of the details about the specified managed instance group.
Parameters :
zone
Description : The name of thezone where the managed instance group is located.
Type : string
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])?))
Type : string
Required : Yes
Description : Project ID for this request.
Location : path
instanceGroupManager
Type : string
Required : Yes
Description : The name of the managed instance group.
Location : path
Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}
Scopes :
Flat Path : projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}
Apiversion : 2026-10-01-preview
HTTP Method : GET
▼ ▲ compute.interconnectGroups.insert
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
Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-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
Scopes :
Path : projects/{project}/global/interconnectGroups
Parameter Order : project
HTTP Method : POST
Flat Path : projects/{project}/global/interconnectGroups
Description : Creates a InterconnectGroup in the specified project in the given scope using the parameters that are included in the request.
Apiversion : 2026-10-01-preview
▼ ▲ compute.interconnectGroups.delete
Description : Deletes the specified InterconnectGroup in the given scope
Parameters :
interconnectGroup
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 InterconnectGroup resource to delete.
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
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.
Scopes :
HTTP Method : DELETE
Flat Path : projects/{project}/global/interconnectGroups/{interconnectGroup}
Apiversion : 2026-10-01-preview
Parameter Order :
Path : projects/{project}/global/interconnectGroups/{interconnectGroup}
▼ ▲ compute.interconnectGroups.patch
Parameter Order :
Apiversion : 2026-10-01-preview
HTTP Method : PATCH
Path : projects/{project}/global/interconnectGroups/{interconnectGroup}
Flat Path : projects/{project}/global/interconnectGroups/{interconnectGroup}
Scopes :
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.
Parameters :
interconnectGroup
Description : Name of the InterconnectGroup resource to patch.
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
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])?))
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
updateMask
Format : google-fieldmask
Type : string
Location : query
Description : The list of fields to update.
▼ ▲ compute.interconnectGroups.getOperationalStatus
Flat Path : projects/{project}/global/interconnectGroups/{interconnectGroup}/getOperationalStatus
Parameters :
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])?))
interconnectGroup
Location : path
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}
Type : string
Required : Yes
Scopes :
Parameter Order :
HTTP Method : GET
Path : projects/{project}/global/interconnectGroups/{interconnectGroup}/getOperationalStatus
Apiversion : 2026-10-01-preview
Description : Returns the interconnectStatuses for the specified InterconnectGroup.
▼ ▲ compute.interconnectGroups.list
HTTP Method : GET
Scopes :
Apiversion : 2026-10-01-preview
Path : projects/{project}/global/interconnectGroups
Parameter Order : project
Description : Lists the InterconnectGroups for a project in the given scope.
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.
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])?))
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
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
Location : query
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.
Flat Path : projects/{project}/global/interconnectGroups
▼ ▲ compute.interconnectGroups.testIamPermissions
Scopes :
Path : projects/{project}/global/interconnectGroups/{resource}/testIamPermissions
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])?))
resource
Description : Name or id of the resource 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}
Apiversion : 2026-10-01-preview
HTTP Method : POST
Description : Returns permissions that a caller has on the specified resource.
Flat Path : projects/{project}/global/interconnectGroups/{resource}/testIamPermissions
▼ ▲ compute.interconnectGroups.getIamPolicy
Description : Gets the access control policy for a resource. May be empty if no such policy or resource exists.
HTTP Method : GET
Apiversion : 2026-10-01-preview
Scopes :
Parameter Order :
Path : projects/{project}/global/interconnectGroups/{resource}/getIamPolicy
Parameters :
resource
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.
Location : path
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])?))
Location : path
Required : Yes
optionsRequestedPolicyVersion
Format : int32
Type : integer
Description : Requested IAM Policy version.
Location : query
Flat Path : projects/{project}/global/interconnectGroups/{resource}/getIamPolicy
▼ ▲ compute.interconnectGroups.get
Apiversion : 2026-10-01-preview
Parameter Order :
Path : projects/{project}/global/interconnectGroups/{interconnectGroup}
HTTP Method : GET
Flat Path : projects/{project}/global/interconnectGroups/{interconnectGroup}
Description : Returns the specified InterconnectGroup resource in the given scope.
Scopes :
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}
Required : Yes
Description : Name of the InterconnectGroup resource to return.
Location : path
Type : string
▼ ▲ compute.interconnectGroups.createMembers
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
Description : Project ID for this request.
Location : path
interconnectGroup
Location : path
Type : string
Description : Name of the group resource to create members for.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Scopes :
Description : Create Interconnects with redundancy by creating them in a specified interconnect group.
Flat Path : projects/{project}/global/interconnectGroups/{interconnectGroup}/createMembers
HTTP Method : POST
Apiversion : 2026-10-01-preview
Parameter Order :
Path : projects/{project}/global/interconnectGroups/{interconnectGroup}/createMembers
▼ ▲ compute.interconnectGroups.setIamPolicy
Description : Sets the access control policy on the specified resource. Replaces any existing policy.
HTTP Method : POST
Apiversion : 2026-10-01-preview
Scopes :
Parameter Order :
Path : projects/{project}/global/interconnectGroups/{resource}/setIamPolicy
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
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
Flat Path : projects/{project}/global/interconnectGroups/{resource}/setIamPolicy
▼ ▲ compute.firewalls.insert
HTTP Method : POST
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/global/firewalls
Parameter Order : project
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
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 firewall rule in the specified project using the data included in the request.
Path : projects/{project}/global/firewalls
Scopes :
▼ ▲ compute.firewalls.delete
Description : Deletes the specified firewall.
Parameter Order :
Apiversion : 2026-10-01-preview
Path : projects/{project}/global/firewalls/{firewall}
HTTP Method : DELETE
Scopes :
Flat Path : projects/{project}/global/firewalls/{firewall}
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
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])?))
firewall
Location : path
Description : Name of the firewall rule to delete.
Type : string
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
▼ ▲ compute.firewalls.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.
Required : Yes
Type : string
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
Location : query
Type : integer
Format : uint32
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.
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
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
Description : Retrieves the list of firewall rules available to the specified project.
Parameter Order : project
Path : projects/{project}/global/firewalls
Flat Path : projects/{project}/global/firewalls
HTTP Method : GET
Scopes :
Apiversion : 2026-10-01-preview
▼ ▲ compute.firewalls.patch
HTTP Method : PATCH
Apiversion : 2026-10-01-preview
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.
Parameter Order :
Parameters :
firewall
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 firewall rule to patch.
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
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])?))
Path : projects/{project}/global/firewalls/{firewall}
Scopes :
▼ ▲ compute.firewalls.get
HTTP Method : GET
Flat Path : projects/{project}/global/firewalls/{firewall}
Parameter Order :
Apiversion : 2026-10-01-preview
Description : Returns the specified firewall.
Parameters :
firewall
Required : Yes
Description : Name of the firewall rule to return.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
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])?))
Type : string
Location : path
Description : Project ID for this request.
Path : projects/{project}/global/firewalls/{firewall}
Scopes :
▼ ▲ compute.firewalls.testIamPermissions
Path : projects/{project}/global/firewalls/{resource}/testIamPermissions
Scopes :
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.
Type : string
Required : Yes
Location : path
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])?))
Location : path
Required : Yes
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/global/firewalls/{resource}/testIamPermissions
HTTP Method : POST
Description : Returns permissions that a caller has on the specified resource.
Parameter Order :
▼ ▲ compute.firewalls.update
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.
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/global/firewalls/{firewall}
HTTP Method : PUT
Scopes :
Parameters :
firewall
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Description : Name of the firewall rule to update.
Location : path
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.
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/firewalls/{firewall}
Parameter Order :
▼ ▲ compute.globalOperations.aggregatedList
Scopes :
Flat Path : projects/{project}/aggregated/operations
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
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
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
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
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
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
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
Description : Retrieves an aggregated list of all operations. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.
Apiversion : 2026-10-01-preview
Parameter Order : project
HTTP Method : GET
Path : projects/{project}/aggregated/operations
▼ ▲ compute.globalOperations.get
Path : projects/{project}/global/operations/{operation}
Parameter Order :
HTTP Method : GET
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/global/operations/{operation}
Parameters :
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
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])?))
Scopes :
Description : Retrieves the specified Operations resource.
▼ ▲ compute.globalOperations.delete
Apiversion : 2026-10-01-preview
HTTP Method : DELETE
Scopes :
Flat Path : projects/{project}/global/operations/{operation}
Parameter Order :
Description : Deletes the specified Operations resource.
Parameters :
operation
Description : Name of the Operations resource to delete, 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
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
Path : projects/{project}/global/operations/{operation}
▼ ▲ compute.globalOperations.list
Description : Retrieves a list of Operation resources contained within the specified project.
Scopes :
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
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`)
Minimum : 0
Location : query
Format : uint32
Type : integer
Default : 500
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])?))
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}/global/operations
HTTP Method : GET
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/global/operations
Parameter Order : project
▼ ▲ compute.globalOperations.wait
HTTP Method : POST
Apiversion : 2026-10-01-preview
Path : projects/{project}/global/operations/{operation}/wait
Parameters :
operation
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 Operations resource to return, or its unique numeric identifier.
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.
Flat Path : projects/{project}/global/operations/{operation}/wait
Parameter Order :
Scopes :
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`.
▼ ▲ compute.interconnectAttachments.insert
Scopes :
Path : projects/{project}/regions/{region}/interconnectAttachments
Apiversion : 2026-10-01-preview
HTTP Method : POST
Description : Creates an InterconnectAttachment in the specified project using the data included in the request.
Flat Path : projects/{project}/regions/{region}/interconnectAttachments
Parameters :
validateOnly
Description : If true, the request will not be committed.
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).
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
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])?
Parameter Order :
▼ ▲ compute.interconnectAttachments.delete
HTTP Method : DELETE
Scopes :
Apiversion : 2026-10-01-preview
Parameter Order :
Description : Deletes the specified interconnect attachment.
Path : projects/{project}/regions/{region}/interconnectAttachments/{interconnectAttachment}
Flat Path : projects/{project}/regions/{region}/interconnectAttachments/{interconnectAttachment}
Parameters :
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Type : string
Required : Yes
Description : Name of the region for this request.
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])?))
interconnectAttachment
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 interconnect attachment to delete.
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
▼ ▲ compute.interconnectAttachments.patch
Path : projects/{project}/regions/{region}/interconnectAttachments/{interconnectAttachment}
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])?))
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
interconnectAttachment
Location : path
Description : Name of the interconnect attachment to patch.
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])?
Location : path
Type : string
Required : Yes
Apiversion : 2026-10-01-preview
Scopes :
Flat Path : projects/{project}/regions/{region}/interconnectAttachments/{interconnectAttachment}
HTTP Method : 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.
▼ ▲ compute.interconnectAttachments.get
Scopes :
Description : Returns the specified interconnect attachment.
Parameters :
interconnectAttachment
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 interconnect attachment to return.
Required : Yes
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Type : string
Required : Yes
Description : Name of the region for this request.
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
HTTP Method : GET
Path : projects/{project}/regions/{region}/interconnectAttachments/{interconnectAttachment}
Parameter Order :
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/regions/{region}/interconnectAttachments/{interconnectAttachment}
▼ ▲ compute.interconnectAttachments.aggregatedList
Apiversion : 2026-10-01-preview
Parameter Order : project
HTTP Method : GET
Scopes :
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
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
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
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
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
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
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.
Description : Retrieves an aggregated list of interconnect attachments. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.
Path : projects/{project}/aggregated/interconnectAttachments
Flat Path : projects/{project}/aggregated/interconnectAttachments
▼ ▲ compute.interconnectAttachments.setLabels
Parameters :
resource
Location : path
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}
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
Type : string
Description : The region for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
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
Parameter Order :
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/regions/{region}/interconnectAttachments/{resource}/setLabels
HTTP Method : POST
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.
Scopes :
▼ ▲ compute.interconnectAttachments.list
Path : projects/{project}/regions/{region}/interconnectAttachments
Flat Path : projects/{project}/regions/{region}/interconnectAttachments
Scopes :
HTTP Method : GET
Apiversion : 2026-10-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
region
Description : Name of the region for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
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
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
Type : integer
Minimum : 0
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])?))
Description : Project ID for this request.
Required : Yes
Type : string
Location : path
Description : Retrieves the list of interconnect attachments contained within the specified region.
Parameter Order :
▼ ▲ compute.globalVmExtensionPolicies.aggregatedList
Flat Path : projects/{project}/aggregated/vmExtensionPolicies
Parameter Order : project
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.
project
Required : Yes
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
Type : string
maxResults
Minimum : 0
Location : query
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`)
Format : uint32
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
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
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.
Path : projects/{project}/aggregated/vmExtensionPolicies
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`.
Apiversion : 2026-10-01-preview
HTTP Method : GET
Scopes :
▼ ▲ compute.globalVmExtensionPolicies.insert
Scopes :
Parameter Order : project
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/global/vmExtensionPolicies
Description : Creates a new project level GlobalVmExtensionPolicy.
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
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])?))
Path : projects/{project}/global/vmExtensionPolicies
▼ ▲ compute.globalVmExtensionPolicies.delete
Apiversion : 2026-10-01-preview
HTTP Method : POST
Scopes :
Path : projects/{project}/global/vmExtensionPolicies/{globalVmExtensionPolicy}/delete
Flat 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.
Parameter Order :
Parameters :
globalVmExtensionPolicy
Required : Yes
Description : Name of the global VM extension policy to purge scoped resources for.
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
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
▼ ▲ compute.globalVmExtensionPolicies.list
Apiversion : 2026-10-01-preview
HTTP Method : GET
Parameter Order : project
Path : projects/{project}/global/vmExtensionPolicies
Scopes :
Description : Lists global VM extension policies.
Flat Path : projects/{project}/global/vmExtensionPolicies
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
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`)
Location : query
Type : integer
Default : 500
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.
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])?))
Required : Yes
Type : string
Location : path
Description : Project ID for this request.
▼ ▲ compute.globalVmExtensionPolicies.get
HTTP Method : GET
Apiversion : 2026-10-01-preview
Parameter Order :
Flat Path : projects/{project}/global/vmExtensionPolicies/{globalVmExtensionPolicy}
Scopes :
Parameters :
globalVmExtensionPolicy
Description : Name of the GlobalVmExtensionPolicy resource to return.
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.
Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-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 : Gets details of a global VM extension policy.
Path : projects/{project}/global/vmExtensionPolicies/{globalVmExtensionPolicy}
▼ ▲ compute.globalVmExtensionPolicies.update
HTTP Method : PATCH
Scopes :
Apiversion : 2026-10-01-preview
Description : Updates a global VM extension policy.
Flat Path : projects/{project}/global/vmExtensionPolicies/{globalVmExtensionPolicy}
Path : projects/{project}/global/vmExtensionPolicies/{globalVmExtensionPolicy}
Parameter Order :
Parameters :
globalVmExtensionPolicy
Required : Yes
Description : Name of the global VM extension policy to update.
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
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.zoneOperations.wait
Parameter Order :
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
operation
Type : string
Location : path
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}
zone
Location : path
Required : Yes
Description : Name of the zone for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
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 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`.
Flat Path : projects/{project}/zones/{zone}/operations/{operation}/wait
Apiversion : 2026-10-01-preview
Path : projects/{project}/zones/{zone}/operations/{operation}/wait
▼ ▲ compute.zoneOperations.list
Flat Path : projects/{project}/zones/{zone}/operations
Description : Retrieves a list of Operation resources contained within the specified zone.
Parameters :
zone
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Description : Name of the zone for request.
Location : path
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
maxResults
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`)
Location : query
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.
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
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
Parameter Order :
Apiversion : 2026-10-01-preview
Path : projects/{project}/zones/{zone}/operations
Scopes :
HTTP Method : GET
▼ ▲ compute.zoneOperations.delete
Apiversion : 2026-10-01-preview
HTTP Method : DELETE
Flat Path : projects/{project}/zones/{zone}/operations/{operation}
Parameter Order :
Description : Deletes the specified zone-specific Operations resource.
Path : projects/{project}/zones/{zone}/operations/{operation}
Scopes :
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
zone
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Description : Name of the zone for this request.
Required : Yes
Type : string
operation
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 Operations resource to delete, or its unique numeric identifier.
▼ ▲ compute.zoneOperations.get
Parameter Order :
Path : projects/{project}/zones/{zone}/operations/{operation}
Parameters :
operation
Description : Name of the Operations resource to return, or its unique numeric identifier.
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
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.
zone
Type : string
Location : path
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Name of the zone for this request.
Apiversion : 2026-10-01-preview
Description : Retrieves the specified zone-specific Operations resource.
HTTP Method : GET
Flat Path : projects/{project}/zones/{zone}/operations/{operation}
Scopes :
▼ ▲ compute.serviceAttachments.testIamPermissions
Path : projects/{project}/regions/{region}/serviceAttachments/{resource}/testIamPermissions
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
Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-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
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.
Required : Yes
Description : Returns permissions that a caller has on the specified resource.
Flat Path : projects/{project}/regions/{region}/serviceAttachments/{resource}/testIamPermissions
Scopes :
HTTP Method : POST
Parameter Order :
Apiversion : 2026-10-01-preview
▼ ▲ compute.serviceAttachments.insert
Flat Path : projects/{project}/regions/{region}/serviceAttachments
Parameters :
region
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Name of the region of this request.
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
Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-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
Path : projects/{project}/regions/{region}/serviceAttachments
Apiversion : 2026-10-01-preview
HTTP Method : POST
Description : Creates a ServiceAttachment in the specified project in the given scope using the parameters that are included in the request.
Parameter Order :
Scopes :
▼ ▲ compute.serviceAttachments.delete
HTTP Method : DELETE
Apiversion : 2026-10-01-preview
Parameter Order :
Flat Path : projects/{project}/regions/{region}/serviceAttachments/{serviceAttachment}
Path : projects/{project}/regions/{region}/serviceAttachments/{serviceAttachment}
Scopes :
Parameters :
serviceAttachment
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the ServiceAttachment resource to delete.
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).
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
Description : Name of the region of this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Location : path
Type : string
Description : Deletes the specified ServiceAttachment in the given scope
▼ ▲ compute.serviceAttachments.patch
Parameter Order :
Path : projects/{project}/regions/{region}/serviceAttachments/{serviceAttachment}
Parameters :
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.
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
region
Required : Yes
Type : string
Location : path
Description : The region scoping this request and 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
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.
Scopes :
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/regions/{region}/serviceAttachments/{serviceAttachment}
HTTP Method : PATCH
▼ ▲ compute.serviceAttachments.get
Description : Returns the specified ServiceAttachment resource in the given scope.
Parameters :
showNatIps
Location : query
Type : boolean
Description : Indicates whether NAT IPs should be included in the response.
region
Location : path
Type : string
Description : Name of the region of this request.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
serviceAttachment
Description : Name of the ServiceAttachment resource to return.
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
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])?))
Scopes :
Path : projects/{project}/regions/{region}/serviceAttachments/{serviceAttachment}
Flat Path : projects/{project}/regions/{region}/serviceAttachments/{serviceAttachment}
Parameter Order :
HTTP Method : GET
Apiversion : 2026-10-01-preview
▼ ▲ compute.serviceAttachments.setIamPolicy
Flat Path : projects/{project}/regions/{region}/serviceAttachments/{resource}/setIamPolicy
Parameters :
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
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
Location : path
Type : string
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}
Path : projects/{project}/regions/{region}/serviceAttachments/{resource}/setIamPolicy
Parameter Order :
Description : Sets the access control policy on the specified resource. Replaces any existing policy.
Scopes :
Apiversion : 2026-10-01-preview
HTTP Method : POST
▼ ▲ compute.serviceAttachments.aggregatedList
Flat Path : projects/{project}/aggregated/serviceAttachments
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`.
Scopes :
Parameters :
maxResults
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`)
Minimum : 0
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
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
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
Type : string
Location : path
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
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
HTTP Method : GET
Apiversion : 2026-10-01-preview
Parameter Order : project
Path : projects/{project}/aggregated/serviceAttachments
▼ ▲ compute.serviceAttachments.list
Flat Path : projects/{project}/regions/{region}/serviceAttachments
Parameter Order :
HTTP Method : GET
Apiversion : 2026-10-01-preview
Description : Lists the ServiceAttachments for a project in the given scope.
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
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
region
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Description : Name of the region of this request.
Type : string
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])?))
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
Scopes :
Path : projects/{project}/regions/{region}/serviceAttachments
▼ ▲ compute.serviceAttachments.getIamPolicy
Path : projects/{project}/regions/{region}/serviceAttachments/{resource}/getIamPolicy
HTTP Method : GET
Description : Gets the access control policy for a resource. May be empty if no such policy or resource exists.
Apiversion : 2026-10-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])?))
Description : Project ID for this request.
Type : string
optionsRequestedPolicyVersion
Type : integer
Description : Requested IAM Policy version.
Format : int32
Location : query
resource
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.
Required : Yes
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
Scopes :
Parameter Order :
Flat Path : projects/{project}/regions/{region}/serviceAttachments/{resource}/getIamPolicy
▼ ▲ compute.instanceTemplates.get
Parameters :
instanceTemplate
Type : string
Description : The name of the instance template.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Required : Yes
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])?))
Parameter Order :
Apiversion : 2026-10-01-preview
Path : projects/{project}/global/instanceTemplates/{instanceTemplate}
HTTP Method : GET
Flat Path : projects/{project}/global/instanceTemplates/{instanceTemplate}
Description : Returns the specified instance template.
Scopes :
▼ ▲ compute.instanceTemplates.setIamPolicy
Flat Path : projects/{project}/global/instanceTemplates/{resource}/setIamPolicy
Scopes :
Parameters :
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.
Required : Yes
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
Parameter Order :
Apiversion : 2026-10-01-preview
Path : projects/{project}/global/instanceTemplates/{resource}/setIamPolicy
HTTP Method : POST
Description : Sets the access control policy on the specified resource. Replaces any existing policy.
▼ ▲ compute.instanceTemplates.list
Scopes :
Path : projects/{project}/global/instanceTemplates
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`)
Format : uint32
Default : 500
Type : integer
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])?))
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.
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.
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
Parameter Order : project
Flat Path : projects/{project}/global/instanceTemplates
Apiversion : 2026-10-01-preview
Description : Retrieves a list of instance templates that are contained within the specified project.
HTTP Method : GET
▼ ▲ compute.instanceTemplates.insert
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.
HTTP Method : POST
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/global/instanceTemplates
Scopes :
Parameter Order : project
Path : projects/{project}/global/instanceTemplates
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
Description : An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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.instanceTemplates.delete
Parameters :
instanceTemplate
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Type : string
Location : path
Description : The name of the instance template 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).
Location : query
Type : string
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])?))
Flat Path : projects/{project}/global/instanceTemplates/{instanceTemplate}
Scopes :
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.
Parameter Order :
Path : projects/{project}/global/instanceTemplates/{instanceTemplate}
Apiversion : 2026-10-01-preview
HTTP Method : DELETE
▼ ▲ compute.instanceTemplates.getIamPolicy
Scopes :
Path : projects/{project}/global/instanceTemplates/{resource}/getIamPolicy
Description : Gets the access control policy for a resource. May be empty if no such policy or resource exists.
Apiversion : 2026-10-01-preview
HTTP Method : GET
Parameter Order :
Parameters :
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
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
optionsRequestedPolicyVersion
Location : query
Format : int32
Type : integer
Description : Requested IAM Policy version.
Flat Path : projects/{project}/global/instanceTemplates/{resource}/getIamPolicy
▼ ▲ compute.instanceTemplates.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])?))
Required : Yes
Description : Project ID 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}
Description : Name or id of the resource for this request.
Required : Yes
Type : string
Location : path
Scopes :
HTTP Method : POST
Parameter Order :
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/global/instanceTemplates/{resource}/testIamPermissions
Path : projects/{project}/global/instanceTemplates/{resource}/testIamPermissions
▼ ▲ compute.instanceTemplates.aggregatedList
HTTP Method : GET
Path : projects/{project}/aggregated/instanceTemplates
Apiversion : 2026-10-01-preview
Scopes :
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.
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
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
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
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
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.
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
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`.
Flat Path : projects/{project}/aggregated/instanceTemplates
▼ ▲ compute.snapshots.testIamPermissions
Flat Path : projects/{project}/global/snapshots/{resource}/testIamPermissions
Parameter Order :
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
Description : Name or id of the resource 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}
Path : projects/{project}/global/snapshots/{resource}/testIamPermissions
Scopes :
HTTP Method : POST
Apiversion : 2026-10-01-preview
Description : Returns permissions that a caller has on the specified resource.
▼ ▲ compute.snapshots.insert
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.
Apiversion : 2026-10-01-preview
HTTP Method : POST
Parameter Order : project
Flat Path : projects/{project}/global/snapshots
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
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
Scopes :
Path : projects/{project}/global/snapshots
▼ ▲ compute.snapshots.delete
Parameter Order :
Parameters :
snapshot
Required : Yes
Type : string
Location : path
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}
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
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).
HTTP Method : DELETE
Scopes :
Apiversion : 2026-10-01-preview
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.
Path : projects/{project}/global/snapshots/{snapshot}
Flat Path : projects/{project}/global/snapshots/{snapshot}
▼ ▲ compute.snapshots.get
Parameter Order :
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.
snapshot
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 Snapshot resource to return.
Location : path
Apiversion : 2026-10-01-preview
Description : Returns the specified Snapshot resource.
Scopes :
HTTP Method : GET
Flat Path : projects/{project}/global/snapshots/{snapshot}
Path : projects/{project}/global/snapshots/{snapshot}
▼ ▲ compute.snapshots.getIamPolicy
Parameters :
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.
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}
optionsRequestedPolicyVersion
Format : int32
Description : Requested IAM Policy version.
Location : query
Type : integer
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/snapshots/{resource}/getIamPolicy
HTTP Method : GET
Scopes :
Apiversion : 2026-10-01-preview
Path : projects/{project}/global/snapshots/{resource}/getIamPolicy
▼ ▲ compute.snapshots.setLabels
Path : projects/{project}/global/snapshots/{resource}/setLabels
HTTP Method : POST
Description : Sets the labels on a snapshot. To learn more about labels, read theLabeling Resources documentation.
Apiversion : 2026-10-01-preview
Scopes :
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
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.
Flat Path : projects/{project}/global/snapshots/{resource}/setLabels
Parameter Order :
▼ ▲ compute.snapshots.list
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.
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
Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-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
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
Minimum : 0
Type : integer
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`)
Format : uint32
Apiversion : 2026-10-01-preview
HTTP Method : GET
Path : projects/{project}/global/snapshots
Description : Retrieves the list of Snapshot resources contained within the specified project.
Parameter Order : project
Flat Path : projects/{project}/global/snapshots
▼ ▲ compute.snapshots.updateKmsKey
HTTP Method : POST
Apiversion : 2026-10-01-preview
Scopes :
Description : Rotates the customer-managed encryption key to the latest version for the specified snapshot.
Flat Path : projects/{project}/global/snapshots/{snapshot}/updateKmsKey
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
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.
snapshot
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Description : Name of the snapshot resource to update. Should conform to RFC1035.
Type : string
Required : Yes
Path : projects/{project}/global/snapshots/{snapshot}/updateKmsKey
▼ ▲ compute.snapshots.setIamPolicy
Description : Sets the access control policy on the specified resource. Replaces any existing policy.
Parameter Order :
Scopes :
Flat Path : projects/{project}/global/snapshots/{resource}/setIamPolicy
Parameters :
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
Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-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.
Path : projects/{project}/global/snapshots/{resource}/setIamPolicy
HTTP Method : POST
Apiversion : 2026-10-01-preview
▼ ▲ compute.externalVpnGateways.insert
Flat Path : projects/{project}/global/externalVpnGateways
Path : projects/{project}/global/externalVpnGateways
Parameter Order : project
HTTP Method : POST
Description : Creates a ExternalVpnGateway in the specified project using the data included in the request.
Apiversion : 2026-10-01-preview
Scopes :
Parameters :
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
Description : An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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.externalVpnGateways.delete
Scopes :
Flat Path : projects/{project}/global/externalVpnGateways/{externalVpnGateway}
HTTP Method : DELETE
Apiversion : 2026-10-01-preview
Description : Deletes the specified externalVpnGateway.
Path : projects/{project}/global/externalVpnGateways/{externalVpnGateway}
Parameter Order :
Parameters :
externalVpnGateway
Type : string
Description : Name of the externalVpnGateways to delete.
Required : Yes
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
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.externalVpnGateways.list
Apiversion : 2026-10-01-preview
Scopes :
HTTP Method : GET
Parameter Order : project
Path : projects/{project}/global/externalVpnGateways
Flat Path : projects/{project}/global/externalVpnGateways
Description : Retrieves the list of ExternalVpnGateway available to the specified project.
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
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
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.
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`)
Minimum : 0
Format : uint32
Type : integer
Default : 500
▼ ▲ compute.externalVpnGateways.get
Flat Path : projects/{project}/global/externalVpnGateways/{externalVpnGateway}
Scopes :
Parameter Order :
Parameters :
externalVpnGateway
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Description : Name of the externalVpnGateway 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])?))
Description : Project ID for this request.
Type : string
Location : path
Required : Yes
Path : projects/{project}/global/externalVpnGateways/{externalVpnGateway}
Apiversion : 2026-10-01-preview
HTTP Method : GET
Description : Returns the specified externalVpnGateway. Get a list of available externalVpnGateways by making a list() request.
▼ ▲ compute.externalVpnGateways.testIamPermissions
Apiversion : 2026-10-01-preview
HTTP Method : POST
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
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])?))
Flat Path : projects/{project}/global/externalVpnGateways/{resource}/testIamPermissions
Path : projects/{project}/global/externalVpnGateways/{resource}/testIamPermissions
Scopes :
Description : Returns permissions that a caller has on the specified resource.
Parameter Order :
▼ ▲ compute.externalVpnGateways.setLabels
HTTP Method : POST
Apiversion : 2026-10-01-preview
Parameter Order :
Path : projects/{project}/global/externalVpnGateways/{resource}/setLabels
Scopes :
Flat Path : projects/{project}/global/externalVpnGateways/{resource}/setLabels
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
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.
Description : Sets the labels on an ExternalVpnGateway. To learn more about labels, read the Labeling Resources documentation.
▼ ▲ compute.autoscalers.get
Scopes :
Parameter Order :
Parameters :
autoscaler
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 autoscaler to return.
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])?))
zone
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Name of the zone for this request.
Type : string
Required : Yes
Path : projects/{project}/zones/{zone}/autoscalers/{autoscaler}
Description : Returns the specified autoscaler resource.
HTTP Method : GET
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/zones/{zone}/autoscalers/{autoscaler}
▼ ▲ compute.autoscalers.list
Description : Retrieves a list of autoscalers contained within the specified zone.
HTTP Method : GET
Apiversion : 2026-10-01-preview
Path : projects/{project}/zones/{zone}/autoscalers
Parameter Order :
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.
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
Location : query
Minimum : 0
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.
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
zone
Description : Name of the zone for this request.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
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
Flat Path : projects/{project}/zones/{zone}/autoscalers
▼ ▲ compute.autoscalers.update
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.
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
autoscaler
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Location : query
Description : Name of the autoscaler to update.
zone
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Location : path
Required : Yes
Description : Name of the zone for this request.
Scopes :
Description : Updates an autoscaler in the specified project using the data included in the request.
Path : projects/{project}/zones/{zone}/autoscalers
Parameter Order :
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/zones/{zone}/autoscalers
HTTP Method : PUT
▼ ▲ compute.autoscalers.testIamPermissions
Parameter Order :
HTTP Method : POST
Scopes :
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/zones/{zone}/autoscalers/{resource}/testIamPermissions
Path : projects/{project}/zones/{zone}/autoscalers/{resource}/testIamPermissions
Description : Returns permissions that a caller has on the specified resource.
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
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.
resource
Description : Name or id of the resource for this request.
Required : Yes
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
▼ ▲ compute.autoscalers.aggregatedList
Scopes :
Apiversion : 2026-10-01-preview
HTTP Method : GET
Flat Path : projects/{project}/aggregated/autoscalers
Path : projects/{project}/aggregated/autoscalers
Description : Retrieves an aggregated list of autoscalers. To prevent failure, it is recommended that you set the `returnPartialSuccess` parameter to `true`.
Parameter Order : project
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
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
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
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
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
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
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
Minimum : 0
Location : query
▼ ▲ compute.autoscalers.patch
Apiversion : 2026-10-01-preview
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
Scopes :
Path : projects/{project}/zones/{zone}/autoscalers
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.
autoscaler
Description : Name of the autoscaler to patch.
Location : query
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
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
Description : Name of the zone for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Type : string
Parameter Order :
Flat Path : projects/{project}/zones/{zone}/autoscalers
▼ ▲ compute.autoscalers.insert
Description : Creates an autoscaler in the specified project using the data included in the request.
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])?))
zone
Description : Name of the zone for this request.
Location : path
Pattern : [a-z](?:[-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
Scopes :
Parameter Order :
Path : projects/{project}/zones/{zone}/autoscalers
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/zones/{zone}/autoscalers
HTTP Method : POST
▼ ▲ compute.autoscalers.delete
Path : projects/{project}/zones/{zone}/autoscalers/{autoscaler}
Flat Path : projects/{project}/zones/{zone}/autoscalers/{autoscaler}
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
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Description : Name of the autoscaler to delete.
Type : string
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.
zone
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Required : Yes
Type : string
Description : Name of the zone for this request.
Scopes :
HTTP Method : DELETE
Description : Deletes the specified autoscaler.
Apiversion : 2026-10-01-preview
Parameter Order :
▼ ▲ compute.packetMirrorings.patch
Flat Path : projects/{project}/regions/{region}/packetMirrorings/{packetMirroring}
Scopes :
Apiversion : 2026-10-01-preview
Path : projects/{project}/regions/{region}/packetMirrorings/{packetMirroring}
HTTP Method : PATCH
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.
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
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Description : Name of the region 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])?))
Type : string
Description : Project ID for this request.
Required : Yes
packetMirroring
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 PacketMirroring resource to patch.
Parameter Order :
▼ ▲ compute.packetMirrorings.testIamPermissions
Flat Path : projects/{project}/regions/{region}/packetMirrorings/{resource}/testIamPermissions
Scopes :
Apiversion : 2026-10-01-preview
Path : projects/{project}/regions/{region}/packetMirrorings/{resource}/testIamPermissions
HTTP Method : POST
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
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
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
Description : Returns permissions that a caller has on the specified resource.
▼ ▲ compute.packetMirrorings.list
Apiversion : 2026-10-01-preview
HTTP Method : GET
Parameter Order :
Scopes :
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
Default : 500
Type : integer
Location : query
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
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
region
Location : path
Description : Name of the region for this request.
Required : Yes
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.
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
Flat Path : projects/{project}/regions/{region}/packetMirrorings
Path : projects/{project}/regions/{region}/packetMirrorings
Description : Retrieves a list of PacketMirroring resources available to the specified project and region.
▼ ▲ compute.packetMirrorings.insert
Flat Path : projects/{project}/regions/{region}/packetMirrorings
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
Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-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
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])?
Scopes :
Apiversion : 2026-10-01-preview
HTTP Method : POST
Description : Creates a PacketMirroring resource in the specified project and region using the data included in the request.
Path : projects/{project}/regions/{region}/packetMirrorings
▼ ▲ compute.packetMirrorings.delete
Scopes :
Parameter Order :
Parameters :
packetMirroring
Location : path
Type : string
Description : Name of the PacketMirroring resource to delete.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
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
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.
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}/packetMirrorings/{packetMirroring}
Description : Deletes the specified PacketMirroring resource.
Path : projects/{project}/regions/{region}/packetMirrorings/{packetMirroring}
Apiversion : 2026-10-01-preview
HTTP Method : DELETE
▼ ▲ compute.packetMirrorings.get
Scopes :
HTTP Method : GET
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/regions/{region}/packetMirrorings/{packetMirroring}
Description : Returns the specified PacketMirroring resource.
Path : projects/{project}/regions/{region}/packetMirrorings/{packetMirroring}
Parameters :
packetMirroring
Required : Yes
Type : string
Description : Name of the PacketMirroring resource to return.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
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
Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-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.packetMirrorings.aggregatedList
Description : Retrieves an aggregated list of packetMirrorings. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.
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
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
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.
maxResults
Minimum : 0
Format : uint32
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
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
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.
Path : projects/{project}/aggregated/packetMirrorings
Flat Path : projects/{project}/aggregated/packetMirrorings
Scopes :
HTTP Method : GET
Parameter Order : project
Apiversion : 2026-10-01-preview
▼ ▲ compute.targetGrpcProxies.get
Parameter Order :
Description : Returns the specified TargetGrpcProxy resource in the given scope.
Apiversion : 2026-10-01-preview
HTTP Method : GET
Path : projects/{project}/global/targetGrpcProxies/{targetGrpcProxy}
Scopes :
Flat Path : projects/{project}/global/targetGrpcProxies/{targetGrpcProxy}
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])?))
targetGrpcProxy
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 TargetGrpcProxy resource to return.
▼ ▲ compute.targetGrpcProxies.insert
Path : projects/{project}/global/targetGrpcProxies
Flat Path : projects/{project}/global/targetGrpcProxies
Apiversion : 2026-10-01-preview
Scopes :
HTTP Method : POST
Parameter Order : project
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])?))
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 TargetGrpcProxy in the specified project in the given scope using the parameters that are included in the request.
▼ ▲ compute.targetGrpcProxies.delete
HTTP Method : DELETE
Flat Path : projects/{project}/global/targetGrpcProxies/{targetGrpcProxy}
Apiversion : 2026-10-01-preview
Path : projects/{project}/global/targetGrpcProxies/{targetGrpcProxy}
Parameter Order :
Parameters :
targetGrpcProxy
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the TargetGrpcProxy resource to delete.
Location : path
Type : string
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])?))
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 TargetGrpcProxy in the given scope
Scopes :
▼ ▲ compute.targetGrpcProxies.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.
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
Type : integer
Format : uint32
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])?))
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
Path : projects/{project}/global/targetGrpcProxies
Description : Lists the TargetGrpcProxies for a project in the given scope.
Scopes :
Flat Path : projects/{project}/global/targetGrpcProxies
Parameter Order : project
HTTP Method : GET
Apiversion : 2026-10-01-preview
▼ ▲ compute.targetGrpcProxies.patch
Apiversion : 2026-10-01-preview
HTTP Method : PATCH
Parameter Order :
Path : projects/{project}/global/targetGrpcProxies/{targetGrpcProxy}
Flat Path : projects/{project}/global/targetGrpcProxies/{targetGrpcProxy}
Scopes :
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.
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).
targetGrpcProxy
Type : string
Required : Yes
Description : Name of the TargetGrpcProxy resource to patch.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
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
▼ ▲ compute.vpnTunnels.setLabels
Scopes :
Description : Sets the labels on a VpnTunnel. To learn more about labels, read theLabeling Resources documentation.
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])?))
Location : path
Type : string
Description : Project ID for this request.
Required : Yes
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
region
Required : Yes
Type : string
Location : path
Description : The region for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Path : projects/{project}/regions/{region}/vpnTunnels/{resource}/setLabels
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/regions/{region}/vpnTunnels/{resource}/setLabels
Parameter Order :
HTTP Method : POST
▼ ▲ compute.vpnTunnels.aggregatedList
Apiversion : 2026-10-01-preview
HTTP Method : GET
Path : projects/{project}/aggregated/vpnTunnels
Flat Path : projects/{project}/aggregated/vpnTunnels
Description : Retrieves an aggregated list of VPN tunnels. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.
Scopes :
Parameters :
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
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
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
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
Format : uint32
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
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
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.
Parameter Order : project
▼ ▲ compute.vpnTunnels.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.
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
Type : string
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`)
Default : 500
Format : uint32
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
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.
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Required : Yes
Description : Name of the region for this request.
Location : path
Flat Path : projects/{project}/regions/{region}/vpnTunnels
Parameter Order :
Scopes :
Description : Retrieves a list of VpnTunnel resources contained in the specified project and region.
HTTP Method : GET
Path : projects/{project}/regions/{region}/vpnTunnels
Apiversion : 2026-10-01-preview
▼ ▲ compute.vpnTunnels.get
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
vpnTunnel
Location : path
Type : string
Description : Name of the VpnTunnel resource to return.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
region
Location : path
Required : Yes
Type : string
Description : Name of the region for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Path : projects/{project}/regions/{region}/vpnTunnels/{vpnTunnel}
Flat Path : projects/{project}/regions/{region}/vpnTunnels/{vpnTunnel}
Apiversion : 2026-10-01-preview
HTTP Method : GET
Description : Returns the specified VpnTunnel resource.
Scopes :
Parameter Order :
▼ ▲ compute.vpnTunnels.insert
Flat Path : projects/{project}/regions/{region}/vpnTunnels
Parameter Order :
HTTP Method : POST
Apiversion : 2026-10-01-preview
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
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])?))
Required : Yes
Type : string
Description : Project ID for this request.
Path : projects/{project}/regions/{region}/vpnTunnels
Scopes :
Description : Creates a VpnTunnel resource in the specified project and region using the data included in the request.
▼ ▲ compute.vpnTunnels.delete
Path : projects/{project}/regions/{region}/vpnTunnels/{vpnTunnel}
Parameters :
vpnTunnel
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 VpnTunnel resource to delete.
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
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.
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}/vpnTunnels/{vpnTunnel}
Apiversion : 2026-10-01-preview
Description : Deletes the specified VpnTunnel resource.
HTTP Method : DELETE
▼ ▲ compute.regionInstantSnapshotGroups.getIamPolicy
Parameters :
optionsRequestedPolicyVersion
Description : Requested IAM Policy version.
Type : integer
Location : query
Format : int32
region
Description : The name of the region for this request.
Required : Yes
Type : string
Location : path
Pattern : [a-z](?:[-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}
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])?))
Required : Yes
Type : string
Description : Gets the access control policy for a resource. May be empty if no such policy or resource exists.
Scopes :
HTTP Method : GET
Parameter Order :
Path : projects/{project}/regions/{region}/instantSnapshotGroups/{resource}/getIamPolicy
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/regions/{region}/instantSnapshotGroups/{resource}/getIamPolicy
▼ ▲ compute.regionInstantSnapshotGroups.testIamPermissions
Path : projects/{project}/regions/{region}/instantSnapshotGroups/{resource}/testIamPermissions
Description : Returns permissions that a caller has on the specified resource.
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.
Type : string
Location : path
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
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Description : The name of the region for this request.
Type : string
Location : path
Flat Path : projects/{project}/regions/{region}/instantSnapshotGroups/{resource}/testIamPermissions
Apiversion : 2026-10-01-preview
HTTP Method : POST
Parameter Order :
Scopes :
▼ ▲ compute.regionInstantSnapshotGroups.setIamPolicy
HTTP Method : POST
Path : projects/{project}/regions/{region}/instantSnapshotGroups/{resource}/setIamPolicy
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/regions/{region}/instantSnapshotGroups/{resource}/setIamPolicy
Parameter Order :
Parameters :
region
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Location : path
Description : The name of the region for this request.
resource
Location : path
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}
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])?))
Description : Sets the access control policy on the specified resource. Replaces any existing policy.
Scopes :
▼ ▲ compute.regionInstantSnapshotGroups.list
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
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])?
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.
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`)
Format : uint32
Minimum : 0
Location : query
Type : integer
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])?))
Description : retrieves the list of InstantSnapshotGroup resources contained within the specified region.
Scopes :
Path : projects/{project}/regions/{region}/instantSnapshotGroups
Flat Path : projects/{project}/regions/{region}/instantSnapshotGroups
Apiversion : 2026-10-01-preview
HTTP Method : GET
▼ ▲ compute.regionInstantSnapshotGroups.get
Path : projects/{project}/regions/{region}/instantSnapshotGroups/{instantSnapshotGroup}
Flat Path : projects/{project}/regions/{region}/instantSnapshotGroups/{instantSnapshotGroup}
Apiversion : 2026-10-01-preview
HTTP Method : GET
Description : returns the specified InstantSnapshotGroup resource in the specified region.
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
region
Description : The name of the region for this request.
Required : Yes
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
instantSnapshotGroup
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 InstantSnapshotGroup resource to return.
Parameter Order :
Scopes :
▼ ▲ compute.regionInstantSnapshotGroups.insert
Parameters :
region
Description : Name of the region for this request.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
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).
sourceConsistencyGroup
Type : string
Location : query
Description : begin_interface: MixerMutationRequestBuilder
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
Path : projects/{project}/regions/{region}/instantSnapshotGroups
Parameter Order :
Description : creates a Regional InstantSnapshotGroup resource
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/regions/{region}/instantSnapshotGroups
Scopes :
HTTP Method : POST
▼ ▲ compute.regionInstantSnapshotGroups.delete
HTTP Method : DELETE
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/regions/{region}/instantSnapshotGroups/{instantSnapshotGroup}
Parameter Order :
Path : projects/{project}/regions/{region}/instantSnapshotGroups/{instantSnapshotGroup}
Scopes :
Description : deletes a Regional InstantSnapshotGroup resource
Parameters :
instantSnapshotGroup
Type : string
Required : Yes
Description : Name of the InstantSnapshotGroup resource to delete.
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
Required : Yes
Description : The name of the region for this request.
Location : path
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.
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.targetSslProxies.setSslPolicy
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.
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
targetSslProxy
Type : string
Required : Yes
Location : path
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.
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.
Parameter Order :
Path : projects/{project}/global/targetSslProxies/{targetSslProxy}/setSslPolicy
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/global/targetSslProxies/{targetSslProxy}/setSslPolicy
HTTP Method : POST
▼ ▲ compute.targetSslProxies.setCertificateMap
Parameter Order :
HTTP Method : POST
Scopes :
Description : Changes the Certificate Map for TargetSslProxy.
Apiversion : 2026-10-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
targetSslProxy
Description : Name of the TargetSslProxy resource whose CertificateMap is to be set. The name must be 1-63 characters long, and comply with RFC1035.
Type : string
Location : path
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
Path : projects/{project}/global/targetSslProxies/{targetSslProxy}/setCertificateMap
Flat Path : projects/{project}/global/targetSslProxies/{targetSslProxy}/setCertificateMap
▼ ▲ compute.targetSslProxies.list
Parameter Order : project
HTTP Method : GET
Flat Path : projects/{project}/global/targetSslProxies
Apiversion : 2026-10-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
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
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
Type : integer
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.
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
Description : Retrieves the list of TargetSslProxy resources available to the specified project.
Path : projects/{project}/global/targetSslProxies
Scopes :
▼ ▲ compute.targetSslProxies.setBackendService
HTTP Method : POST
Parameter Order :
Apiversion : 2026-10-01-preview
Parameters :
targetSslProxy
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Description : Name of the TargetSslProxy resource whose BackendService resource is to be set.
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
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/targetSslProxies/{targetSslProxy}/setBackendService
Description : Changes the BackendService for TargetSslProxy.
Scopes :
Path : projects/{project}/global/targetSslProxies/{targetSslProxy}/setBackendService
▼ ▲ compute.targetSslProxies.setProxyHeader
Path : projects/{project}/global/targetSslProxies/{targetSslProxy}/setProxyHeader
Parameters :
targetSslProxy
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 TargetSslProxy resource whose ProxyHeader is to be set.
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
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/targetSslProxies/{targetSslProxy}/setProxyHeader
Description : Changes the ProxyHeaderType for TargetSslProxy.
Parameter Order :
Apiversion : 2026-10-01-preview
Scopes :
HTTP Method : POST
▼ ▲ compute.targetSslProxies.get
Scopes :
HTTP Method : GET
Apiversion : 2026-10-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
targetSslProxy
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 of the TargetSslProxy resource to return.
Flat Path : projects/{project}/global/targetSslProxies/{targetSslProxy}
Path : projects/{project}/global/targetSslProxies/{targetSslProxy}
Parameter Order :
Description : Returns the specified TargetSslProxy resource.
▼ ▲ compute.targetSslProxies.testIamPermissions
HTTP Method : POST
Flat Path : projects/{project}/global/targetSslProxies/{resource}/testIamPermissions
Apiversion : 2026-10-01-preview
Scopes :
Description : Returns permissions that a caller has on the specified resource.
Parameter Order :
Parameters :
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
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}/global/targetSslProxies/{resource}/testIamPermissions
▼ ▲ compute.targetSslProxies.setSslCertificates
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])?))
Required : Yes
Type : string
Description : Project ID for this request.
Location : path
targetSslProxy
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 TargetSslProxy resource whose SslCertificate resource is to be set.
Path : projects/{project}/global/targetSslProxies/{targetSslProxy}/setSslCertificates
Parameter Order :
Flat Path : projects/{project}/global/targetSslProxies/{targetSslProxy}/setSslCertificates
HTTP Method : POST
Apiversion : 2026-10-01-preview
Description : Changes SslCertificates for TargetSslProxy.
Scopes :
▼ ▲ compute.targetSslProxies.insert
HTTP Method : POST
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/global/targetSslProxies
Parameter Order : project
Path : projects/{project}/global/targetSslProxies
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
Description : An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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 TargetSslProxy resource in the specified project using the data included in the request.
Scopes :
▼ ▲ compute.targetSslProxies.delete
Flat Path : projects/{project}/global/targetSslProxies/{targetSslProxy}
Path : projects/{project}/global/targetSslProxies/{targetSslProxy}
Description : Deletes the specified TargetSslProxy resource.
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
Description : Name of the TargetSslProxy resource to delete.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
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
Parameter Order :
Apiversion : 2026-10-01-preview
HTTP Method : DELETE
Scopes :
▼ ▲ compute.projects.setUsageExportBucket
HTTP Method : POST
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/setUsageExportBucket
Scopes :
Parameter Order : project
Path : projects/{project}/setUsageExportBucket
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.
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
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.projects.setDefaultNetworkTier
Apiversion : 2026-10-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.
HTTP Method : POST
Path : projects/{project}/setDefaultNetworkTier
Flat Path : projects/{project}/setDefaultNetworkTier
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
Type : string
Location : path
Description : Project ID for this request.
Scopes :
Parameter Order : project
▼ ▲ compute.projects.listXpnHosts
Scopes :
HTTP Method : POST
Apiversion : 2026-10-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
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
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
Type : integer
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
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
Path : projects/{project}/listXpnHosts
Flat Path : projects/{project}/listXpnHosts
Parameter Order : project
Description : Lists all shared VPC host projects visible to the user in an organization.
▼ ▲ compute.projects.get
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.
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
Parameter Order : project
Path : projects/{project}
Apiversion : 2026-10-01-preview
Scopes :
Flat Path : projects/{project}
HTTP Method : GET
▼ ▲ compute.projects.moveDisk
Deprecated : Yes
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
Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-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 :
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.
Parameter Order : project
Flat Path : projects/{project}/moveDisk
Apiversion : 2026-10-01-preview
Path : projects/{project}/moveDisk
HTTP Method : POST
▼ ▲ compute.projects.disableXpnResource
Path : projects/{project}/disableXpnResource
Parameter Order : project
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
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.
Apiversion : 2026-10-01-preview
HTTP Method : POST
Scopes :
Description : Disable a service resource (also known as service project) associated with this host project.
Flat Path : projects/{project}/disableXpnResource
▼ ▲ compute.projects.disableXpnHost
HTTP Method : POST
Description : Disable this project as a shared VPC host project.
Apiversion : 2026-10-01-preview
Path : projects/{project}/disableXpnHost
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
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])?))
Flat Path : projects/{project}/disableXpnHost
Parameter Order : project
Scopes :
▼ ▲ compute.projects.enableXpnResource
HTTP Method : POST
Apiversion : 2026-10-01-preview
Scopes :
Flat Path : projects/{project}/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
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
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 : project
Path : projects/{project}/enableXpnResource
▼ ▲ compute.projects.setCommonInstanceMetadata
HTTP Method : POST
Apiversion : 2026-10-01-preview
Scopes :
Path : projects/{project}/setCommonInstanceMetadata
Parameter Order : project
Description : Sets metadata common to all instances within the specified project using the data included in the request.
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
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}/setCommonInstanceMetadata
▼ ▲ compute.projects.enableXpnHost
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])?))
Required : Yes
Type : string
Location : path
Description : Project ID for this request.
Path : projects/{project}/enableXpnHost
Description : Enable this project as a shared VPC host project.
Parameter Order : project
Scopes :
Apiversion : 2026-10-01-preview
HTTP Method : POST
Flat Path : projects/{project}/enableXpnHost
▼ ▲ compute.projects.moveInstance
Parameter Order : project
Path : projects/{project}/moveInstance
Apiversion : 2026-10-01-preview
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.
HTTP Method : POST
Flat Path : projects/{project}/moveInstance
Deprecated : Yes
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
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 :
▼ ▲ compute.projects.setCloudArmorTier
Flat Path : projects/{project}/setCloudArmorTier
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
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).
Path : projects/{project}/setCloudArmorTier
Scopes :
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.
Apiversion : 2026-10-01-preview
HTTP Method : POST
Parameter Order : project
▼ ▲ compute.projects.getXpnResources
Apiversion : 2026-10-01-preview
Path : projects/{project}/getXpnResources
Scopes :
HTTP Method : GET
Parameter Order : project
Flat Path : projects/{project}/getXpnResources
Description : Gets service resources (a.k.a service project) associated with this host 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
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
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
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
Location : query
Format : uint32
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
▼ ▲ compute.projects.getXpnHost
Apiversion : 2026-10-01-preview
Parameter Order : project
HTTP Method : GET
Path : projects/{project}/getXpnHost
Scopes :
Flat Path : projects/{project}/getXpnHost
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
Description : Gets the shared VPC host project that this project links to. May be empty if no link exists.
▼ ▲ compute.networks.listPeeringRoutes
Path : projects/{project}/global/networks/{network}/listPeeringRoutes
Parameter Order :
Apiversion : 2026-10-01-preview
Description : Lists the peering routes exchanged over peering connection.
HTTP Method : GET
Parameters :
maxResults
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
Minimum : 0
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
direction
Type : string
Enum Descriptions :
Enum :
Description : The direction of the exchanged routes.
Location : query
network
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Location : path
Description : Name of the network for this request.
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.
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
peeringName
Location : query
Description : The response will show routes exchanged over the given peering connection.
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.
Scopes :
Flat Path : projects/{project}/global/networks/{network}/listPeeringRoutes
▼ ▲ compute.networks.switchToCustomMode
Scopes :
Parameters :
network
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 network to be updated.
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.
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 :
Apiversion : 2026-10-01-preview
Description : Switches the network mode from auto subnet mode to custom subnet mode.
Flat Path : projects/{project}/global/networks/{network}/switchToCustomMode
HTTP Method : POST
Path : projects/{project}/global/networks/{network}/switchToCustomMode
▼ ▲ compute.networks.list
Description : Retrieves the list of networks available to the specified project.
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
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`)
Type : integer
Format : uint32
Location : query
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.
Type : string
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.
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.
Flat Path : projects/{project}/global/networks
Parameter Order : project
HTTP Method : GET
Path : projects/{project}/global/networks
Scopes :
Apiversion : 2026-10-01-preview
▼ ▲ compute.networks.cancelRequestRemovePeering
Parameters :
network
Required : Yes
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.
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
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])?))
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.
Scopes :
Path : projects/{project}/global/networks/{network}/cancelRequestRemovePeering
Apiversion : 2026-10-01-preview
HTTP Method : POST
Parameter Order :
Flat Path : projects/{project}/global/networks/{network}/cancelRequestRemovePeering
▼ ▲ compute.networks.insert
Flat Path : projects/{project}/global/networks
Parameter Order : project
Path : projects/{project}/global/networks
Scopes :
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
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-10-01-preview
HTTP Method : POST
Description : Creates a network in the specified project using the data included in the request.
▼ ▲ compute.networks.getEffectiveFirewalls
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
network
Description : Name of the network for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Location : path
Required : Yes
Description : Returns the effective firewalls on a given network.
Parameter Order :
Path : projects/{project}/global/networks/{network}/getEffectiveFirewalls
Scopes :
HTTP Method : GET
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/global/networks/{network}/getEffectiveFirewalls
▼ ▲ compute.networks.updatePeering
Path : projects/{project}/global/networks/{network}/updatePeering
HTTP Method : PATCH
Parameter Order :
Apiversion : 2026-10-01-preview
Parameters :
network
Required : Yes
Description : Name of the network resource which the updated peering is belonging to.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
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
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
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.
Scopes :
Flat Path : projects/{project}/global/networks/{network}/updatePeering
▼ ▲ compute.networks.requestRemovePeering
Scopes :
Description : Requests to remove a peering from the specified network. Applicable only for PeeringConnection with update_strategy=CONSENSUS.
Flat Path : projects/{project}/global/networks/{network}/requestRemovePeering
Path : projects/{project}/global/networks/{network}/requestRemovePeering
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.
Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-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
network
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 network resource to remove peering from.
Apiversion : 2026-10-01-preview
HTTP Method : POST
Parameter Order :
▼ ▲ compute.networks.addPeering
HTTP Method : POST
Apiversion : 2026-10-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])?))
Required : Yes
Type : string
network
Description : Name of the network resource to add peering to.
Required : Yes
Location : path
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
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}/global/networks/{network}/addPeering
Description : Adds a peering to the specified network.
Path : projects/{project}/global/networks/{network}/addPeering
Parameter Order :
Scopes :
▼ ▲ compute.networks.removePeering
Description : Removes a peering from the specified network.
HTTP Method : POST
Apiversion : 2026-10-01-preview
Path : projects/{project}/global/networks/{network}/removePeering
Flat Path : projects/{project}/global/networks/{network}/removePeering
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
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 to remove peering from.
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
Parameter Order :
▼ ▲ compute.networks.delete
Apiversion : 2026-10-01-preview
Path : projects/{project}/global/networks/{network}
Flat Path : projects/{project}/global/networks/{network}
HTTP Method : DELETE
Scopes :
Parameter Order :
Description : Deletes the specified network.
Parameters :
network
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the network to delete.
Location : path
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
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.
▼ ▲ compute.networks.get
Description : Returns the specified network.
Parameters :
network
Description : Name of the network to return.
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
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])?))
Flat Path : projects/{project}/global/networks/{network}
Parameter Order :
HTTP Method : GET
Apiversion : 2026-10-01-preview
Scopes :
Path : projects/{project}/global/networks/{network}
▼ ▲ compute.networks.patch
HTTP Method : PATCH
Apiversion : 2026-10-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).
network
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 network 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
Type : string
Description : Project ID for this request.
Location : path
Parameter Order :
Path : projects/{project}/global/networks/{network}
Description : Patches the specified network with the data included in the request. Only routingConfig can be modified.
Scopes :
Flat Path : projects/{project}/global/networks/{network}
▼ ▲ compute.globalNetworkEndpointGroups.listNetworkEndpoints
Flat Path : projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}/listNetworkEndpoints
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.
Type : string
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.
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
Type : integer
Location : query
Default : 500
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])?))
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
Scopes :
Description : Lists the network endpoints in the specified network endpoint group.
Apiversion : 2026-10-01-preview
HTTP Method : POST
Path : projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}/listNetworkEndpoints
Parameter Order :
▼ ▲ compute.globalNetworkEndpointGroups.insert
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
Scopes :
Apiversion : 2026-10-01-preview
HTTP Method : POST
Path : projects/{project}/global/networkEndpointGroups
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])?))
Type : string
Description : Project ID for this request.
Required : Yes
Parameter Order : project
Flat Path : projects/{project}/global/networkEndpointGroups
▼ ▲ compute.globalNetworkEndpointGroups.delete
HTTP Method : DELETE
Scopes :
Apiversion : 2026-10-01-preview
Parameter Order :
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.
Parameters :
networkEndpointGroup
Description : The name of the network endpoint group to delete. It should comply with RFC1035.
Type : string
Location : path
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
Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-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
▼ ▲ compute.globalNetworkEndpointGroups.attachNetworkEndpoints
Path : projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints
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
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
networkEndpointGroup
Location : path
Type : string
Required : Yes
Description : The name of the network endpoint group where you are attaching network endpoints to. It should comply with RFC1035.
Description : Attach a network endpoint to the specified network endpoint group.
Flat Path : projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints
Scopes :
Apiversion : 2026-10-01-preview
Parameter Order :
HTTP Method : POST
▼ ▲ compute.globalNetworkEndpointGroups.get
Path : projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}
Description : Returns the specified network endpoint group.
Parameters :
networkEndpointGroup
Type : string
Description : The name of the network endpoint group. It should comply with RFC1035.
Location : path
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.
Scopes :
Apiversion : 2026-10-01-preview
HTTP Method : GET
Flat Path : projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}
Parameter Order :
▼ ▲ compute.globalNetworkEndpointGroups.detachNetworkEndpoints
Parameter Order :
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])?))
networkEndpointGroup
Type : string
Location : path
Required : Yes
Description : The name of the network endpoint group where you are removing network endpoints. It should comply with RFC1035.
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}/global/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints
Scopes :
Description : Detach the network endpoint from the specified network endpoint group.
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints
HTTP Method : POST
▼ ▲ compute.globalNetworkEndpointGroups.list
Parameter Order : project
Flat Path : projects/{project}/global/networkEndpointGroups
Apiversion : 2026-10-01-preview
Scopes :
HTTP Method : GET
Path : projects/{project}/global/networkEndpointGroups
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
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
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
Default : 500
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`)
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
Description : Retrieves the list of network endpoint groups that are located in the specified project.
▼ ▲ compute.interconnectLocations.list
Flat Path : projects/{project}/global/interconnectLocations
Scopes :
Path : projects/{project}/global/interconnectLocations
Apiversion : 2026-10-01-preview
HTTP Method : GET
Description : Retrieves the list of interconnect locations available to the specified project.
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.
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
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.
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
Type : integer
Default : 500
Location : query
▼ ▲ compute.interconnectLocations.get
Parameters :
interconnectLocation
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 interconnect location 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])?))
Location : path
Description : Project ID for this request.
Required : Yes
Type : string
Parameter Order :
Scopes :
Flat Path : projects/{project}/global/interconnectLocations/{interconnectLocation}
HTTP Method : GET
Description : Returns the details for the specified interconnect location. Gets a list of available interconnect locations by making a list() request.
Path : projects/{project}/global/interconnectLocations/{interconnectLocation}
Apiversion : 2026-10-01-preview
▼ ▲ compute.instances.setMinCpuPlatform
Parameter Order :
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
HTTP Method : POST
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/zones/{zone}/instances/{instance}/setMinCpuPlatform
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
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])?))
instance
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 instance scoping this request.
Required : Yes
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
Scopes :
▼ ▲ compute.instances.list
Path : projects/{project}/zones/{zone}/instances
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
zone
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Description : The name of the zone for this request.
Location : path
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.
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`)
Format : uint32
Minimum : 0
Type : integer
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
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
Flat Path : projects/{project}/zones/{zone}/instances
Parameter Order :
Apiversion : 2026-10-01-preview
HTTP Method : GET
Scopes :
Description : Retrieves the list of instances contained within the specified zone.
▼ ▲ compute.instances.setMetadata
Flat Path : projects/{project}/zones/{zone}/instances/{instance}/setMetadata
Path : projects/{project}/zones/{zone}/instances/{instance}/setMetadata
Parameter Order :
Apiversion : 2026-10-01-preview
Scopes :
HTTP Method : POST
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
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
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
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.
Type : string
Location : path
Description : Sets metadata for the specified instance to the data included in the request.
▼ ▲ compute.instances.getIamPolicy
Flat Path : projects/{project}/zones/{zone}/instances/{resource}/getIamPolicy
Parameter Order :
Apiversion : 2026-10-01-preview
Scopes :
Path : projects/{project}/zones/{zone}/instances/{resource}/getIamPolicy
HTTP Method : GET
Parameters :
zone
Type : string
Required : Yes
Location : path
Description : The name of the zone for this request.
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
Description : Project ID for this request.
Required : Yes
optionsRequestedPolicyVersion
Type : integer
Location : query
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}
Location : path
Type : string
Required : Yes
Description : Name or id of the resource for this request.
Description : Gets the access control policy for a resource. May be empty if no such policy or resource exists.
▼ ▲ compute.instances.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
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])?))
zone
Location : path
Type : string
Required : Yes
Description : The name of the zone for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
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 : The instance name for this request.
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.
Scopes :
Parameter Order :
Flat Path : projects/{project}/zones/{zone}/instances/{instance}/addResourcePolicies
Apiversion : 2026-10-01-preview
Path : projects/{project}/zones/{zone}/instances/{instance}/addResourcePolicies
HTTP Method : POST
▼ ▲ compute.instances.setMachineResources
HTTP Method : POST
Path : projects/{project}/zones/{zone}/instances/{instance}/setMachineResources
Apiversion : 2026-10-01-preview
Description : Changes the number and/or type of accelerator for a stopped instance to the values specified in the request.
Parameter Order :
Scopes :
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
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
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
Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-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
Flat Path : projects/{project}/zones/{zone}/instances/{instance}/setMachineResources
▼ ▲ compute.instances.addNetworkInterface
Parameter Order :
Parameters :
instance
Type : string
Description : The instance name for this request stored as resource_id. Name should conform to RFC1035 or be an unsigned long integer.
Required : Yes
Location : path
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])?))
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 the zone for this request.
Location : path
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Adds one dynamic network interface to an active instance.
HTTP Method : POST
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/zones/{zone}/instances/{instance}/addNetworkInterface
Path : projects/{project}/zones/{zone}/instances/{instance}/addNetworkInterface
Scopes :
▼ ▲ compute.instances.deleteAccessConfig
Parameter Order :
Apiversion : 2026-10-01-preview
Path : projects/{project}/zones/{zone}/instances/{instance}/deleteAccessConfig
HTTP Method : POST
Flat Path : projects/{project}/zones/{zone}/instances/{instance}/deleteAccessConfig
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).
networkInterface
Location : query
Required : Yes
Description : The name of the network interface.
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
accessConfig
Location : query
Description : The name of the access config to delete.
Required : Yes
Type : string
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
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Description : The instance name for this request.
Required : Yes
Type : string
Description : Deletes an access config from an instance's network interface.
Scopes :
▼ ▲ compute.instances.getSerialPortOutput
Parameters :
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
port
Minimum : 1
Location : query
Description : Specifies which COM or serial port to retrieve data from.
Type : integer
Format : int32
Default : 1
Maximum : 4
start
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.
Type : string
Format : int64
Location : query
instance
Description : Name of the instance 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}
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
Scopes :
Flat Path : projects/{project}/zones/{zone}/instances/{instance}/serialPort
Description : Returns the last 1 MB of serial port output from the specified instance.
Parameter Order :
Path : projects/{project}/zones/{zone}/instances/{instance}/serialPort
Apiversion : 2026-10-01-preview
HTTP Method : GET
▼ ▲ compute.instances.update
Apiversion : 2026-10-01-preview
Parameter Order :
Scopes :
HTTP Method : PUT
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.
Flat Path : projects/{project}/zones/{zone}/instances/{instance}
Parameters :
mostDisruptiveAllowedAction
Enum Descriptions :
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.
Enum :
Location : query
Type : string
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
discardLocalSsd
Location : query
Type : boolean
Description : Whether to discard local SSDs from the instance during restart default value is false.
minimalAction
Location : query
Enum :
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.
Type : string
Enum Descriptions :
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
instance
Required : Yes
Description : Name of the instance resource to update.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Type : string
Path : projects/{project}/zones/{zone}/instances/{instance}
▼ ▲ compute.instances.detachDisk
Apiversion : 2026-10-01-preview
HTTP Method : POST
Parameter Order :
Flat Path : projects/{project}/zones/{zone}/instances/{instance}/detachDisk
Path : projects/{project}/zones/{zone}/instances/{instance}/detachDisk
Description : Detaches a disk from an instance.
Parameters :
instance
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Required : Yes
Description : Instance name for this request.
Location : path
deviceName
Location : query
Description : The device name of the disk to detach. Make a get() request on the instance to view currently attached disks and device names.
Required : Yes
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
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])?
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.instances.setMachineType
Parameter Order :
Description : Changes the machine type for a stopped instance to the machine type specified in the request.
Flat Path : projects/{project}/zones/{zone}/instances/{instance}/setMachineType
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
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.
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
instance
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the instance scoping this request.
Location : path
Required : Yes
Type : string
Scopes :
Path : projects/{project}/zones/{zone}/instances/{instance}/setMachineType
HTTP Method : POST
Apiversion : 2026-10-01-preview
▼ ▲ compute.instances.updateDisplayDevice
Parameter Order :
Parameters :
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.
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])?))
Required : Yes
Type : string
Description : Project ID for this request.
Location : path
instance
Location : path
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Name of the instance scoping this request.
Required : Yes
Path : projects/{project}/zones/{zone}/instances/{instance}/updateDisplayDevice
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.
Scopes :
HTTP Method : PATCH
Flat Path : projects/{project}/zones/{zone}/instances/{instance}/updateDisplayDevice
Apiversion : 2026-10-01-preview
▼ ▲ compute.instances.delete
Apiversion : 2026-10-01-preview
HTTP Method : DELETE
Parameter Order :
Path : projects/{project}/zones/{zone}/instances/{instance}
Flat Path : projects/{project}/zones/{zone}/instances/{instance}
Scopes :
Description : Deletes the specified Instance resource. For more information, seeDeleting an instance.
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])?))
instance
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Required : Yes
Type : string
Description : Name of the instance resource to delete.
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).
noGracefulShutdown
Type : boolean
Description : If set to true, Graceful Shutdown is skipped.
Location : query
zone
Required : Yes
Location : path
Description : The name of the zone for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
▼ ▲ compute.instances.updateAccessConfig
Flat Path : projects/{project}/zones/{zone}/instances/{instance}/updateAccessConfig
Scopes :
Apiversion : 2026-10-01-preview
HTTP Method : POST
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.
Path : projects/{project}/zones/{zone}/instances/{instance}/updateAccessConfig
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
instance
Location : path
Description : The instance name for this request.
Required : Yes
Type : string
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
networkInterface
Location : query
Description : The name of the network interface where the access config is attached.
Required : Yes
Type : string
zone
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : The name of the zone for this request.
Location : path
Type : string
Parameter Order :
▼ ▲ compute.instances.get
Description : Returns the specified Instance resource.
Flat Path : projects/{project}/zones/{zone}/instances/{instance}
Parameter Order :
Parameters :
zone
Location : path
Type : string
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
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
Type : string
Description : Project ID for this request.
Location : path
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 return.
Required : Yes
Type : string
Apiversion : 2026-10-01-preview
HTTP Method : GET
Path : projects/{project}/zones/{zone}/instances/{instance}
Scopes :
▼ ▲ compute.instances.deleteNetworkInterface
Apiversion : 2026-10-01-preview
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;
HTTP Method : POST
Path : projects/{project}/zones/{zone}/instances/{instance}/deleteNetworkInterface
Parameter Order :
Scopes :
Parameters :
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
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
networkInterfaceName
Required : Yes
Description : The name of the dynamic network interface to be deleted from the instance.
Location : query
Type : string
instance
Description : The instance name for this request stored as resource_id. Name should conform to RFC1035 or be an unsigned long integer.
Location : path
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
Flat Path : projects/{project}/zones/{zone}/instances/{instance}/deleteNetworkInterface
▼ ▲ compute.instances.start
Description : Starts an instance that was stopped using theinstances().stop method. For more information, seeRestart an instance.
Scopes :
Parameters :
instance
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 instance resource to start.
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])?
Description : The name of the zone for this request.
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])?))
Required : Yes
Type : string
Path : projects/{project}/zones/{zone}/instances/{instance}/start
Flat Path : projects/{project}/zones/{zone}/instances/{instance}/start
Parameter Order :
Apiversion : 2026-10-01-preview
HTTP Method : POST
▼ ▲ compute.instances.setIamPolicy
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])?))
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.
Location : path
Type : string
zone
Required : Yes
Description : The name of the zone for this request.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Flat Path : projects/{project}/zones/{zone}/instances/{resource}/setIamPolicy
Path : projects/{project}/zones/{zone}/instances/{resource}/setIamPolicy
Parameter Order :
Scopes :
Description : Sets the access control policy on the specified resource. Replaces any existing policy.
Apiversion : 2026-10-01-preview
HTTP Method : POST
▼ ▲ compute.instances.setShieldedInstanceIntegrityPolicy
HTTP Method : PATCH
Apiversion : 2026-10-01-preview
Path : projects/{project}/zones/{zone}/instances/{instance}/setShieldedInstanceIntegrityPolicy
Parameter Order :
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.
Flat Path : projects/{project}/zones/{zone}/instances/{instance}/setShieldedInstanceIntegrityPolicy
Parameters :
instance
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 instance scoping 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
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
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])?))
Scopes :
▼ ▲ compute.instances.performMaintenance
Flat Path : projects/{project}/zones/{zone}/instances/{instance}/performMaintenance
Description : Perform a manual maintenance on the instance.
Scopes :
Apiversion : 2026-10-01-preview
HTTP Method : POST
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
Required : Yes
Location : path
Description : Name of the instance scoping this request.
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
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
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
Parameter Order :
Path : projects/{project}/zones/{zone}/instances/{instance}/performMaintenance
▼ ▲ compute.instances.removeResourcePolicies
Parameter Order :
HTTP Method : POST
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/zones/{zone}/instances/{instance}/removeResourcePolicies
Description : Removes resource policies from an instance.
Path : projects/{project}/zones/{zone}/instances/{instance}/removeResourcePolicies
Scopes :
Parameters :
instance
Required : Yes
Location : path
Description : The instance name for this request.
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
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
Description : An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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.
Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-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.instances.setServiceAccount
Flat Path : projects/{project}/zones/{zone}/instances/{instance}/setServiceAccount
Description : Sets the service account on the instance. For more information, readChanging the service account and access scopes for an instance.
HTTP Method : POST
Apiversion : 2026-10-01-preview
Parameters :
instance
Required : Yes
Type : string
Location : path
Description : Name of the instance resource to start.
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
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
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
Path : projects/{project}/zones/{zone}/instances/{instance}/setServiceAccount
Parameter Order :
Scopes :
▼ ▲ compute.instances.startWithEncryptionKey
Description : Starts an instance that was stopped using theinstances().stop method. For more information, seeRestart an instance.
HTTP Method : POST
Apiversion : 2026-10-01-preview
Parameter Order :
Scopes :
Flat Path : projects/{project}/zones/{zone}/instances/{instance}/startWithEncryptionKey
Path : projects/{project}/zones/{zone}/instances/{instance}/startWithEncryptionKey
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
Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-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.
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
instance
Description : Name of the instance resource to start.
Type : string
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
▼ ▲ compute.instances.getScreenshot
Description : Returns the screenshot from the specified instance.
Parameters :
instance
Required : Yes
Description : Name of the instance scoping this request.
Type : string
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
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
Location : path
Type : string
Required : Yes
Description : The name of the zone for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Flat Path : projects/{project}/zones/{zone}/instances/{instance}/screenshot
HTTP Method : GET
Scopes :
Apiversion : 2026-10-01-preview
Parameter Order :
Path : projects/{project}/zones/{zone}/instances/{instance}/screenshot
▼ ▲ compute.instances.aggregatedList
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`.
HTTP Method : GET
Flat Path : projects/{project}/aggregated/instances
Apiversion : 2026-10-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
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
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`)
Minimum : 0
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
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.
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
Scopes :
Path : projects/{project}/aggregated/instances
Parameter Order : project
▼ ▲ compute.instances.attachDisk
Parameters :
instance
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.
Type : string
Location : path
forceAttach
Type : boolean
Location : query
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.
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
zone
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Type : string
Description : The name of the zone 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
Path : projects/{project}/zones/{zone}/instances/{instance}/attachDisk
Flat Path : projects/{project}/zones/{zone}/instances/{instance}/attachDisk
Scopes :
HTTP Method : POST
Parameter Order :
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.
Apiversion : 2026-10-01-preview
▼ ▲ compute.instances.setScheduling
HTTP Method : POST
Apiversion : 2026-10-01-preview
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.
Parameter Order :
Path : projects/{project}/zones/{zone}/instances/{instance}/setScheduling
Scopes :
Parameters :
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
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
Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-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
instance
Location : path
Type : string
Description : Instance name 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}/instances/{instance}/setScheduling
▼ ▲ compute.instances.simulateMaintenanceEvent
Scopes :
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/zones/{zone}/instances/{instance}/simulateMaintenanceEvent
HTTP Method : POST
Description : Simulates a host maintenance event on a VM. For more information, see Simulate a host maintenance event.
Parameter Order :
Parameters :
withExtendedNotifications
Description : Determines whether the customers receive notifications before migration. Only applicable to SF vms.
Type : boolean
Location : query
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).
instance
Location : path
Type : string
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}
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
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}/zones/{zone}/instances/{instance}/simulateMaintenanceEvent
▼ ▲ compute.instances.testIamPermissions
Parameter Order :
HTTP Method : POST
Path : projects/{project}/zones/{zone}/instances/{resource}/testIamPermissions
Apiversion : 2026-10-01-preview
Scopes :
Parameters :
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
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])?))
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}
Flat Path : projects/{project}/zones/{zone}/instances/{resource}/testIamPermissions
Description : Returns permissions that a caller has on the specified resource.
▼ ▲ compute.instances.setDeletionProtection
Path : projects/{project}/zones/{zone}/instances/{resource}/setDeletionProtection
Parameters :
resource
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}
Required : Yes
deletionProtection
Location : query
Type : boolean
Default : true
Description : Whether the resource should be protected against deletion.
requestId
Location : query
Type : string
Description : An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
zone
Description : The name of the zone for this request.
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
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])?))
Type : string
Required : Yes
Description : Project ID for this request.
Location : path
Flat Path : projects/{project}/zones/{zone}/instances/{resource}/setDeletionProtection
Scopes :
Apiversion : 2026-10-01-preview
Description : Sets deletion protection on the instance.
HTTP Method : POST
Parameter Order :
▼ ▲ compute.instances.setName
Flat Path : projects/{project}/zones/{zone}/instances/{instance}/setName
Parameters :
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
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 : The instance name for this request.
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
Description : An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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}/setName
Parameter Order :
HTTP Method : POST
Apiversion : 2026-10-01-preview
Description : Sets name of an instance.
Scopes :
▼ ▲ compute.instances.reportHostAsFaulty
Path : projects/{project}/zones/{zone}/instances/{instance}/reportHostAsFaulty
Parameters :
instance
Description : Name of the instance scoping 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
Required : Yes
Description : The name of the zone for this request.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
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
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 :
Description : Mark the host as faulty and try to restart the instance on a new host.
Flat Path : projects/{project}/zones/{zone}/instances/{instance}/reportHostAsFaulty
HTTP Method : POST
Apiversion : 2026-10-01-preview
▼ ▲ compute.instances.getGuestAttributes
Path : projects/{project}/zones/{zone}/instances/{instance}/getGuestAttributes
Description : Returns the specified guest attributes entry.
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
Location : path
Required : Yes
queryPath
Description : Specifies the guest attributes path to be queried.
Type : string
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
variableKey
Location : query
Description : Specifies the key for the guest attributes entry.
Type : string
instance
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 instance scoping this request.
Location : path
Scopes :
Parameter Order :
Apiversion : 2026-10-01-preview
HTTP Method : GET
Flat Path : projects/{project}/zones/{zone}/instances/{instance}/getGuestAttributes
▼ ▲ compute.instances.resume
HTTP Method : POST
Path : projects/{project}/zones/{zone}/instances/{instance}/resume
Description : Resumes an instance that was suspended using theinstances().suspend method.
Apiversion : 2026-10-01-preview
Parameter Order :
Scopes :
Flat Path : projects/{project}/zones/{zone}/instances/{instance}/resume
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])?))
Type : string
Location : path
Description : Project ID for this request.
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])?
instance
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 instance resource to resume.
Required : Yes
▼ ▲ compute.instances.reset
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.
Scopes :
Parameter Order :
Parameters :
instance
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the instance scoping this request.
Location : path
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
Description : Project ID for this request.
Location : path
zone
Description : The name of the zone for 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
Apiversion : 2026-10-01-preview
HTTP Method : POST
Flat Path : projects/{project}/zones/{zone}/instances/{instance}/reset
Path : projects/{project}/zones/{zone}/instances/{instance}/reset
▼ ▲ compute.instances.setLabels
Parameter Order :
Apiversion : 2026-10-01-preview
Scopes :
HTTP Method : POST
Path : projects/{project}/zones/{zone}/instances/{instance}/setLabels
Description : Sets labels on an instance. To learn more about labels, read theLabeling Resources documentation.
Flat Path : projects/{project}/zones/{zone}/instances/{instance}/setLabels
Parameters :
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
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
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
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 scoping this request.
Type : string
Location : path
▼ ▲ 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.
Flat Path : projects/{project}/zones/{zone}/instances/{instance}/suspend
HTTP Method : POST
Apiversion : 2026-10-01-preview
Parameter Order :
Parameters :
zone
Description : The name of the zone for this request.
Location : path
Type : string
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
discardLocalSsd
Location : query
Type : boolean
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.
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
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
Description : Name of the instance resource to suspend.
Type : string
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Path : projects/{project}/zones/{zone}/instances/{instance}/suspend
Scopes :
▼ ▲ compute.instances.addAccessConfig
Path : projects/{project}/zones/{zone}/instances/{instance}/addAccessConfig
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
networkInterface
Type : string
Description : The name of the network interface to add to this instance.
Location : query
Required : Yes
zone
Location : path
Description : The name of the zone for this request.
Required : Yes
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
instance
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}
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
HTTP Method : POST
Description : Adds an access config to an instance's network interface.
Flat Path : projects/{project}/zones/{zone}/instances/{instance}/addAccessConfig
Apiversion : 2026-10-01-preview
Parameter Order :
▼ ▲ compute.instances.insert
Description : Creates an instance resource in the specified project using the data included in the request.
HTTP Method : POST
Scopes :
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/zones/{zone}/instances
Parameter Order :
Parameters :
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.
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
sourceMachineImage
Type : string
Location : query
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
sourceInstanceTemplate
Location : query
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
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
Path : projects/{project}/zones/{zone}/instances
▼ ▲ compute.instances.stop
Parameter Order :
Path : projects/{project}/zones/{zone}/instances/{instance}/stop
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
Description : Project ID for this request.
Location : path
instance
Location : path
Type : string
Description : Name of the instance resource to stop.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
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
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
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
noGracefulShutdown
Location : query
Description : If set to true, Graceful Shutdown is skipped.
Type : boolean
Scopes :
HTTP Method : POST
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.
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/zones/{zone}/instances/{instance}/stop
▼ ▲ compute.instances.listReferrers
Path : projects/{project}/zones/{zone}/instances/{instance}/referrers
Scopes :
Parameter Order :
Parameters :
instance
Location : path
Description : Name of the target instance scoping this request, or '-' if the request should span over all instances in the container.
Type : string
Required : Yes
Pattern |[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
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
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
maxResults
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`)
Format : uint32
Default : 500
Type : integer
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
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}/zones/{zone}/instances/{instance}/referrers
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-10-01-preview
HTTP Method : GET
▼ ▲ compute.instances.setDiskAutoDelete
HTTP Method : POST
Apiversion : 2026-10-01-preview
Parameters :
deviceName
Type : string
Pattern : \w[\w.-]{0,254}
Required : Yes
Description : The device name of the disk to modify. Make a get() request on the instance to view currently attached disks and device names.
Location : query
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
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
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
Description : The instance name 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
autoDelete
Location : query
Type : boolean
Required : Yes
Description : Whether to auto-delete the disk when the instance is deleted.
Parameter Order :
Description : Sets the auto-delete flag for a disk attached to an instance.
Scopes :
Path : projects/{project}/zones/{zone}/instances/{instance}/setDiskAutoDelete
Flat Path : projects/{project}/zones/{zone}/instances/{instance}/setDiskAutoDelete
▼ ▲ compute.instances.bulkInsert
Path : projects/{project}/zones/{zone}/instances/bulkInsert
Parameter Order :
Description : Creates multiple instances. Count specifies the number of instances to create. For more information, seeAbout bulk creation of VMs.
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
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])?))
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 :
Flat Path : projects/{project}/zones/{zone}/instances/bulkInsert
Apiversion : 2026-10-01-preview
HTTP Method : POST
▼ ▲ compute.instances.getShieldedInstanceIdentity
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])?
instance
Description : Name or id 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
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
Description : Returns the Shielded Instance Identity of an instance
Flat Path : projects/{project}/zones/{zone}/instances/{instance}/getShieldedInstanceIdentity
Path : projects/{project}/zones/{zone}/instances/{instance}/getShieldedInstanceIdentity
Scopes :
Parameter Order :
Apiversion : 2026-10-01-preview
HTTP Method : GET
▼ ▲ compute.instances.setTags
Flat Path : projects/{project}/zones/{zone}/instances/{instance}/setTags
Parameter Order :
Apiversion : 2026-10-01-preview
HTTP Method : POST
Path : projects/{project}/zones/{zone}/instances/{instance}/setTags
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
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
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}
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
Description : Sets network tags for the specified instance to the data included in the request.
Scopes :
▼ ▲ compute.instances.sendDiagnosticInterrupt
Parameter Order :
Flat Path : projects/{project}/zones/{zone}/instances/{instance}/sendDiagnosticInterrupt
Apiversion : 2026-10-01-preview
HTTP Method : POST
Parameters :
instance
Type : string
Description : Name of the instance scoping this request.
Required : Yes
Location : path
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])?))
Required : Yes
Type : string
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
Scopes :
Description : Sends diagnostic interrupt to the instance.
Path : projects/{project}/zones/{zone}/instances/{instance}/sendDiagnosticInterrupt
▼ ▲ compute.instances.updateNetworkInterface
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.
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).
instance
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}
Location : path
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.
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])?))
networkInterface
Required : Yes
Type : string
Location : query
Description : The name of the network interface to update.
Flat Path : projects/{project}/zones/{zone}/instances/{instance}/updateNetworkInterface
HTTP Method : PATCH
Apiversion : 2026-10-01-preview
Scopes :
Path : projects/{project}/zones/{zone}/instances/{instance}/updateNetworkInterface
▼ ▲ compute.instances.updateShieldedInstanceConfig
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
Path : projects/{project}/zones/{zone}/instances/{instance}/updateShieldedInstanceConfig
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/zones/{zone}/instances/{instance}/updateShieldedInstanceConfig
Scopes :
Parameter Order :
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
instance
Required : Yes
Description : Name or id 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}
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.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Type : string
Required : Yes
▼ ▲ compute.instances.getEffectiveFirewalls
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
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.
instance
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Description : Name of the instance scoping this request.
Location : path
networkInterface
Location : query
Description : The name of the network interface to get the effective firewalls.
Type : string
Required : Yes
Path : projects/{project}/zones/{zone}/instances/{instance}/getEffectiveFirewalls
Scopes :
Parameter Order :
Description : Returns effective firewalls applied to an interface of the instance.
Flat Path : projects/{project}/zones/{zone}/instances/{instance}/getEffectiveFirewalls
HTTP Method : GET
Apiversion : 2026-10-01-preview
▼ ▲ compute.instances.setSecurityPolicy
Description : Sets the Google Cloud Armor security policy for the specified instance. For more information, seeGoogle Cloud Armor Overview
Path : projects/{project}/zones/{zone}/instances/{instance}/setSecurityPolicy
Parameter Order :
Parameters :
instance
Type : string
Required : Yes
Description : Name of the Instance resource to which the security policy should be set. The name should conform to RFC1035.
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
zone
Location : path
Type : string
Required : Yes
Description : Name of the zone scoping this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
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}/instances/{instance}/setSecurityPolicy
HTTP Method : POST
Scopes :
Apiversion : 2026-10-01-preview
▼ ▲ compute.backendBuckets.insert
HTTP Method : POST
Scopes :
Apiversion : 2026-10-01-preview
Parameter Order : project
Path : projects/{project}/global/backendBuckets
Description : Creates a BackendBucket resource in the specified project using the data included in the request.
Flat Path : projects/{project}/global/backendBuckets
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
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
Scopes :
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
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.
maxResults
Location : query
Format : uint32
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.
Location : query
Type : string
Apiversion : 2026-10-01-preview
HTTP Method : GET
Description : Retrieves the list of BackendBucket resources available to the specified project.
Path : projects/{project}/global/backendBuckets
Flat Path : projects/{project}/global/backendBuckets
▼ ▲ compute.backendBuckets.getIamPolicy
Parameter Order :
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/global/backendBuckets/{resource}/getIamPolicy
HTTP Method : GET
Path : projects/{project}/global/backendBuckets/{resource}/getIamPolicy
Scopes :
Description : Gets the access control policy for a resource. May be empty if no such policy or resource exists.
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.
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.
optionsRequestedPolicyVersion
Type : integer
Location : query
Format : int32
Description : Requested IAM Policy version.
▼ ▲ compute.backendBuckets.aggregatedList
Scopes :
Flat Path : projects/{project}/aggregated/backendBuckets
Parameter Order : project
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.
maxResults
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`)
Minimum : 0
Location : query
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
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
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
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
Apiversion : 2026-10-01-preview
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`.
HTTP Method : GET
Path : projects/{project}/aggregated/backendBuckets
▼ ▲ compute.backendBuckets.setEdgeSecurityPolicy
Flat Path : projects/{project}/global/backendBuckets/{backendBucket}/setEdgeSecurityPolicy
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])?))
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
Location : path
Required : Yes
Type : string
Description : Name of the BackendBucket resource to which the security policy should be set. The name should conform to RFC1035.
Scopes :
Description : Sets the edge security policy for the specified backend bucket.
Apiversion : 2026-10-01-preview
Path : projects/{project}/global/backendBuckets/{backendBucket}/setEdgeSecurityPolicy
HTTP Method : POST
Parameter Order :
▼ ▲ compute.backendBuckets.addSignedUrlKey
HTTP Method : POST
Apiversion : 2026-10-01-preview
Description : Adds a key for validating requests with signed URLs for this backend bucket.
Parameter Order :
Scopes :
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
backendBucket
Type : string
Description : Name of the BackendBucket resource to which the Signed URL Key should be added. The name should conform to RFC1035.
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/backendBuckets/{backendBucket}/addSignedUrlKey
Path : projects/{project}/global/backendBuckets/{backendBucket}/addSignedUrlKey
▼ ▲ compute.backendBuckets.delete
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])?))
backendBucket
Description : Name of the BackendBucket 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
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-10-01-preview
Flat Path : projects/{project}/global/backendBuckets/{backendBucket}
Path : projects/{project}/global/backendBuckets/{backendBucket}
HTTP Method : DELETE
Scopes :
Description : Deletes the specified BackendBucket resource.
▼ ▲ compute.backendBuckets.deleteSignedUrlKey
Description : Deletes a key for validating requests with signed URLs for this backend bucket.
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
Type : string
Location : path
Description : Project ID for this request.
backendBucket
Description : Name of the BackendBucket resource to which the Signed URL Key should be added. The name should conform to RFC1035.
Location : path
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
keyName
Location : query
Required : Yes
Description : The name of the Signed URL Key to delete.
Type : string
Flat Path : projects/{project}/global/backendBuckets/{backendBucket}/deleteSignedUrlKey
HTTP Method : POST
Path : projects/{project}/global/backendBuckets/{backendBucket}/deleteSignedUrlKey
Scopes :
Apiversion : 2026-10-01-preview
▼ ▲ compute.backendBuckets.patch
Parameters :
backendBucket
Required : Yes
Description : Name of the BackendBucket resource to patch.
Location : path
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
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).
Location : query
Type : string
Parameter Order :
Scopes :
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.
HTTP Method : PATCH
Flat Path : projects/{project}/global/backendBuckets/{backendBucket}
Apiversion : 2026-10-01-preview
Path : projects/{project}/global/backendBuckets/{backendBucket}
▼ ▲ compute.backendBuckets.setIamPolicy
Parameter Order :
Apiversion : 2026-10-01-preview
HTTP Method : POST
Description : Sets the access control policy on the specified resource. Replaces any existing policy.
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.
resource
Location : path
Type : string
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}
Flat Path : projects/{project}/global/backendBuckets/{resource}/setIamPolicy
Scopes :
Path : projects/{project}/global/backendBuckets/{resource}/setIamPolicy
▼ ▲ compute.backendBuckets.listUsable
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
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
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
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
Flat Path : projects/{project}/global/backendBuckets/listUsable
Path : projects/{project}/global/backendBuckets/listUsable
Scopes :
Parameter Order : project
HTTP Method : GET
Apiversion : 2026-10-01-preview
Description : Retrieves a list of all usable backend buckets in the specified project.
▼ ▲ compute.backendBuckets.get
Scopes :
Flat Path : projects/{project}/global/backendBuckets/{backendBucket}
Parameters :
backendBucket
Location : path
Description : Name of the BackendBucket resource to return.
Required : Yes
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
project
Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Location : path
Type : string
Required : Yes
Description : Project ID for this request.
Path : projects/{project}/global/backendBuckets/{backendBucket}
Description : Returns the specified BackendBucket resource.
Apiversion : 2026-10-01-preview
Parameter Order :
HTTP Method : GET
▼ ▲ compute.backendBuckets.testIamPermissions
Scopes :
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])?))
Type : string
Location : path
Required : Yes
Description : Project ID for this request.
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
Parameter Order :
Path : projects/{project}/global/backendBuckets/{resource}/testIamPermissions
Apiversion : 2026-10-01-preview
HTTP Method : POST
Flat Path : projects/{project}/global/backendBuckets/{resource}/testIamPermissions
▼ ▲ compute.backendBuckets.update
Scopes :
Apiversion : 2026-10-01-preview
HTTP Method : PUT
Path : projects/{project}/global/backendBuckets/{backendBucket}
Flat Path : projects/{project}/global/backendBuckets/{backendBucket}
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])?))
Type : string
Location : path
Required : Yes
backendBucket
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 BackendBucket resource 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
Description : Updates the specified BackendBucket resource with the data included in the request.
▼ ▲ compute.regionDiskTypes.get
Path : projects/{project}/regions/{region}/diskTypes/{diskType}
Scopes :
HTTP Method : GET
Parameter Order :
Apiversion : 2026-10-01-preview
Parameters :
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
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.
diskType
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Description : Name of the disk type to return.
Required : Yes
Type : string
Description : Returns the specified regional disk type.
Flat Path : projects/{project}/regions/{region}/diskTypes/{diskType}
▼ ▲ compute.regionDiskTypes.list
Parameter Order :
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/regions/{region}/diskTypes
HTTP Method : GET
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.
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
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])?))
region
Description : The name of the region for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
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`)
Location : query
Default : 500
Format : uint32
Type : integer
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
Description : Retrieves a list of regional disk types available to the specified project.
Path : projects/{project}/regions/{region}/diskTypes
▼ ▲ compute.regions.get
Scopes :
Parameter Order :
Apiversion : 2026-10-01-preview
HTTP Method : GET
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
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 region resource to return.
Type : string
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.
Flat Path : projects/{project}/regions/{region}
▼ ▲ compute.regions.list
HTTP Method : GET
Flat Path : projects/{project}/regions
Apiversion : 2026-10-01-preview
Scopes :
Path : projects/{project}/regions
Parameter Order : project
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.
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.
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
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.
Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-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.regionInstanceTemplates.insert
Path : projects/{project}/regions/{region}/instanceTemplates
Apiversion : 2026-10-01-preview
HTTP Method : POST
Description : Creates an instance template in the specified project and region using the global instance template whose URL is included in the request.
Parameter Order :
Scopes :
Flat Path : projects/{project}/regions/{region}/instanceTemplates
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
Required : Yes
Type : string
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])?
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.regionInstanceTemplates.delete
Path : projects/{project}/regions/{region}/instanceTemplates/{instanceTemplate}
Scopes :
HTTP Method : DELETE
Apiversion : 2026-10-01-preview
Parameters :
instanceTemplate
Required : Yes
Location : path
Type : string
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.
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
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 : The name of the region for this request.
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Parameter Order :
Description : Deletes the specified instance template. Deleting an instance template is permanent and cannot be undone.
Flat Path : projects/{project}/regions/{region}/instanceTemplates/{instanceTemplate}
▼ ▲ compute.regionInstanceTemplates.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.
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
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.
region
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : The name of the regions for this request.
Type : string
Required : Yes
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`)
Type : integer
Format : uint32
Location : query
Default : 500
Scopes :
Parameter Order :
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/regions/{region}/instanceTemplates
HTTP Method : GET
Path : projects/{project}/regions/{region}/instanceTemplates
Description : Retrieves a list of instance templates that are contained within the specified project and region.
▼ ▲ compute.regionInstanceTemplates.get
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])?))
Type : string
Location : path
instanceTemplate
Required : Yes
Description : The name of the instance template.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Type : string
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
Flat Path : projects/{project}/regions/{region}/instanceTemplates/{instanceTemplate}
Path : projects/{project}/regions/{region}/instanceTemplates/{instanceTemplate}
Parameter Order :
HTTP Method : GET
Description : Returns the specified instance template.
Apiversion : 2026-10-01-preview
▼ ▲ compute.targetTcpProxies.get
HTTP Method : GET
Scopes :
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/global/targetTcpProxies/{targetTcpProxy}
Path : projects/{project}/global/targetTcpProxies/{targetTcpProxy}
Description : Returns the specified TargetTcpProxy resource.
Parameter Order :
Parameters :
targetTcpProxy
Description : Name of the TargetTcpProxy resource to return.
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
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
▼ ▲ compute.targetTcpProxies.testIamPermissions
Parameter Order :
Apiversion : 2026-10-01-preview
HTTP Method : POST
Scopes :
Flat Path : projects/{project}/global/targetTcpProxies/{resource}/testIamPermissions
Description : Returns permissions that a caller has on the specified resource.
Path : projects/{project}/global/targetTcpProxies/{resource}/testIamPermissions
Parameters :
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
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
▼ ▲ compute.targetTcpProxies.insert
Scopes :
HTTP Method : POST
Apiversion : 2026-10-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
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}/global/targetTcpProxies
Flat Path : projects/{project}/global/targetTcpProxies
Parameter Order : project
Description : Creates a TargetTcpProxy resource in the specified project using the data included in the request.
▼ ▲ compute.targetTcpProxies.delete
Apiversion : 2026-10-01-preview
HTTP Method : DELETE
Scopes :
Description : Deletes the specified TargetTcpProxy resource.
Flat Path : projects/{project}/global/targetTcpProxies/{targetTcpProxy}
Path : projects/{project}/global/targetTcpProxies/{targetTcpProxy}
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
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])?))
targetTcpProxy
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 TargetTcpProxy resource to delete.
Location : path
Parameter Order :
▼ ▲ compute.targetTcpProxies.list
Description : Retrieves the list of TargetTcpProxy resources available to the specified project.
Path : projects/{project}/global/targetTcpProxies
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
maxResults
Default : 500
Location : query
Type : integer
Format : uint32
Description : The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
Minimum : 0
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
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
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 :
Parameter Order : project
Apiversion : 2026-10-01-preview
HTTP Method : GET
Flat Path : projects/{project}/global/targetTcpProxies
▼ ▲ compute.targetTcpProxies.setBackendService
Parameter Order :
Description : Changes the BackendService for TargetTcpProxy.
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
targetTcpProxy
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 TargetTcpProxy resource whose BackendService resource is to be set.
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).
Flat Path : projects/{project}/global/targetTcpProxies/{targetTcpProxy}/setBackendService
Scopes :
Apiversion : 2026-10-01-preview
HTTP Method : POST
Path : projects/{project}/global/targetTcpProxies/{targetTcpProxy}/setBackendService
▼ ▲ compute.targetTcpProxies.setProxyHeader
Path : projects/{project}/global/targetTcpProxies/{targetTcpProxy}/setProxyHeader
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
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 whose ProxyHeader is to be set.
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
Description : Changes the ProxyHeaderType for TargetTcpProxy.
Flat Path : projects/{project}/global/targetTcpProxies/{targetTcpProxy}/setProxyHeader
Parameter Order :
HTTP Method : POST
Apiversion : 2026-10-01-preview
▼ ▲ compute.targetTcpProxies.aggregatedList
Path : projects/{project}/aggregated/targetTcpProxies
Parameter Order : project
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
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
project
Location : path
Description : Name of the project scoping 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])?))
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
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
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.
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
Flat Path : projects/{project}/aggregated/targetTcpProxies
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`.
HTTP Method : GET
Apiversion : 2026-10-01-preview
▼ ▲ compute.regionCommitments.list
Parameter Order :
Path : projects/{project}/regions/{region}/commitments
Flat Path : projects/{project}/regions/{region}/commitments
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
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
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
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
Location : query
Type : integer
Minimum : 0
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Description : Name of the region for this request.
Location : path
Type : string
Description : Retrieves a list of commitments contained within the specified region.
Apiversion : 2026-10-01-preview
Scopes :
HTTP Method : GET
▼ ▲ compute.regionCommitments.aggregatedList
Path : projects/{project}/aggregated/commitments
HTTP Method : GET
Parameter Order : project
Apiversion : 2026-10-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.
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
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.
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
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
maxResults
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`)
Default : 500
Format : uint32
Scopes :
Flat 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`.
▼ ▲ compute.regionCommitments.insert
HTTP Method : POST
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/regions/{region}/commitments
Description : Creates a commitment in the specified project using the data included in the request.
Path : projects/{project}/regions/{region}/commitments
Parameter Order :
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.
Location : path
Pattern : [a-z](?:[-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).
Type : string
Location : query
Scopes :
▼ ▲ compute.regionCommitments.update
Flat Path : projects/{project}/regions/{region}/commitments/{commitment}
Parameter Order :
Parameters :
paths
Location : query
Repeated : 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
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
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
commitment
Description : Name of the commitment that you want to update.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Required : Yes
updateMask
Description : update_mask indicates fields to be updated as part of this request.
Type : string
Location : query
Format : google-fieldmask
HTTP Method : PATCH
Apiversion : 2026-10-01-preview
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.
Path : projects/{project}/regions/{region}/commitments/{commitment}
▼ ▲ compute.regionCommitments.get
Path : projects/{project}/regions/{region}/commitments/{commitment}
Parameters :
commitment
Description : Name of the commitment 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
Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-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
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
Description : Returns the specified commitment resource.
Parameter Order :
Scopes :
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/regions/{region}/commitments/{commitment}
HTTP Method : GET
▼ ▲ compute.organizationSecurityPolicies.patch
Parameters :
securityPolicy
Pattern : (securityPolicies/)?[0-9]{0,20}
Required : Yes
Type : string
Description : Name of the security 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
Parameter Order : securityPolicy
Scopes :
Path : locations/global/securityPolicies/{securityPolicy}
Flat Path : locations/global/securityPolicies/{securityPolicy}
HTTP Method : PATCH
Apiversion : 2026-10-01-preview
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.
▼ ▲ compute.organizationSecurityPolicies.delete
Parameter Order : securityPolicy
Flat Path : locations/global/securityPolicies/{securityPolicy}
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.
Parameters :
securityPolicy
Location : path
Description : Name of the security policy to delete.
Required : Yes
Pattern : (securityPolicies/)?[0-9]{0,20}
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
Scopes :
Path : locations/global/securityPolicies/{securityPolicy}
Apiversion : 2026-10-01-preview
HTTP Method : DELETE
▼ ▲ compute.organizationSecurityPolicies.listAssociations
Scopes :
Parameters :
targetResource
Description : The target resource to list associations. It is an organization, or a folder.
Type : string
Location : query
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.
Path : locations/global/securityPolicies/listAssociations
Flat Path : locations/global/securityPolicies/listAssociations
Apiversion : 2026-10-01-preview
HTTP Method : GET
▼ ▲ compute.organizationSecurityPolicies.getRule
Scopes :
Path : locations/global/securityPolicies/{securityPolicy}/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.
Apiversion : 2026-10-01-preview
Parameter Order : securityPolicy
Parameters :
securityPolicy
Description : Name of the security policy to which the queried rule belongs.
Required : Yes
Location : path
Type : string
Pattern : (securityPolicies/)?[0-9]{0,20}
priority
Description : The priority of the rule to get from the security policy.
Location : query
Type : integer
Format : int32
Flat Path : locations/global/securityPolicies/{securityPolicy}/getRule
▼ ▲ compute.organizationSecurityPolicies.listPreconfiguredExpressionSets
Description : Gets the current list of preconfigured Web Application Firewall (WAF) expressions.
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
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
parentId
Description : Parent ID for this request.
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
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
Minimum : 0
Scopes :
Path : locations/global/securityPolicies/listPreconfiguredExpressionSets
HTTP Method : GET
Flat Path : locations/global/securityPolicies/listPreconfiguredExpressionSets
Apiversion : 2026-10-01-preview
▼ ▲ compute.organizationSecurityPolicies.get
Flat Path : locations/global/securityPolicies/{securityPolicy}
Parameters :
securityPolicy
Location : path
Pattern : (securityPolicies/)?[0-9]{0,20}
Type : string
Description : Name of the security policy to get.
Required : Yes
Scopes :
HTTP Method : GET
Apiversion : 2026-10-01-preview
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.
Parameter Order : securityPolicy
Path : locations/global/securityPolicies/{securityPolicy}
▼ ▲ compute.organizationSecurityPolicies.removeRule
Parameter Order : securityPolicy
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.
Scopes :
Parameters :
securityPolicy
Location : path
Pattern : (securityPolicies/)?[0-9]{0,20}
Description : Name of the security policy to update.
Type : string
Required : Yes
priority
Description : The priority of the rule to remove from the security policy.
Format : int32
Location : query
Type : integer
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-10-01-preview
HTTP Method : POST
Flat Path : locations/global/securityPolicies/{securityPolicy}/removeRule
Path : locations/global/securityPolicies/{securityPolicy}/removeRule
▼ ▲ compute.organizationSecurityPolicies.move
HTTP Method : POST
Scopes :
Apiversion : 2026-10-01-preview
Path : locations/global/securityPolicies/{securityPolicy}/move
Flat Path : locations/global/securityPolicies/{securityPolicy}/move
Parameter Order : securityPolicy
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
Type : string
Description : The new parent of the security policy.
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
securityPolicy
Location : path
Description : Name of the security policy to update.
Required : Yes
Type : string
Pattern : (securityPolicies/)?[0-9]{0,20}
▼ ▲ 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.
Apiversion : 2026-10-01-preview
HTTP Method : POST
Parameter Order : securityPolicy
Path : locations/global/securityPolicies/{securityPolicy}/addAssociation
Parameters :
replaceExistingAssociation
Location : query
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.
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).
securityPolicy
Pattern : (securityPolicies/)?[0-9]{0,20}
Type : string
Location : path
Description : Name of the security policy to update.
Required : Yes
Flat Path : locations/global/securityPolicies/{securityPolicy}/addAssociation
Scopes :
▼ ▲ compute.organizationSecurityPolicies.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
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`)
Default : 500
Location : query
Format : uint32
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.
parentId
Location : query
Type : string
Description : Parent ID for this request.
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.
Path : locations/global/securityPolicies
Scopes :
Flat Path : locations/global/securityPolicies
HTTP Method : GET
Apiversion : 2026-10-01-preview
▼ ▲ compute.organizationSecurityPolicies.patchRule
Parameter Order : securityPolicy
Apiversion : 2026-10-01-preview
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.
Scopes :
HTTP Method : POST
Path : locations/global/securityPolicies/{securityPolicy}/patchRule
Flat Path : locations/global/securityPolicies/{securityPolicy}/patchRule
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
Format : int32
Location : query
Type : integer
Description : The priority of the rule to patch.
securityPolicy
Pattern : (securityPolicies/)?[0-9]{0,20}
Description : Name of the security policy to update.
Location : path
Type : string
Required : Yes
▼ ▲ compute.organizationSecurityPolicies.insert
HTTP Method : POST
Apiversion : 2026-10-01-preview
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.
Flat Path : locations/global/securityPolicies
Path : locations/global/securityPolicies
Scopes :
Parameters :
parentId
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.
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).
▼ ▲ compute.organizationSecurityPolicies.removeAssociation
Parameter Order : securityPolicy
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.
Parameters :
securityPolicy
Pattern : (securityPolicies/)?[0-9]{0,20}
Location : path
Description : Name of the security 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
name
Location : query
Description : Name for the attachment that will be removed.
Type : string
Flat Path : locations/global/securityPolicies/{securityPolicy}/removeAssociation
Apiversion : 2026-10-01-preview
HTTP Method : POST
Scopes :
Path : locations/global/securityPolicies/{securityPolicy}/removeAssociation
▼ ▲ compute.organizationSecurityPolicies.addRule
Path : locations/global/securityPolicies/{securityPolicy}/addRule
Flat Path : locations/global/securityPolicies/{securityPolicy}/addRule
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
Type : string
Pattern : (securityPolicies/)?[0-9]{0,20}
Description : Name of the security policy to update.
Required : Yes
Location : path
Parameter Order : securityPolicy
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 :
HTTP Method : POST
Apiversion : 2026-10-01-preview
▼ ▲ compute.organizationSecurityPolicies.getAssociation
Apiversion : 2026-10-01-preview
HTTP Method : GET
Parameter Order : securityPolicy
Scopes :
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.
Parameters :
name
Type : string
Location : query
Description : The name of the association to get from the security policy.
securityPolicy
Pattern : (securityPolicies/)?[0-9]{0,20}
Location : path
Required : Yes
Description : Name of the security policy to which the queried rule belongs.
Type : string
Flat Path : locations/global/securityPolicies/{securityPolicy}/getAssociation
▼ ▲ 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.
Path : locations/global/securityPolicies/{securityPolicy}/copyRules
Parameters :
securityPolicy
Pattern : (securityPolicies/)?[0-9]{0,20}
Required : Yes
Type : string
Description : Name of the security policy to update.
Location : path
sourceSecurityPolicy
Type : string
Location : query
Description : The security policy from which to copy rules.
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 : locations/global/securityPolicies/{securityPolicy}/copyRules
Apiversion : 2026-10-01-preview
Parameter Order : securityPolicy
HTTP Method : POST
Scopes :
▼ ▲ compute.snapshotSettings.get
Scopes :
Description : Get snapshot settings.
HTTP Method : GET
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/global/snapshotSettings
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
Path : projects/{project}/global/snapshotSettings
Parameter Order : project
▼ ▲ compute.snapshotSettings.patch
Description : Patch snapshot settings.
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
updateMask
Description : update_mask indicates fields to be updated as part of this request.
Location : query
Type : string
Format : google-fieldmask
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
Apiversion : 2026-10-01-preview
Path : projects/{project}/global/snapshotSettings
HTTP Method : PATCH
Parameter Order : project
Scopes :
Flat Path : projects/{project}/global/snapshotSettings
▼ ▲ compute.regionSecurityPolicies.insert
Path : projects/{project}/regions/{region}/securityPolicies
Apiversion : 2026-10-01-preview
HTTP Method : POST
Flat Path : projects/{project}/regions/{region}/securityPolicies
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
Required : Yes
Description : Name of the region scoping this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
validateOnly
Description : If true, the request will not be committed.
Location : query
Type : boolean
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 : Creates a new policy in the specified project using the data included in the request.
Parameter Order :
Scopes :
▼ ▲ compute.regionSecurityPolicies.delete
Path : projects/{project}/regions/{region}/securityPolicies/{securityPolicy}
Parameter Order :
Scopes :
HTTP Method : DELETE
Apiversion : 2026-10-01-preview
Description : Deletes the specified policy.
Parameters :
securityPolicy
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 security policy to delete.
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
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
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.
Flat Path : projects/{project}/regions/{region}/securityPolicies/{securityPolicy}
▼ ▲ compute.regionSecurityPolicies.list
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])?))
maxResults
Location : query
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`)
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.
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
filter
Description : A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based onresource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using GoogleRE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.
Type : string
Location : query
orderBy
Location : query
Type : string
Description : Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.
Description : List all the policies that have been configured for the specified project and region.
Scopes :
Parameter Order :
Path : projects/{project}/regions/{region}/securityPolicies
Apiversion : 2026-10-01-preview
HTTP Method : GET
Flat Path : projects/{project}/regions/{region}/securityPolicies
▼ ▲ compute.regionSecurityPolicies.removeRule
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
region
Description : Name of the region scoping this request.
Required : Yes
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
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
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}/securityPolicies/{securityPolicy}/removeRule
Parameter Order :
Description : Deletes a rule at the specified priority.
Path : projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/removeRule
HTTP Method : POST
Apiversion : 2026-10-01-preview
Scopes :
▼ ▲ compute.regionSecurityPolicies.get
Scopes :
Path : projects/{project}/regions/{region}/securityPolicies/{securityPolicy}
Parameters :
securityPolicy
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 security policy to get.
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
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
Description : List all of the ordered rules present in a single specified policy.
HTTP Method : GET
Apiversion : 2026-10-01-preview
Parameter Order :
Flat Path : projects/{project}/regions/{region}/securityPolicies/{securityPolicy}
▼ ▲ compute.regionSecurityPolicies.patch
HTTP Method : PATCH
Flat Path : projects/{project}/regions/{region}/securityPolicies/{securityPolicy}
Apiversion : 2026-10-01-preview
Scopes :
Parameter Order :
Path : projects/{project}/regions/{region}/securityPolicies/{securityPolicy}
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
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
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
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.
Location : path
updateMask
Format : google-fieldmask
Description : Indicates fields to be cleared as part of this request.
Type : string
Location : query
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.
▼ ▲ compute.regionSecurityPolicies.setLabels
Apiversion : 2026-10-01-preview
HTTP Method : POST
Path : projects/{project}/regions/{region}/securityPolicies/{resource}/setLabels
Flat Path : projects/{project}/regions/{region}/securityPolicies/{resource}/setLabels
Description : Sets the labels on a security policy. To learn more about labels, read the Labeling Resources documentation.
Scopes :
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
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 : The region for this request.
Location : path
Type : string
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
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}
▼ ▲ compute.regionSecurityPolicies.getRule
Parameters :
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
priority
Location : query
Description : The priority of the rule to get from the security policy.
Format : int32
Type : integer
securityPolicy
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 which the queried rule belongs.
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])?))
Description : Project ID for this request.
Type : string
Required : Yes
Parameter Order :
Flat Path : projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/getRule
Scopes :
Path : projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/getRule
Description : Gets a rule at the specified priority.
HTTP Method : GET
Apiversion : 2026-10-01-preview
▼ ▲ compute.regionSecurityPolicies.addRule
Parameter Order :
Path : projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/addRule
Flat Path : projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/addRule
HTTP Method : POST
Scopes :
Apiversion : 2026-10-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])?))
Required : Yes
Description : Project ID for this request.
Location : path
validateOnly
Type : boolean
Description : If true, the request will not be committed.
Location : query
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}
Type : string
Required : Yes
Location : path
region
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Name of the region scoping this request.
Required : Yes
Location : path
Description : Inserts a rule into a security policy.
▼ ▲ compute.regionSecurityPolicies.patchRule
HTTP Method : POST
Path : projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/patchRule
Apiversion : 2026-10-01-preview
Parameter Order :
Flat Path : projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/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.
Scopes :
Parameters :
priority
Format : int32
Description : The priority of the rule to patch.
Type : integer
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])?))
Location : path
Description : Project ID for this request.
Required : Yes
validateOnly
Description : If true, the request will not be committed.
Type : boolean
Location : query
securityPolicy
Location : path
Description : Name of the security policy to update.
Type : string
Required : Yes
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
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
updateMask
Type : string
Location : query
Description : Indicates fields to be cleared as part of this request.
Format : google-fieldmask
▼ ▲ compute.regionSnapshotSettings.get
Scopes :
Parameter Order :
Parameters :
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
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.
Description : Get region snapshot settings.
Path : projects/{project}/regions/{region}/snapshotSettings
Apiversion : 2026-10-01-preview
HTTP Method : GET
Flat Path : projects/{project}/regions/{region}/snapshotSettings
▼ ▲ compute.regionSnapshotSettings.patch
Parameter Order :
Parameters :
region
Location : path
Type : string
Description : Name of the region for this request.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
updateMask
Location : query
Description : update_mask indicates fields to be updated as part of this request.
Type : string
Format : google-fieldmask
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).
Description : Patch region snapshot settings.
Flat Path : projects/{project}/regions/{region}/snapshotSettings
Path : projects/{project}/regions/{region}/snapshotSettings
HTTP Method : PATCH
Apiversion : 2026-10-01-preview
Scopes :
▼ ▲ compute.regionAutoscalers.testIamPermissions
Description : Returns permissions that a caller has on the specified resource.
Flat Path : projects/{project}/regions/{region}/autoscalers/{resource}/testIamPermissions
Parameters :
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
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
resource
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 or id of the resource for this request.
Parameter Order :
Apiversion : 2026-10-01-preview
HTTP Method : POST
Path : projects/{project}/regions/{region}/autoscalers/{resource}/testIamPermissions
Scopes :
▼ ▲ compute.regionAutoscalers.insert
HTTP Method : POST
Apiversion : 2026-10-01-preview
Description : Creates an autoscaler in the specified project using the data included in the request.
Scopes :
Parameter Order :
Flat Path : projects/{project}/regions/{region}/autoscalers
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
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
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])?))
Required : Yes
Description : Project ID for this request.
Location : path
Path : projects/{project}/regions/{region}/autoscalers
▼ ▲ compute.regionAutoscalers.delete
Path : projects/{project}/regions/{region}/autoscalers/{autoscaler}
Parameter Order :
Scopes :
Parameters :
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
autoscaler
Location : path
Description : Name of the autoscaler to delete.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
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
Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-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
Apiversion : 2026-10-01-preview
HTTP Method : DELETE
Flat Path : projects/{project}/regions/{region}/autoscalers/{autoscaler}
Description : Deletes the specified autoscaler.
▼ ▲ compute.regionAutoscalers.list
Path : projects/{project}/regions/{region}/autoscalers
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.
region
Location : path
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Description : Name of the region scoping 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.
maxResults
Minimum : 0
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`)
Default : 500
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.
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}/regions/{region}/autoscalers
HTTP Method : GET
Apiversion : 2026-10-01-preview
Parameter Order :
Description : Retrieves a list of autoscalers contained within the specified region.
▼ ▲ compute.regionAutoscalers.update
HTTP Method : PUT
Apiversion : 2026-10-01-preview
Description : Updates an autoscaler in the specified project using the data included in the request.
Flat Path : projects/{project}/regions/{region}/autoscalers
Scopes :
Parameter Order :
Parameters :
region
Location : path
Description : Name of the region scoping this request.
Type : string
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
autoscaler
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : query
Description : Name of the autoscaler to update.
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
Path : projects/{project}/regions/{region}/autoscalers
▼ ▲ compute.regionAutoscalers.patch
Parameter Order :
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
Required : Yes
Location : path
Description : Project ID for this request.
autoscaler
Location : query
Description : Name of the autoscaler to patch.
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).
Type : string
Location : query
region
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Description : Name of the region scoping this request.
Type : string
Path : projects/{project}/regions/{region}/autoscalers
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
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/regions/{region}/autoscalers
▼ ▲ compute.regionAutoscalers.get
Scopes :
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
autoscaler
Description : Name of the autoscaler 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}
region
Location : path
Type : string
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Name of the region scoping this request.
Description : Returns the specified autoscaler.
Flat Path : projects/{project}/regions/{region}/autoscalers/{autoscaler}
Path : projects/{project}/regions/{region}/autoscalers/{autoscaler}
Parameter Order :
HTTP Method : GET
Apiversion : 2026-10-01-preview
▼ ▲ compute.reservations.aggregatedList
Apiversion : 2026-10-01-preview
HTTP Method : GET
Flat Path : projects/{project}/aggregated/reservations
Path : projects/{project}/aggregated/reservations
Scopes :
Description : Retrieves an aggregated list of reservations. To prevent failure, it is recommended that you set the `returnPartialSuccess` parameter to `true`.
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
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
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
Default : 500
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.
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
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
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.
Parameter Order : project
▼ ▲ compute.reservations.update
Scopes :
Parameters :
updateMask
Description : Update_mask indicates fields to be updated as part of this request.
Location : query
Format : google-fieldmask
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])?))
reservation
Location : path
Description : Name of the reservation to update.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
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
Description : Name of the zone for this request.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Required : Yes
paths
Type : string
Location : query
Repeated : Yes
Parameter Order :
Description : Update share settings of the reservation.
Path : projects/{project}/zones/{zone}/reservations/{reservation}
Flat Path : projects/{project}/zones/{zone}/reservations/{reservation}
Apiversion : 2026-10-01-preview
HTTP Method : PATCH
▼ ▲ compute.reservations.get
Scopes :
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
zone
Location : path
Description : Name of the zone for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Required : Yes
reservation
Type : string
Location : path
Description : Name of the reservation to retrieve.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Flat Path : projects/{project}/zones/{zone}/reservations/{reservation}
Path : projects/{project}/zones/{zone}/reservations/{reservation}
Apiversion : 2026-10-01-preview
HTTP Method : GET
Parameter Order :
Description : Retrieves information about the specified reservation.
▼ ▲ compute.reservations.testIamPermissions
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.
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
zone
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Description : The name of the zone for this request.
Type : string
Location : path
Scopes :
Path : projects/{project}/zones/{zone}/reservations/{resource}/testIamPermissions
Description : Returns permissions that a caller has on the specified resource.
Parameter Order :
Flat Path : projects/{project}/zones/{zone}/reservations/{resource}/testIamPermissions
HTTP Method : POST
Apiversion : 2026-10-01-preview
▼ ▲ compute.reservations.setIamPolicy
Flat Path : projects/{project}/zones/{zone}/reservations/{resource}/setIamPolicy
HTTP Method : POST
Apiversion : 2026-10-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])?))
zone
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Description : The name of the zone for this request.
Type : string
Location : path
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 :
Description : Sets the access control policy on the specified resource. Replaces any existing policy.
Path : projects/{project}/zones/{zone}/reservations/{resource}/setIamPolicy
Scopes :
▼ ▲ compute.reservations.getIamPolicy
Parameters :
project
Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Location : path
Description : Project ID for this request.
Required : Yes
Type : string
zone
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.
optionsRequestedPolicyVersion
Location : query
Format : int32
Type : integer
Description : Requested IAM Policy version.
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
Description : Gets the access control policy for a resource. May be empty if no such policy or resource exists.
Parameter Order :
Path : projects/{project}/zones/{zone}/reservations/{resource}/getIamPolicy
Scopes :
Apiversion : 2026-10-01-preview
HTTP Method : GET
Flat Path : projects/{project}/zones/{zone}/reservations/{resource}/getIamPolicy
▼ ▲ compute.reservations.resize
Path : projects/{project}/zones/{zone}/reservations/{reservation}/resize
Scopes :
Parameter Order :
HTTP Method : POST
Flat Path : projects/{project}/zones/{zone}/reservations/{reservation}/resize
Apiversion : 2026-10-01-preview
Parameters :
zone
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Location : path
Description : Name of the zone 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).
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])?))
reservation
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Name of the reservation to update.
Location : path
Type : string
Required : Yes
Description : Resizes the reservation (applicable to standalone reservations only). For more information, readModifying reservations.
▼ ▲ compute.reservations.list
Parameter Order :
HTTP Method : GET
Apiversion : 2026-10-01-preview
Scopes :
Path : projects/{project}/zones/{zone}/reservations
Parameters :
maxResults
Format : uint32
Location : query
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
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
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
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
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.
Type : string
Location : query
Flat Path : projects/{project}/zones/{zone}/reservations
Description : A list of all the reservations that have been configured for the specified project in specified zone.
▼ ▲ compute.reservations.insert
Path : projects/{project}/zones/{zone}/reservations
Flat Path : projects/{project}/zones/{zone}/reservations
Parameter Order :
Description : Creates a new reservation. For more information, readReserving zonal resources.
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
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 : Name of the zone for this request.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Apiversion : 2026-10-01-preview
Scopes :
HTTP Method : POST
▼ ▲ compute.reservations.delete
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/zones/{zone}/reservations/{reservation}
HTTP Method : DELETE
Scopes :
Parameter Order :
Description : Deletes the specified reservation.
Path : projects/{project}/zones/{zone}/reservations/{reservation}
Parameters :
reservation
Required : Yes
Type : string
Description : Name of the reservation 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).
Type : string
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.
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.reservations.performMaintenance
Description : Perform maintenance on an extended reservation
Apiversion : 2026-10-01-preview
HTTP Method : POST
Path : projects/{project}/zones/{zone}/reservations/{reservation}/performMaintenance
Parameter Order :
Flat Path : projects/{project}/zones/{zone}/reservations/{reservation}/performMaintenance
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
Description : Name of the zone for this request. Zone name should conform to RFC1035.
Required : Yes
Location : path
Type : string
project
Required : Yes
Type : string
Description : Project ID for this request.
Location : path
reservation
Required : Yes
Description : The name of the reservation. Name should conform to RFC1035 or be a resource ID.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Type : string
▼ ▲ compute.networkFirewallPolicies.insert
HTTP Method : POST
Apiversion : 2026-10-01-preview
Parameter Order : project
Flat Path : projects/{project}/global/firewallPolicies
Path : projects/{project}/global/firewallPolicies
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
Description : Creates a new policy in the specified project using the data included in the request.
Scopes :
▼ ▲ compute.networkFirewallPolicies.aggregatedList
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
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
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
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.
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
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
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
Parameter Order : project
Scopes :
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`.
Apiversion : 2026-10-01-preview
Path : projects/{project}/aggregated/firewallPolicies
HTTP Method : GET
Flat Path : projects/{project}/aggregated/firewallPolicies
▼ ▲ compute.networkFirewallPolicies.addPacketMirroringRule
Flat Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/addPacketMirroringRule
Description : Inserts a packet mirroring rule into a firewall policy.
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
maxPriority
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
Location : query
firewallPolicy
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
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
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
Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/addPacketMirroringRule
Scopes :
Parameter Order :
HTTP Method : POST
Apiversion : 2026-10-01-preview
▼ ▲ compute.networkFirewallPolicies.getAssociation
Description : Gets an association with the specified name.
Parameter Order :
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])?))
name
Description : The name of the association to get from the firewall policy.
Location : query
Type : string
firewallPolicy
Required : Yes
Description : Name of the firewall policy to which the queried association belongs.
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/getAssociation
HTTP Method : GET
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/getAssociation
▼ ▲ compute.networkFirewallPolicies.list
Scopes :
Path : projects/{project}/global/firewallPolicies
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
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
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])?))
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
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
Description : Lists all the policies that have been configured for the specified project.
Parameter Order : project
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/global/firewallPolicies
HTTP Method : GET
▼ ▲ compute.networkFirewallPolicies.setIamPolicy
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
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}
Flat Path : projects/{project}/global/firewallPolicies/{resource}/setIamPolicy
Scopes :
Path : projects/{project}/global/firewallPolicies/{resource}/setIamPolicy
HTTP Method : POST
Parameter Order :
Description : Sets the access control policy on the specified resource. Replaces any existing policy.
Apiversion : 2026-10-01-preview
▼ ▲ compute.networkFirewallPolicies.addRule
Flat Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/addRule
Parameters :
firewallPolicy
Location : path
Description : Name of the firewall policy to update.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
maxPriority
Description : When rule.priority is not specified, auto choose a unused priority betweenminPriority and maxPriority>. This field is exclusive with rule.priority.
Format : int32
Location : query
Type : integer
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.
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
minPriority
Description : When rule.priority is not specified, auto choose a unused priority betweenminPriority and maxPriority>. This field is exclusive with rule.priority.
Format : int32
Type : integer
Location : query
Parameter Order :
Scopes :
Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/addRule
Description : Inserts a rule into a firewall policy.
Apiversion : 2026-10-01-preview
HTTP Method : POST
▼ ▲ compute.networkFirewallPolicies.testIamPermissions
Path : projects/{project}/global/firewallPolicies/{resource}/testIamPermissions
Description : Returns permissions that a caller has on the specified resource.
Parameter Order :
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
resource
Required : Yes
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}
Apiversion : 2026-10-01-preview
HTTP Method : POST
Flat Path : projects/{project}/global/firewallPolicies/{resource}/testIamPermissions
Scopes :
▼ ▲ compute.networkFirewallPolicies.patchPacketMirroringRule
Parameters :
firewallPolicy
Required : Yes
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}
Location : path
priority
Type : integer
Description : The priority of the rule to patch.
Format : int32
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. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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
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 :
Flat Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/patchPacketMirroringRule
Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/patchPacketMirroringRule
Apiversion : 2026-10-01-preview
HTTP Method : POST
Description : Patches a packet mirroring rule of the specified priority.
Parameter Order :
▼ ▲ compute.networkFirewallPolicies.cloneRules
Parameter Order :
Scopes :
HTTP Method : POST
Description : Copies rules to the specified firewall policy.
Apiversion : 2026-10-01-preview
Parameters :
sourceFirewallPolicy
Type : string
Location : query
Description : The firewall policy from which to copy rules.
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])?))
Required : Yes
Description : Project ID for this request.
Type : string
Location : path
firewallPolicy
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
Type : string
Required : Yes
Flat Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/cloneRules
Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/cloneRules
▼ ▲ compute.networkFirewallPolicies.addAssociation
HTTP Method : POST
Apiversion : 2026-10-01-preview
Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/addAssociation
Description : Inserts an association for the specified firewall policy.
Parameter Order :
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
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
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).
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
Scopes :
Flat Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/addAssociation
▼ ▲ compute.networkFirewallPolicies.getIamPolicy
Parameter Order :
Description : Gets the access control policy for a resource. May be empty if no such policy or resource exists.
Scopes :
Parameters :
resource
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 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
optionsRequestedPolicyVersion
Description : Requested IAM Policy version.
Type : integer
Format : int32
Location : query
Path : projects/{project}/global/firewallPolicies/{resource}/getIamPolicy
HTTP Method : GET
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/global/firewallPolicies/{resource}/getIamPolicy
▼ ▲ compute.networkFirewallPolicies.removePacketMirroringRule
HTTP Method : POST
Flat Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/removePacketMirroringRule
Apiversion : 2026-10-01-preview
Scopes :
Parameter Order :
Parameters :
firewallPolicy
Location : path
Description : Name of the firewall policy to update.
Required : Yes
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
priority
Type : integer
Location : query
Description : The priority of the rule to remove from the firewall policy.
Format : int32
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
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 : Deletes a packet mirroring rule of the specified priority.
Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/removePacketMirroringRule
▼ ▲ compute.networkFirewallPolicies.removeAssociation
Apiversion : 2026-10-01-preview
Parameter Order :
HTTP Method : POST
Flat Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/removeAssociation
Scopes :
Description : Removes an association for the specified firewall policy.
Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/removeAssociation
Parameters :
firewallPolicy
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}
Required : Yes
Type : string
Location : path
name
Location : query
Description : Name for the attachment that will be removed.
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
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.
▼ ▲ compute.networkFirewallPolicies.delete
Flat Path : projects/{project}/global/firewallPolicies/{firewallPolicy}
HTTP Method : DELETE
Parameter Order :
Apiversion : 2026-10-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])?))
Location : path
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 delete.
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}/global/firewallPolicies/{firewallPolicy}
Scopes :
Description : Deletes the specified policy.
▼ ▲ compute.networkFirewallPolicies.get
Parameter Order :
Apiversion : 2026-10-01-preview
Scopes :
HTTP Method : GET
Description : Returns the specified network firewall policy.
Flat Path : projects/{project}/global/firewallPolicies/{firewallPolicy}
Path : projects/{project}/global/firewallPolicies/{firewallPolicy}
Parameters :
firewallPolicy
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 firewall policy to get.
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.networkFirewallPolicies.patchRule
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])?))
Type : string
Description : Project ID for this request.
Required : Yes
firewallPolicy
Location : path
Required : Yes
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}
priority
Type : integer
Description : The priority of the rule to patch.
Format : int32
Location : query
Description : Patches a rule of the specified priority.
Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/patchRule
HTTP Method : POST
Parameter Order :
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/patchRule
▼ ▲ compute.networkFirewallPolicies.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])?))
Required : Yes
Description : Project ID for this request.
Type : string
Location : path
firewallPolicy
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}
Required : Yes
Type : string
Location : path
priority
Location : query
Format : int32
Description : The priority of the rule to get from the firewall policy.
Type : integer
Flat Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/getRule
Parameter Order :
Description : Gets a rule of the specified priority.
Scopes :
HTTP Method : GET
Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/getRule
Apiversion : 2026-10-01-preview
▼ ▲ compute.networkFirewallPolicies.removeRule
HTTP Method : POST
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/removeRule
Description : Deletes a rule of the specified priority.
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).
priority
Description : The priority of the rule to remove from the firewall policy.
Location : query
Format : int32
Type : integer
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])?))
firewallPolicy
Location : path
Type : string
Required : Yes
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}
Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/removeRule
Scopes :
▼ ▲ compute.networkFirewallPolicies.patch
Parameters :
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
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.
Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-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
Scopes :
Parameter Order :
Path : projects/{project}/global/firewallPolicies/{firewallPolicy}
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/global/firewallPolicies/{firewallPolicy}
HTTP Method : PATCH
Description : Patches the specified policy with the data included in the request.
▼ ▲ compute.networkFirewallPolicies.getPacketMirroringRule
Parameters :
priority
Description : The priority of the rule to get from the firewall policy.
Location : query
Type : integer
Format : int32
firewallPolicy
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 firewall policy to which the queried rule belongs.
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}/global/firewallPolicies/{firewallPolicy}/getPacketMirroringRule
Description : Gets a packet mirroring rule of the specified priority.
Parameter Order :
Path : projects/{project}/global/firewallPolicies/{firewallPolicy}/getPacketMirroringRule
HTTP Method : GET
Apiversion : 2026-10-01-preview
Scopes :
▼ ▲ compute.imageViews.list
Description : Returns a list of global ImageView resources, with a regional context.
Parameters :
region
Description : Required. Name of the region for this request.
Required : Yes
Type : string
Pattern : [a-z](?:[-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.
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
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`)
Minimum : 0
Type : integer
Location : query
Default : 500
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.
Parameter Order :
Scopes :
Apiversion : 2026-10-01-preview
Path : projects/{project}/regions/{region}/imageViews
Flat Path : projects/{project}/regions/{region}/imageViews
HTTP Method : GET
▼ ▲ compute.imageViews.get
Parameters :
project
Description : Required. 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
resourceId
Type : string
Required : Yes
Description : Name of the image resource to return.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
region
Required : Yes
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Required. Name of the region for this request.
Description : Returns the specified global ImageView resource, with a regional context.
Parameter Order :
Path : projects/{project}/regions/{region}/imageViews/{resourceId}
Scopes :
Flat Path : projects/{project}/regions/{region}/imageViews/{resourceId}
HTTP Method : GET
Apiversion : 2026-10-01-preview
▼ ▲ compute.projectViews.get
HTTP Method : GET
Scopes :
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/regions/{region}/projectViews
Parameter Order :
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.
Parameters :
region
Location : path
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Required. Name of the region for this request. This is part of the URL path.
Type : string
project
Description : Required. Project ID for this request. This is part of the URL path.
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}/projectViews
▼ ▲ compute.instantSnapshots.testIamPermissions
Scopes :
HTTP Method : POST
Flat Path : projects/{project}/zones/{zone}/instantSnapshots/{resource}/testIamPermissions
Apiversion : 2026-10-01-preview
Path : projects/{project}/zones/{zone}/instantSnapshots/{resource}/testIamPermissions
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])?))
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
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}
Description : Returns permissions that a caller has on the specified resource.
Parameter Order :
▼ ▲ compute.instantSnapshots.aggregatedList
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`.
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.
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
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
Location : query
Minimum : 0
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`)
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
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
HTTP Method : GET
Scopes :
Apiversion : 2026-10-01-preview
Path : projects/{project}/aggregated/instantSnapshots
▼ ▲ compute.instantSnapshots.insert
Parameters :
zone
Required : Yes
Type : string
Description : Name of the zone for 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.
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
HTTP Method : POST
Parameter Order :
Apiversion : 2026-10-01-preview
Description : Creates an instant snapshot in the specified zone.
Scopes :
Path : projects/{project}/zones/{zone}/instantSnapshots
Flat Path : projects/{project}/zones/{zone}/instantSnapshots
▼ ▲ compute.instantSnapshots.delete
Scopes :
Flat Path : projects/{project}/zones/{zone}/instantSnapshots/{instantSnapshot}
Parameter Order :
Apiversion : 2026-10-01-preview
HTTP Method : DELETE
Parameters :
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
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
Description : An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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
instantSnapshot
Type : string
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}
Location : path
Path : projects/{project}/zones/{zone}/instantSnapshots/{instantSnapshot}
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.
▼ ▲ compute.instantSnapshots.get
Apiversion : 2026-10-01-preview
HTTP Method : GET
Path : projects/{project}/zones/{zone}/instantSnapshots/{instantSnapshot}
Description : Returns the specified InstantSnapshot resource in the specified zone.
Scopes :
Parameter Order :
Flat Path : projects/{project}/zones/{zone}/instantSnapshots/{instantSnapshot}
Parameters :
instantSnapshot
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 InstantSnapshot resource to return.
Required : Yes
zone
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Location : path
Description : The name of the zone for this request.
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
▼ ▲ compute.instantSnapshots.setIamPolicy
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])?))
resource
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}
Type : string
zone
Required : Yes
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : The name of the zone for this request.
Parameter Order :
Path : projects/{project}/zones/{zone}/instantSnapshots/{resource}/setIamPolicy
Flat Path : projects/{project}/zones/{zone}/instantSnapshots/{resource}/setIamPolicy
Description : Sets the access control policy on the specified resource. Replaces any existing policy.
Apiversion : 2026-10-01-preview
Scopes :
HTTP Method : POST
▼ ▲ compute.instantSnapshots.setLabels
Scopes :
Flat Path : projects/{project}/zones/{zone}/instantSnapshots/{resource}/setLabels
Apiversion : 2026-10-01-preview
HTTP Method : POST
Description : Sets the labels on a instantSnapshot in the given zone. To learn more about labels, read the Labeling Resources documentation.
Path : projects/{project}/zones/{zone}/instantSnapshots/{resource}/setLabels
Parameter Order :
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
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
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
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.instantSnapshots.getIamPolicy
Flat Path : projects/{project}/zones/{zone}/instantSnapshots/{resource}/getIamPolicy
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}
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
optionsRequestedPolicyVersion
Format : int32
Type : integer
Description : Requested IAM Policy version.
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])?
Type : string
Location : path
Path : projects/{project}/zones/{zone}/instantSnapshots/{resource}/getIamPolicy
Parameter Order :
Description : Gets the access control policy for a resource. May be empty if no such policy or resource exists.
Scopes :
Apiversion : 2026-10-01-preview
HTTP Method : GET
▼ ▲ compute.instantSnapshots.list
Parameter Order :
HTTP Method : GET
Apiversion : 2026-10-01-preview
Path : projects/{project}/zones/{zone}/instantSnapshots
Parameters :
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
Type : integer
Default : 500
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
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.
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.
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])?))
Scopes :
Flat Path : projects/{project}/zones/{zone}/instantSnapshots
Description : Retrieves the list of InstantSnapshot resources contained within the specified zone.
▼ ▲ compute.routers.getRoutePolicy
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
policy
Description : The Policy name for this request. Name must conform to RFC1035
Type : string
Location : query
region
Description : Name of the region for this request.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Required : Yes
router
Location : path
Required : Yes
Description : Name of the Router resource to query for the route policy. The name should conform to RFC1035.
Type : string
Parameter Order :
HTTP Method : GET
Scopes :
Flat Path : projects/{project}/regions/{region}/routers/{router}/getRoutePolicy
Apiversion : 2026-10-01-preview
Path : projects/{project}/regions/{region}/routers/{router}/getRoutePolicy
Description : Returns specified Route Policy
▼ ▲ compute.routers.list
Description : Retrieves a list of Router resources available to the specified project.
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
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`)
Format : uint32
Minimum : 0
Location : query
Default : 500
orderBy
Description : Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.
Location : query
Type : string
pageToken
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
Type : string
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Name of the region for this request.
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.
Path : projects/{project}/regions/{region}/routers
Apiversion : 2026-10-01-preview
HTTP Method : GET
Flat Path : projects/{project}/regions/{region}/routers
Parameter Order :
▼ ▲ compute.routers.updateNamedSet
Path : projects/{project}/regions/{region}/routers/{router}/updateNamedSet
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
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
Location : path
Type : string
Description : Name of the region for this request.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
router
Location : path
Type : string
Required : Yes
Description : Name of the Router resource where Named Set is defined.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Updates or creates new Named Set
Parameter Order :
Flat Path : projects/{project}/regions/{region}/routers/{router}/updateNamedSet
Apiversion : 2026-10-01-preview
HTTP Method : POST
▼ ▲ compute.routers.update
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])?))
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
region
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Description : Name of the region for this request.
Location : path
router
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 Router resource to update.
Required : Yes
Parameter Order :
Path : projects/{project}/regions/{region}/routers/{router}
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.
Flat Path : projects/{project}/regions/{region}/routers/{router}
Apiversion : 2026-10-01-preview
HTTP Method : PUT
▼ ▲ compute.routers.listNamedSets
Parameter Order :
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
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Description : Name of the region for this request.
router
Description : Name or id of the resource for this request. Name should conform to RFC1035.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
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
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
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
Format : uint32
Minimum : 0
Scopes :
Path : projects/{project}/regions/{region}/routers/{router}/listNamedSets
HTTP Method : GET
Flat Path : projects/{project}/regions/{region}/routers/{router}/listNamedSets
Apiversion : 2026-10-01-preview
Description : Retrieves a list of router named set subresources available to the specified project.
▼ ▲ compute.routers.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.
Parameter Order :
Flat Path : projects/{project}/regions/{region}/routers/{router}
Scopes :
Parameters :
region
Description : Name of the region for this request.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Required : Yes
router
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 Router resource to patch.
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
Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-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
Path : projects/{project}/regions/{region}/routers/{router}
Apiversion : 2026-10-01-preview
HTTP Method : PATCH
▼ ▲ compute.routers.listRoutePolicies
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
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
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Name of the region for this request.
Type : string
Required : Yes
router
Type : string
Required : Yes
Description : Name or id of the resource for this request. Name should conform to RFC1035.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
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
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
Minimum : 0
Format : uint32
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
Description : Retrieves a list of router route policy subresources available to the specified project.
Scopes :
Parameter Order :
Flat Path : projects/{project}/regions/{region}/routers/{router}/listRoutePolicies
HTTP Method : GET
Path : projects/{project}/regions/{region}/routers/{router}/listRoutePolicies
Apiversion : 2026-10-01-preview
▼ ▲ compute.routers.updateRoutePolicy
Path : projects/{project}/regions/{region}/routers/{router}/updateRoutePolicy
Flat Path : projects/{project}/regions/{region}/routers/{router}/updateRoutePolicy
Parameter Order :
Description : Updates or creates new Route Policy
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
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
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Location : path
Description : Name of the region for this request.
Required : Yes
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
Apiversion : 2026-10-01-preview
HTTP Method : POST
▼ ▲ compute.routers.delete
Path : projects/{project}/regions/{region}/routers/{router}
Parameter Order :
Flat Path : projects/{project}/regions/{region}/routers/{router}
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
Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-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
region
Location : path
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Description : Name of the region for this request.
router
Location : path
Description : Name of the Router resource to delete.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Type : string
Scopes :
Description : Deletes the specified Router resource.
Apiversion : 2026-10-01-preview
HTTP Method : DELETE
▼ ▲ compute.routers.preview
Parameters :
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])?
router
Required : Yes
Description : Name of the Router resource to query.
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])?))
Flat Path : projects/{project}/regions/{region}/routers/{router}/preview
Description : Preview fields auto-generated during router create andupdate operations. Calling this method does NOT create or update the router.
Scopes :
Path : projects/{project}/regions/{region}/routers/{router}/preview
HTTP Method : POST
Apiversion : 2026-10-01-preview
Parameter Order :
▼ ▲ compute.routers.getNamedSet
Parameter Order :
Description : Returns specified Named Set
Parameters :
region
Description : Name of the region for this request.
Required : Yes
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
router
Type : string
Location : path
Description : Name of the Router resource to query for the named set. The name should conform to RFC1035.
Required : Yes
namedSet
Description : The Named Set name for this request. Name must conform to RFC1035
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])?))
Required : Yes
Description : Project ID for this request.
Type : string
Location : path
Path : projects/{project}/regions/{region}/routers/{router}/getNamedSet
HTTP Method : GET
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/regions/{region}/routers/{router}/getNamedSet
Scopes :
▼ ▲ compute.routers.patchNamedSet
Path : projects/{project}/regions/{region}/routers/{router}/patchNamedSet
HTTP Method : POST
Description : Patches Named Set
Apiversion : 2026-10-01-preview
Parameters :
region
Required : Yes
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Description : Name of the region for this request.
router
Description : Name of the Router resource where Named Set 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
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
Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-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.
Parameter Order :
Flat Path : projects/{project}/regions/{region}/routers/{router}/patchNamedSet
Scopes :
▼ ▲ compute.routers.deleteNamedSet
Apiversion : 2026-10-01-preview
HTTP Method : POST
Description : Deletes Named Set
Flat Path : projects/{project}/regions/{region}/routers/{router}/deleteNamedSet
Parameters :
namedSet
Location : query
Type : string
Description : The Named Set name for this request. Name must 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
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
Type : string
Required : Yes
Description : Name of the region for this request.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
router
Description : Name of the Router resource where Named Set is defined.
Required : Yes
Location : path
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Parameter Order :
Path : projects/{project}/regions/{region}/routers/{router}/deleteNamedSet
Scopes :
▼ ▲ compute.routers.getNatMappingInfo
Scopes :
Description : Retrieves runtime Nat mapping information of VM endpoints.
Parameter Order :
Parameters :
filter
Description : A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based onresource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using GoogleRE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.
Location : query
Type : string
natName
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.
Location : query
Type : string
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Location : path
Required : Yes
Description : Name of the region for this request.
router
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 Router resource to query for Nat Mapping information of VM endpoints.
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
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
maxResults
Default : 500
Location : query
Format : uint32
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
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
Path : projects/{project}/regions/{region}/routers/{router}/getNatMappingInfo
Flat Path : projects/{project}/regions/{region}/routers/{router}/getNatMappingInfo
HTTP Method : GET
Apiversion : 2026-10-01-preview
▼ ▲ compute.routers.listBgpRoutes
Apiversion : 2026-10-01-preview
HTTP Method : GET
Parameter Order :
Path : projects/{project}/regions/{region}/routers/{router}/listBgpRoutes
Description : Retrieves a list of router bgp routes available to the specified project.
Scopes :
Flat Path : projects/{project}/regions/{region}/routers/{router}/listBgpRoutes
Parameters :
region
Type : string
Description : Name of the region for this request.
Required : Yes
Pattern : [a-z](?:[-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.
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
routeType
Location : query
Enum Descriptions :
Type : string
Enum :
Description : (Required) limit results to this type of route (either LEARNED or ADVERTISED)
Default : UNSPECIFIED_ROUTE_TYPE
addressFamily
Location : query
Description : (Required) limit results to this address family (either IPv4 or IPv6)
Type : string
Default : UNSPECIFIED_IP_VERSION
Enum Descriptions :
Enum :
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
policyApplied
Type : boolean
Location : query
Default : true
Description : When true, the method returns post-policy routes. Otherwise, it returns pre-policy routes.
router
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. Name should conform to RFC1035.
Type : string
Location : path
Required : Yes
peer
Location : query
Description : (Required) limit results to the BGP peer with the given name. Name should conform to RFC1035.
Type : string
destinationPrefix
Description : Limit results to destinations that are subnets of this CIDR range
Type : string
Location : query
maxResults
Location : query
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`)
▼ ▲ compute.routers.deleteRoutePolicy
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).
policy
Description : The Policy name for this request. Name must conform to RFC1035
Location : query
Type : string
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Description : Name of the region for this request.
Location : path
Type : string
router
Description : Name of the Router resource where Route Policy is defined.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
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])?))
Type : string
Location : path
Required : Yes
Parameter Order :
Flat Path : projects/{project}/regions/{region}/routers/{router}/deleteRoutePolicy
Description : Deletes Route Policy
Apiversion : 2026-10-01-preview
Path : projects/{project}/regions/{region}/routers/{router}/deleteRoutePolicy
HTTP Method : POST
Scopes :
▼ ▲ compute.routers.patchRoutePolicy
Scopes :
Flat Path : projects/{project}/regions/{region}/routers/{router}/patchRoutePolicy
Parameters :
region
Type : string
Location : path
Description : Name of the region for this request.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
router
Location : path
Type : string
Required : Yes
Description : Name of the Router resource where Route Policy is defined.
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
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-10-01-preview
HTTP Method : POST
Parameter Order :
Path : projects/{project}/regions/{region}/routers/{router}/patchRoutePolicy
Description : Patches Route Policy
▼ ▲ compute.routers.aggregatedList
Description : Retrieves an aggregated list of routers. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.
Flat Path : projects/{project}/aggregated/routers
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
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
serviceProjectNumber
Location : query
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.
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
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
Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-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.
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
Parameter Order : project
HTTP Method : GET
Apiversion : 2026-10-01-preview
Scopes :
Path : projects/{project}/aggregated/routers
▼ ▲ compute.routers.get
Scopes :
Description : Returns the specified Router resource.
Apiversion : 2026-10-01-preview
HTTP Method : GET
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
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Name of the region for this request.
Location : path
router
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 Router resource to return.
Flat Path : projects/{project}/regions/{region}/routers/{router}
Path : projects/{project}/regions/{region}/routers/{router}
▼ ▲ compute.routers.getNatIpInfo
Path : projects/{project}/regions/{region}/routers/{router}/getNatIpInfo
Description : Retrieves runtime NAT IP information.
Apiversion : 2026-10-01-preview
Parameter Order :
Scopes :
HTTP Method : GET
Flat Path : projects/{project}/regions/{region}/routers/{router}/getNatIpInfo
Parameters :
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
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
router
Description : Name of the Router resource to query for Nat IP information. The name should conform to RFC1035.
Location : path
Required : Yes
Type : string
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
▼ ▲ compute.routers.insert
Path : projects/{project}/regions/{region}/routers
Flat Path : projects/{project}/regions/{region}/routers
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
Type : string
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
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
Description : Creates a Router resource in the specified project and region using the data included in the request.
Apiversion : 2026-10-01-preview
Scopes :
HTTP Method : POST
▼ ▲ compute.routers.getRouterStatus
Apiversion : 2026-10-01-preview
HTTP Method : GET
Flat Path : projects/{project}/regions/{region}/routers/{router}/getRouterStatus
Scopes :
Parameter Order :
Description : Retrieves runtime information of the specified router.
Path : projects/{project}/regions/{region}/routers/{router}/getRouterStatus
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
Description : Name of the region for this request.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
router
Location : path
Type : string
Description : Name of the Router resource to query.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
▼ ▲ compute.globalAddresses.insert
Apiversion : 2026-10-01-preview
Parameter Order : project
HTTP Method : POST
Description : Creates an address resource in the specified project by using the data included in the request.
Flat Path : projects/{project}/global/addresses
Path : projects/{project}/global/addresses
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
▼ ▲ compute.globalAddresses.delete
Flat Path : projects/{project}/global/addresses/{address}
Description : Deletes the specified address resource.
Apiversion : 2026-10-01-preview
HTTP Method : DELETE
Parameters :
address
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 address resource to delete.
Location : path
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.
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
Scopes :
Path : projects/{project}/global/addresses/{address}
Parameter Order :
▼ ▲ compute.globalAddresses.setLabels
Description : Sets the labels on a GlobalAddress. To learn more about labels, read theLabeling Resources documentation.
Path : projects/{project}/global/addresses/{resource}/setLabels
Flat Path : projects/{project}/global/addresses/{resource}/setLabels
Apiversion : 2026-10-01-preview
HTTP Method : POST
Parameters :
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.
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.
Parameter Order :
Scopes :
▼ ▲ compute.globalAddresses.move
Flat Path : projects/{project}/global/addresses/{address}/move
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).
address
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 address resource to move.
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 : Source project ID which the Address is moved from.
Parameter Order :
Apiversion : 2026-10-01-preview
HTTP Method : POST
Description : Moves the specified address resource from one project to another project.
Path : projects/{project}/global/addresses/{address}/move
▼ ▲ compute.globalAddresses.list
Flat Path : projects/{project}/global/addresses
Path : projects/{project}/global/addresses
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
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
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`)
Location : query
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
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])?))
Description : Retrieves a list of global addresses.
Scopes :
Parameter Order : project
HTTP Method : GET
Apiversion : 2026-10-01-preview
▼ ▲ compute.globalAddresses.get
Flat Path : projects/{project}/global/addresses/{address}
Path : projects/{project}/global/addresses/{address}
Parameters :
address
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Description : Name of the address resource to return.
Type : string
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
Description : Returns the specified address resource.
HTTP Method : GET
Apiversion : 2026-10-01-preview
Scopes :
Parameter Order :
▼ ▲ compute.globalAddresses.testIamPermissions
Scopes :
Parameter Order :
Flat Path : projects/{project}/global/addresses/{resource}/testIamPermissions
HTTP Method : POST
Apiversion : 2026-10-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
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
Description : Returns permissions that a caller has on the specified resource.
Path : projects/{project}/global/addresses/{resource}/testIamPermissions
▼ ▲ compute.subnetworks.patch
Scopes :
Parameters :
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
drainTimeoutSeconds
Type : integer
Format : int32
Location : query
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.
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
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).
subnetwork
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Description : Name of the Subnetwork resource to patch.
Type : string
Location : path
Path : projects/{project}/regions/{region}/subnetworks/{subnetwork}
Flat Path : projects/{project}/regions/{region}/subnetworks/{subnetwork}
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
Parameter Order :
Apiversion : 2026-10-01-preview
▼ ▲ compute.subnetworks.testIamPermissions
Flat Path : projects/{project}/regions/{region}/subnetworks/{resource}/testIamPermissions
Parameters :
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
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
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
Description : Returns permissions that a caller has on the specified resource.
Apiversion : 2026-10-01-preview
HTTP Method : POST
Parameter Order :
Path : projects/{project}/regions/{region}/subnetworks/{resource}/testIamPermissions
Scopes :
▼ ▲ compute.subnetworks.setIamPolicy
Path : projects/{project}/regions/{region}/subnetworks/{resource}/setIamPolicy
Scopes :
Parameters :
region
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Type : string
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
Required : Yes
Location : path
Description : Name or id of the resource for this request.
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.
Description : Sets the access control policy on the specified resource. Replaces any existing policy.
HTTP Method : POST
Parameter Order :
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/regions/{region}/subnetworks/{resource}/setIamPolicy
▼ ▲ compute.subnetworks.getIamPolicy
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
optionsRequestedPolicyVersion
Format : int32
Description : Requested IAM Policy version.
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])?))
Required : Yes
Description : Project ID for this request.
Type : string
resource
Location : path
Type : string
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}
Path : projects/{project}/regions/{region}/subnetworks/{resource}/getIamPolicy
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/regions/{region}/subnetworks/{resource}/getIamPolicy
HTTP Method : GET
Description : Gets the access control policy for a resource. May be empty if no such policy or resource exists.
Scopes :
▼ ▲ compute.subnetworks.insert
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
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 scoping this request.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Location : path
Path : projects/{project}/regions/{region}/subnetworks
Parameter Order :
Flat Path : projects/{project}/regions/{region}/subnetworks
Scopes :
HTTP Method : POST
Description : Creates a subnetwork in the specified project using the data included in the request.
Apiversion : 2026-10-01-preview
▼ ▲ compute.subnetworks.delete
Flat Path : projects/{project}/regions/{region}/subnetworks/{subnetwork}
Description : Deletes the specified subnetwork.
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 delete.
Required : Yes
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
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Description : Name of the region scoping this request.
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
Apiversion : 2026-10-01-preview
Parameter Order :
HTTP Method : DELETE
Path : projects/{project}/regions/{region}/subnetworks/{subnetwork}
Scopes :
▼ ▲ compute.subnetworks.aggregatedList
Parameters :
maxResults
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`)
Format : uint32
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
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])?))
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
views
Enum :
Enum Descriptions :
Repeated : Yes
Type : string
Description : Defines the extra views returned back in the subnetwork resource. Supported values: - WITH_UTILIZATION: Utilization data is included in the response.
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.
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
Path : projects/{project}/aggregated/subnetworks
Scopes :
Description : Retrieves an aggregated list of subnetworks. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.
Parameter Order : project
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/aggregated/subnetworks
HTTP Method : GET
▼ ▲ compute.subnetworks.get
Flat Path : projects/{project}/regions/{region}/subnetworks/{subnetwork}
Parameters :
subnetwork
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the Subnetwork resource to return.
Type : string
Required : Yes
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
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Required : Yes
Location : path
Description : Name of the region scoping this request.
views
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 :
Repeated : Yes
Enum Descriptions :
Location : query
Apiversion : 2026-10-01-preview
Path : projects/{project}/regions/{region}/subnetworks/{subnetwork}
Scopes :
Description : Returns the specified subnetwork.
HTTP Method : GET
Parameter Order :
▼ ▲ compute.subnetworks.list
HTTP Method : GET
Apiversion : 2026-10-01-preview
Scopes :
Path : projects/{project}/regions/{region}/subnetworks
Description : Retrieves a list of subnetworks available to the specified project.
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
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
views
Location : query
Enum Descriptions :
Type : string
Description : Defines the extra views returned back in the subnetwork resource. Supported values: - WITH_UTILIZATION: Utilization data is included in the response.
Repeated : Yes
Enum :
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
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
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
Minimum : 0
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`)
Flat Path : projects/{project}/regions/{region}/subnetworks
Parameter Order :
▼ ▲ compute.subnetworks.expandIpCidrRange
Apiversion : 2026-10-01-preview
Parameter Order :
HTTP Method : POST
Flat Path : projects/{project}/regions/{region}/subnetworks/{subnetwork}/expandIpCidrRange
Description : Expands the IP CIDR range of the subnetwork to a specified value.
Scopes :
Parameters :
region
Description : Name of the region scoping this request.
Type : string
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
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 update.
Required : Yes
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])?))
Type : string
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).
Path : projects/{project}/regions/{region}/subnetworks/{subnetwork}/expandIpCidrRange
▼ ▲ compute.subnetworks.setPrivateIpGoogleAccess
Parameter Order :
HTTP Method : POST
Description : Set whether VMs in this subnet can access Google services without assigning external IP addresses through Private Google Access.
Apiversion : 2026-10-01-preview
Scopes :
Parameters :
subnetwork
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 Subnetwork resource.
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
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
Description : Project ID for this request.
Type : string
Required : Yes
Path : projects/{project}/regions/{region}/subnetworks/{subnetwork}/setPrivateIpGoogleAccess
Flat Path : projects/{project}/regions/{region}/subnetworks/{subnetwork}/setPrivateIpGoogleAccess
▼ ▲ compute.subnetworks.listUsable
Description : Retrieves an aggregated list of all usable subnetworks in the project.
Scopes :
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
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
maxResults
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
Minimum : 0
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
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
Flat Path : projects/{project}/aggregated/subnetworks/listUsable
Parameter Order : project
HTTP Method : GET
Path : projects/{project}/aggregated/subnetworks/listUsable
Apiversion : 2026-10-01-preview
▼ ▲ compute.targetHttpProxies.list
HTTP Method : GET
Parameter Order : project
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/global/targetHttpProxies
Path : projects/{project}/global/targetHttpProxies
Scopes :
Description : Retrieves the list of TargetHttpProxy resources available to the specified 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
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.
Location : query
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])?))
Location : path
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`)
Minimum : 0
Location : query
Format : uint32
Type : integer
Default : 500
▼ ▲ compute.targetHttpProxies.setUrlMap
Apiversion : 2026-10-01-preview
HTTP Method : POST
Path : projects/{project}/targetHttpProxies/{targetHttpProxy}/setUrlMap
Scopes :
Parameter Order :
Description : Changes the URL map for TargetHttpProxy.
Parameters :
targetHttpProxy
Required : Yes
Type : string
Location : path
Description : Name of the TargetHttpProxy to set a URL map for.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
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
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])?))
Flat Path : projects/{project}/targetHttpProxies/{targetHttpProxy}/setUrlMap
▼ ▲ 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.
Apiversion : 2026-10-01-preview
Scopes :
Parameter Order :
Flat Path : projects/{project}/global/targetHttpProxies/{targetHttpProxy}
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])?))
Description : Project ID for this request.
Required : Yes
Location : path
targetHttpProxy
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the TargetHttpProxy resource to patch.
Location : path
Type : string
Required : Yes
Path : projects/{project}/global/targetHttpProxies/{targetHttpProxy}
▼ ▲ compute.targetHttpProxies.insert
HTTP Method : POST
Path : projects/{project}/global/targetHttpProxies
Apiversion : 2026-10-01-preview
Description : Creates a TargetHttpProxy resource in the specified project using the data included in the request.
Parameter Order : project
Flat Path : projects/{project}/global/targetHttpProxies
Scopes :
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
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.targetHttpProxies.delete
Scopes :
Description : Deletes the specified TargetHttpProxy resource.
Flat Path : projects/{project}/global/targetHttpProxies/{targetHttpProxy}
Parameters :
targetHttpProxy
Required : Yes
Type : string
Description : Name of the TargetHttpProxy resource to delete.
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).
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-10-01-preview
Path : projects/{project}/global/targetHttpProxies/{targetHttpProxy}
HTTP Method : DELETE
Parameter Order :
▼ ▲ compute.targetHttpProxies.get
Path : projects/{project}/global/targetHttpProxies/{targetHttpProxy}
Flat Path : projects/{project}/global/targetHttpProxies/{targetHttpProxy}
Parameters :
targetHttpProxy
Description : Name of the TargetHttpProxy resource to return.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Required : Yes
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])?))
Required : Yes
Location : path
Description : Project ID for this request.
Description : Returns the specified TargetHttpProxy resource.
Parameter Order :
Apiversion : 2026-10-01-preview
HTTP Method : GET
Scopes :
▼ ▲ compute.targetHttpProxies.aggregatedList
Parameter Order : project
Path : projects/{project}/aggregated/targetHttpProxies
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
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
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
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
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
project
Type : string
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])?))
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
Flat Path : projects/{project}/aggregated/targetHttpProxies
HTTP Method : GET
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`.
Apiversion : 2026-10-01-preview
Scopes :
▼ ▲ compute.images.getFromFamily
Parameters :
project
Description : The image project that the image belongs to. For example, to get a CentOS image, specify centos-cloud as the image 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
family
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 image family to search for.
Parameter Order :
Flat Path : projects/{project}/global/images/family/{family}
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.
Scopes :
HTTP Method : GET
Apiversion : 2026-10-01-preview
Path : projects/{project}/global/images/family/{family}
▼ ▲ compute.images.setIamPolicy
Parameter Order :
Path : projects/{project}/global/images/{resource}/setIamPolicy
Apiversion : 2026-10-01-preview
Description : Sets the access control policy on the specified resource. Replaces any existing policy.
HTTP Method : POST
Flat Path : projects/{project}/global/images/{resource}/setIamPolicy
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
Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-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
Scopes :
▼ ▲ compute.images.patch
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
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])?))
image
Required : Yes
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 image resource to patch.
Description : Patches the specified image with the data included in the request. Only the following fields can be modified: family, description, deprecation status.
HTTP Method : PATCH
Flat Path : projects/{project}/global/images/{image}
Path : projects/{project}/global/images/{image}
Scopes :
Apiversion : 2026-10-01-preview
Parameter Order :
▼ ▲ compute.images.setLabels
Scopes :
Apiversion : 2026-10-01-preview
HTTP Method : POST
Parameters :
resource
Location : path
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}
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
Flat Path : projects/{project}/global/images/{resource}/setLabels
Description : Sets the labels on an image. To learn more about labels, read theLabeling Resources documentation.
Parameter Order :
Path : projects/{project}/global/images/{resource}/setLabels
▼ ▲ compute.images.testIamPermissions
Description : Returns permissions that a caller has on the specified resource.
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.
Location : path
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])?))
Location : path
Description : Project ID for this request.
Type : string
Flat Path : projects/{project}/global/images/{resource}/testIamPermissions
Scopes :
HTTP Method : POST
Apiversion : 2026-10-01-preview
Path : projects/{project}/global/images/{resource}/testIamPermissions
Parameter Order :
▼ ▲ compute.images.list
Path : projects/{project}/global/images
HTTP Method : GET
Apiversion : 2026-10-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.
Flat Path : projects/{project}/global/images
Parameter Order : project
Scopes :
Parameters :
maxResults
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
Default : 500
Format : uint32
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
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.
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.
▼ ▲ compute.images.insert
Description : Creates an image in the specified project using the data 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
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
Description : Force image creation if true.
Type : boolean
Location : query
Scopes :
Flat Path : projects/{project}/global/images
Parameter Order : project
Path : projects/{project}/global/images
HTTP Method : POST
Apiversion : 2026-10-01-preview
▼ ▲ compute.images.delete
Flat Path : projects/{project}/global/images/{image}
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
Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-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
image
Location : path
Type : string
Description : Name of the image resource to delete.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Description : Deletes the specified image.
Scopes :
Parameter Order :
HTTP Method : DELETE
Apiversion : 2026-10-01-preview
Path : projects/{project}/global/images/{image}
▼ ▲ compute.images.getIamPolicy
Parameter Order :
Flat Path : projects/{project}/global/images/{resource}/getIamPolicy
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
optionsRequestedPolicyVersion
Description : Requested IAM Policy version.
Location : query
Type : integer
Format : int32
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
Apiversion : 2026-10-01-preview
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}/global/images/{resource}/getIamPolicy
Scopes :
▼ ▲ compute.images.get
Description : Returns the specified image.
Apiversion : 2026-10-01-preview
Path : projects/{project}/global/images/{image}
HTTP Method : GET
Parameter Order :
Scopes :
Parameters :
image
Description : Name of the image 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
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
Flat Path : projects/{project}/global/images/{image}
▼ ▲ compute.images.deprecate
Flat Path : projects/{project}/global/images/{image}/deprecate
HTTP Method : POST
Apiversion : 2026-10-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).
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
image
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Type : string
Description : Image name.
Location : path
Scopes :
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
▼ ▲ compute.firewallPolicies.getIamPolicy
Flat Path : locations/global/firewallPolicies/{resource}/getIamPolicy
Description : Gets the access control policy for a resource. May be empty if no such policy or resource exists.
Apiversion : 2026-10-01-preview
Scopes :
HTTP Method : GET
Path : locations/global/firewallPolicies/{resource}/getIamPolicy
Parameters :
resource
Location : path
Description : Name or id of the resource for this request.
Required : Yes
Pattern : (firewallPolicies/)?[0-9]{0,20}
Type : string
optionsRequestedPolicyVersion
Type : integer
Format : int32
Description : Requested IAM Policy version.
Location : query
Parameter Order : resource
▼ ▲ compute.firewallPolicies.patch
Scopes :
Parameters :
firewallPolicy
Required : Yes
Description : Name of the firewall policy to update.
Pattern : (firewallPolicies/)?[0-9]{0,20}
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
Flat Path : locations/global/firewallPolicies/{firewallPolicy}
Description : Patches the specified policy with the data included in the request.
Apiversion : 2026-10-01-preview
Parameter Order : firewallPolicy
HTTP Method : PATCH
Path : locations/global/firewallPolicies/{firewallPolicy}
▼ ▲ compute.firewallPolicies.listAssociations
Scopes :
Description : Lists associations of a specified target, i.e., organization or folder.
Path : locations/global/firewallPolicies/listAssociations
Flat Path : locations/global/firewallPolicies/listAssociations
Parameters :
targetResource
Description : The target resource to list associations. It is an organization, or a folder.
Location : query
Type : string
includeInheritedPolicies
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.
Type : boolean
HTTP Method : GET
Apiversion : 2026-10-01-preview
▼ ▲ compute.firewallPolicies.getAssociation
Parameters :
name
Description : The name of the association to get from the firewall policy.
Type : string
Location : query
firewallPolicy
Pattern : (firewallPolicies/)?[0-9]{0,20}
Location : path
Type : string
Description : Name of the firewall policy to which the queried rule belongs.
Required : Yes
Path : locations/global/firewallPolicies/{firewallPolicy}/getAssociation
Flat Path : locations/global/firewallPolicies/{firewallPolicy}/getAssociation
Scopes :
Parameter Order : firewallPolicy
HTTP Method : GET
Description : Gets an association with the specified name.
Apiversion : 2026-10-01-preview
▼ ▲ compute.firewallPolicies.addRule
Path : locations/global/firewallPolicies/{firewallPolicy}/addRule
Apiversion : 2026-10-01-preview
Scopes :
HTTP Method : POST
Parameter Order : firewallPolicy
Parameters :
firewallPolicy
Location : path
Type : string
Required : Yes
Description : Name of the firewall policy to update.
Pattern : (firewallPolicies/)?[0-9]{0,20}
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 : locations/global/firewallPolicies/{firewallPolicy}/addRule
Description : Inserts a rule into a firewall policy.
▼ ▲ compute.firewallPolicies.get
HTTP Method : GET
Apiversion : 2026-10-01-preview
Parameters :
firewallPolicy
Location : path
Pattern : (firewallPolicies/)?[0-9]{0,20}
Type : string
Description : Name of the firewall policy to get.
Required : Yes
Flat Path : locations/global/firewallPolicies/{firewallPolicy}
Path : locations/global/firewallPolicies/{firewallPolicy}
Parameter Order : firewallPolicy
Scopes :
Description : Returns the specified firewall policy.
▼ ▲ compute.firewallPolicies.cloneRules
Flat Path : locations/global/firewallPolicies/{firewallPolicy}/cloneRules
Description : Copies rules to the specified firewall policy.
Scopes :
Parameters :
firewallPolicy
Type : string
Location : path
Description : Name of the firewall policy to update.
Required : Yes
Pattern : (firewallPolicies/)?[0-9]{0,20}
sourceFirewallPolicy
Description : The firewall policy from which to copy rules.
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
Parameter Order : firewallPolicy
Apiversion : 2026-10-01-preview
HTTP Method : POST
Path : locations/global/firewallPolicies/{firewallPolicy}/cloneRules
▼ ▲ compute.firewallPolicies.patchRule
Parameter Order : firewallPolicy
Parameters :
firewallPolicy
Location : path
Type : string
Pattern : (firewallPolicies/)?[0-9]{0,20}
Required : Yes
Description : Name of the firewall policy to update.
priority
Description : The priority of the rule to patch.
Type : integer
Format : int32
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
Apiversion : 2026-10-01-preview
HTTP Method : POST
Path : locations/global/firewallPolicies/{firewallPolicy}/patchRule
Flat Path : locations/global/firewallPolicies/{firewallPolicy}/patchRule
Description : Patches a rule of the specified priority.
Scopes :
▼ ▲ compute.firewallPolicies.testIamPermissions
Path : locations/global/firewallPolicies/{resource}/testIamPermissions
Parameter Order : resource
Parameters :
resource
Location : path
Type : string
Required : Yes
Pattern : (firewallPolicies/)?[0-9]{0,20}
Description : Name or id of the resource for this request.
Apiversion : 2026-10-01-preview
Description : Returns permissions that a caller has on the specified resource.
HTTP Method : POST
Scopes :
Flat Path : locations/global/firewallPolicies/{resource}/testIamPermissions
▼ ▲ compute.firewallPolicies.insert
Parameters :
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.
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 : locations/global/firewallPolicies
Description : Creates a new policy in the specified project using the data included in the request.
Path : locations/global/firewallPolicies
HTTP Method : POST
Scopes :
Apiversion : 2026-10-01-preview
▼ ▲ compute.firewallPolicies.removeAssociation
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).
firewallPolicy
Type : string
Pattern : (firewallPolicies/)?[0-9]{0,20}
Location : path
Description : Name of the firewall policy to update.
Required : Yes
name
Description : Name for the attachment that will be removed.
Location : query
Type : string
Parameter Order : firewallPolicy
Scopes :
Description : Removes an association for the specified firewall policy.
Flat Path : locations/global/firewallPolicies/{firewallPolicy}/removeAssociation
HTTP Method : POST
Path : locations/global/firewallPolicies/{firewallPolicy}/removeAssociation
Apiversion : 2026-10-01-preview
▼ ▲ compute.firewallPolicies.addAssociation
Description : Inserts an association for the specified firewall policy.
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).
firewallPolicy
Pattern : (firewallPolicies/)?[0-9]{0,20}
Required : Yes
Description : Name of the firewall policy to update.
Type : string
Location : path
replaceExistingAssociation
Location : query
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.
Parameter Order : firewallPolicy
Path : locations/global/firewallPolicies/{firewallPolicy}/addAssociation
HTTP Method : POST
Apiversion : 2026-10-01-preview
Flat Path : locations/global/firewallPolicies/{firewallPolicy}/addAssociation
▼ ▲ compute.firewallPolicies.setIamPolicy
HTTP Method : POST
Apiversion : 2026-10-01-preview
Description : Sets the access control policy on the specified resource. Replaces any existing policy.
Parameter Order : resource
Flat Path : locations/global/firewallPolicies/{resource}/setIamPolicy
Parameters :
resource
Pattern : (firewallPolicies/)?[0-9]{0,20}
Required : Yes
Description : Name or id of the resource for this request.
Type : string
Location : path
Path : locations/global/firewallPolicies/{resource}/setIamPolicy
Scopes :
▼ ▲ compute.firewallPolicies.getRule
Description : Gets a rule of the specified priority.
Parameters :
firewallPolicy
Required : Yes
Description : Name of the firewall policy to which the queried rule belongs.
Pattern : (firewallPolicies/)?[0-9]{0,20}
Location : path
Type : string
priority
Format : int32
Description : The priority of the rule to get from the firewall policy.
Location : query
Type : integer
Scopes :
Path : locations/global/firewallPolicies/{firewallPolicy}/getRule
Parameter Order : firewallPolicy
Flat Path : locations/global/firewallPolicies/{firewallPolicy}/getRule
Apiversion : 2026-10-01-preview
HTTP Method : GET
▼ ▲ compute.firewallPolicies.delete
HTTP Method : DELETE
Scopes :
Path : locations/global/firewallPolicies/{firewallPolicy}
Flat Path : locations/global/firewallPolicies/{firewallPolicy}
Apiversion : 2026-10-01-preview
Description : Deletes the specified policy.
Parameter Order : firewallPolicy
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
firewallPolicy
Location : path
Description : Name of the firewall policy to delete.
Required : Yes
Type : string
Pattern : (firewallPolicies/)?[0-9]{0,20}
▼ ▲ compute.firewallPolicies.move
Scopes :
Apiversion : 2026-10-01-preview
HTTP Method : POST
Parameter Order : firewallPolicy
Path : locations/global/firewallPolicies/{firewallPolicy}/move
Description : Moves the specified firewall policy.
Flat Path : locations/global/firewallPolicies/{firewallPolicy}/move
Parameters :
parentId
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.
Location : query
Type : string
firewallPolicy
Pattern : (firewallPolicies/)?[0-9]{0,20}
Required : Yes
Type : string
Description : Name of the firewall policy 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).
▼ ▲ compute.firewallPolicies.removeRule
Parameters :
priority
Type : integer
Location : query
Format : int32
Description : The priority of the rule to remove from the firewall policy.
firewallPolicy
Type : string
Required : Yes
Description : Name of the firewall policy to update.
Location : path
Pattern : (firewallPolicies/)?[0-9]{0,20}
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 : Deletes a rule of the specified priority.
Parameter Order : firewallPolicy
Flat Path : locations/global/firewallPolicies/{firewallPolicy}/removeRule
Scopes :
HTTP Method : POST
Apiversion : 2026-10-01-preview
Path : locations/global/firewallPolicies/{firewallPolicy}/removeRule
▼ ▲ compute.firewallPolicies.list
Path : locations/global/firewallPolicies
Scopes :
HTTP Method : GET
Flat Path : locations/global/firewallPolicies
Apiversion : 2026-10-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.
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
Location : query
Type : integer
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`)
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.
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.
Description : Lists all the policies that have been configured for the specified folder or organization.
▼ ▲ compute.sslCertificates.aggregatedList
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`.
Scopes :
Parameter Order : project
Apiversion : 2026-10-01-preview
HTTP Method : GET
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
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.
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 : Name of the project scoping 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
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
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
Path : projects/{project}/aggregated/sslCertificates
Flat Path : projects/{project}/aggregated/sslCertificates
▼ ▲ compute.sslCertificates.insert
Flat Path : projects/{project}/global/sslCertificates
HTTP Method : POST
Path : projects/{project}/global/sslCertificates
Apiversion : 2026-10-01-preview
Scopes :
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])?))
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 SslCertificate resource in the specified project using the data included in the request.
Parameter Order : project
▼ ▲ compute.sslCertificates.delete
Apiversion : 2026-10-01-preview
HTTP Method : DELETE
Scopes :
Description : Deletes the specified SslCertificate resource.
Flat Path : projects/{project}/global/sslCertificates/{sslCertificate}
Path : projects/{project}/global/sslCertificates/{sslCertificate}
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).
sslCertificate
Required : Yes
Description : Name of the SslCertificate resource to delete.
Type : string
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])?))
Location : path
Type : string
Parameter Order :
▼ ▲ compute.sslCertificates.get
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
sslCertificate
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 SslCertificate resource to return.
Scopes :
Flat Path : projects/{project}/global/sslCertificates/{sslCertificate}
Path : projects/{project}/global/sslCertificates/{sslCertificate}
Parameter Order :
HTTP Method : GET
Description : Returns the specified SslCertificate resource.
Apiversion : 2026-10-01-preview
▼ ▲ compute.sslCertificates.list
Apiversion : 2026-10-01-preview
HTTP Method : GET
Path : projects/{project}/global/sslCertificates
Flat Path : projects/{project}/global/sslCertificates
Parameter Order : project
Scopes :
Description : Retrieves the list of SslCertificate resources available to the specified 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])?))
Description : Project ID for this request.
Type : string
Location : path
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
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`)
Type : integer
Minimum : 0
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.
▼ ▲ compute.regionInstanceGroupManagers.recreateInstances
HTTP Method : POST
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/recreateInstances
Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/recreateInstances
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.
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
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
instanceGroupManager
Required : Yes
Description : Name of the managed instance group.
Type : string
Location : path
noGracefulShutdown
Default : false
Type : boolean
Location : query
Description : When set, graceful shutdown is skipped for instance recreation even if it's configured for the instances.
region
Description : Name of the region scoping this request.
Type : string
Required : Yes
Location : path
Scopes :
▼ ▲ compute.regionInstanceGroupManagers.delete
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
noGracefulShutdown
Type : boolean
Default : false
Location : query
Description : When set, graceful shutdown is skipped for instance deletion even if it's configured for the instances.
instanceGroupManager
Required : Yes
Type : string
Description : Name of the managed instance group to delete.
Location : path
region
Location : path
Required : Yes
Type : string
Description : Name of the region scoping 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])?))
Type : string
Description : Project ID for this request.
Required : Yes
Flat Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}
Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}
Scopes :
Apiversion : 2026-10-01-preview
HTTP Method : DELETE
Description : Deletes the specified managed instance group and all of the instances in that group.
▼ ▲ compute.regionInstanceGroupManagers.setTargetPools
Description : Modifies the target pools to which all new instances in this group are assigned. Existing instances in the group are not affected.
Parameters :
region
Location : path
Required : Yes
Description : Name of the region scoping this request.
Type : string
instanceGroupManager
Type : string
Location : path
Required : Yes
Description : Name of the managed instance group.
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
Flat Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setTargetPools
HTTP Method : POST
Scopes :
Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setTargetPools
Apiversion : 2026-10-01-preview
Parameter Order :
▼ ▲ compute.regionInstanceGroupManagers.updatePerInstanceConfigs
Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/updatePerInstanceConfigs
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).
instanceGroupManager
Description : The name of the managed instance group. It should conform to RFC1035.
Required : Yes
Type : string
Location : path
region
Location : path
Required : Yes
Description : Name of the region scoping this request, should conform to RFC1035.
Type : string
Flat Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/updatePerInstanceConfigs
Scopes :
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.
Apiversion : 2026-10-01-preview
Parameter Order :
HTTP Method : POST
▼ ▲ compute.regionInstanceGroupManagers.resumeInstances
Flat Path : projects/{project}/regions/{region}/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}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resumeInstances
HTTP Method : POST
Scopes :
Parameter Order :
Apiversion : 2026-10-01-preview
Parameters :
instanceGroupManager
Location : path
Required : Yes
Description : 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).
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])?))
region
Location : path
Type : string
Required : Yes
Description : Name of the region scoping this request.
▼ ▲ compute.regionInstanceGroupManagers.createInstances
Apiversion : 2026-10-01-preview
Scopes :
HTTP Method : POST
Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/createInstances
Parameter Order :
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.
Flat Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/createInstances
Parameters :
instanceGroupManager
Description : The name of the managed instance group. It should conform to RFC1035.
Required : Yes
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.
Location : path
Type : string
region
Required : Yes
Type : string
Description : The name of theregion where the managed instance group is located. It 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. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Type : string
▼ ▲ compute.regionInstanceGroupManagers.list
Parameter Order :
Parameters :
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])?))
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.
Type : string
Location : query
region
Type : string
Location : path
Description : Name of the region scoping this request.
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`)
Format : uint32
Minimum : 0
Type : integer
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.
Apiversion : 2026-10-01-preview
Path : projects/{project}/regions/{region}/instanceGroupManagers
Description : Retrieves the list of managed instance groups that are contained within the specified region.
Scopes :
HTTP Method : GET
Flat Path : projects/{project}/regions/{region}/instanceGroupManagers
▼ ▲ compute.regionInstanceGroupManagers.deleteInstances
Scopes :
HTTP Method : POST
Flat Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/deleteInstances
Apiversion : 2026-10-01-preview
Parameters :
instanceGroupManager
Location : path
Description : Name of the managed instance group.
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
noGracefulShutdown
Default : false
Type : boolean
Location : query
Description : When set, graceful shutdown is skipped for instance deletion even if it's configured for the instances.
region
Type : string
Location : path
Description : Name of the region scoping 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
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.
Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/deleteInstances
Parameter Order :
▼ ▲ compute.regionInstanceGroupManagers.listPerInstanceConfigs
Parameters :
region
Location : path
Description : Name of the region scoping this request, should conform to RFC1035.
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
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
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.
instanceGroupManager
Description : The name of the managed instance group. It should conform to RFC1035.
Type : string
Required : Yes
Location : path
maxResults
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`)
Default : 500
Location : query
Format : uint32
Flat Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listPerInstanceConfigs
Parameter Order :
Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listPerInstanceConfigs
Description : Lists all of the per-instance configurations defined for the managed instance group. The orderBy query parameter is not supported.
Scopes :
HTTP Method : POST
Apiversion : 2026-10-01-preview
▼ ▲ compute.regionInstanceGroupManagers.listErrors
Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listErrors
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])?))
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
instanceGroupManager
Required : Yes
Type : string
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}.
maxResults
Description : The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
Default : 500
Location : query
Minimum : 0
Type : integer
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
region
Location : path
Type : string
Description : Name of the region scoping this request. This should conform to RFC1035.
Required : Yes
Scopes :
Apiversion : 2026-10-01-preview
Description : Lists all errors thrown by actions on instances for a given regional managed instance group. The filter andorderBy query parameters are not supported.
Flat Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listErrors
HTTP Method : GET
Parameter Order :
▼ ▲ 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.
Parameter Order :
Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/startInstances
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
Required : Yes
Location : path
Type : string
Description : Name of the region scoping this request.
instanceGroupManager
Type : string
Description : Name of the managed instance group.
Location : path
Required : Yes
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
Apiversion : 2026-10-01-preview
HTTP Method : POST
Flat Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/startInstances
Scopes :
▼ ▲ compute.regionInstanceGroupManagers.stopInstances
Parameter Order :
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.
Parameters :
instanceGroupManager
Description : The name of the managed instance group.
Type : string
Required : Yes
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.
noGracefulShutdown
Type : boolean
Description : When set, graceful shutdown is skipped for instance stopping even if it's configured for the instances.
Location : query
Default : false
region
Location : path
Required : Yes
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).
Scopes :
Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/stopInstances
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/stopInstances
HTTP Method : POST
▼ ▲ compute.regionInstanceGroupManagers.insert
Flat Path : projects/{project}/regions/{region}/instanceGroupManagers
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
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
Description : Name of the region scoping this request.
Location : path
Parameter Order :
Scopes :
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.
HTTP Method : POST
Apiversion : 2026-10-01-preview
Path : projects/{project}/regions/{region}/instanceGroupManagers
▼ ▲ compute.regionInstanceGroupManagers.resize
Scopes :
Parameters :
size
Required : Yes
Description : Number of instances that should exist in this instance group manager.
Minimum : 0
Format : int32
Location : query
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])?))
Location : path
Type : string
Description : Project ID for this request.
Required : Yes
instanceGroupManager
Required : Yes
Type : string
Location : path
Description : Name of the managed instance group.
region
Required : Yes
Location : path
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
Flat Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resize
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.
Apiversion : 2026-10-01-preview
HTTP Method : POST
Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resize
▼ ▲ compute.regionInstanceGroupManagers.listManagedInstances
Apiversion : 2026-10-01-preview
Parameter Order :
HTTP Method : POST
Flat Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listManagedInstances
Scopes :
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`.
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
maxResults
Location : query
Type : integer
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
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
region
Location : path
Required : Yes
Type : string
Description : Name of the region scoping this request.
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
instanceGroupManager
Location : path
Description : The name of the managed instance group.
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
Description : Project ID for this request.
Location : path
Type : string
Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listManagedInstances
▼ ▲ 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.
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])?))
region
Description : Name of the region scoping this request, should conform to RFC1035.
Type : string
Location : path
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
instanceGroupManager
Description : The name of the managed instance group. It should conform to RFC1035.
Type : string
Location : path
Required : Yes
Apiversion : 2026-10-01-preview
Scopes :
HTTP Method : POST
Flat Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/patchPerInstanceConfigs
Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/patchPerInstanceConfigs
▼ ▲ compute.regionInstanceGroupManagers.suspendInstances
Parameter Order :
Parameters :
region
Type : string
Required : Yes
Description : Name of the region scoping 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])?))
Location : path
Description : Project ID for this request.
instanceGroupManager
Type : string
Description : Name of the managed instance group.
Location : path
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
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.
Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/suspendInstances
Flat Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/suspendInstances
Scopes :
HTTP Method : POST
Apiversion : 2026-10-01-preview
▼ ▲ compute.regionInstanceGroupManagers.abandonInstances
Parameters :
region
Type : string
Description : Name of the region scoping this request.
Location : path
Required : Yes
instanceGroupManager
Description : Name of the managed instance group.
Type : string
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.
Type : string
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
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.
Parameter Order :
Flat Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/abandonInstances
Scopes :
Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/abandonInstances
HTTP Method : POST
Apiversion : 2026-10-01-preview
▼ ▲ compute.regionInstanceGroupManagers.setInstanceTemplate
HTTP Method : POST
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setInstanceTemplate
Description : Sets the instance template to use when creating new instances or recreating instances in this group. Existing instances are not affected.
Scopes :
Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setInstanceTemplate
Parameter Order :
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])?))
instanceGroupManager
Required : Yes
Type : string
Description : The name of 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).
region
Type : string
Required : Yes
Description : Name of the region scoping this request.
Location : path
▼ ▲ compute.regionInstanceGroupManagers.patch
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}
HTTP Method : 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 :
Parameter Order :
Parameters :
instanceGroupManager
Description : The name of the instance group manager.
Required : Yes
Type : string
Location : path
region
Location : path
Description : Name of the region scoping 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).
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])?))
Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}
▼ ▲ compute.regionInstanceGroupManagers.deletePerInstanceConfigs
Parameters :
instanceGroupManager
Type : string
Location : path
Required : Yes
Description : The name of the managed instance group. It should conform to RFC1035.
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
Type : string
Description : Name of the region scoping this request, should conform to RFC1035.
Required : Yes
Location : path
Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/deletePerInstanceConfigs
Flat Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/deletePerInstanceConfigs
Scopes :
Parameter Order :
Apiversion : 2026-10-01-preview
Description : Deletes selected per-instance configurations for the managed instance group.
HTTP Method : POST
▼ ▲ compute.regionInstanceGroupManagers.applyUpdatesToInstances
Apiversion : 2026-10-01-preview
HTTP Method : POST
Description : Apply updates to selected instances the managed instance group.
Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/applyUpdatesToInstances
Parameter Order :
Flat Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/applyUpdatesToInstances
Scopes :
Parameters :
instanceGroupManager
Location : path
Description : The name of the managed instance group, should conform to RFC1035.
Required : Yes
Type : string
region
Type : string
Required : Yes
Location : path
Description : Name of the region scoping this request, should conform to RFC1035.
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])?))
▼ ▲ compute.regionInstanceGroupManagers.get
Parameter Order :
HTTP Method : GET
Apiversion : 2026-10-01-preview
Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}
Parameters :
instanceGroupManager
Required : Yes
Location : path
Type : string
Description : Name of the managed instance group to return.
region
Type : string
Description : Name of the region scoping this request.
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 :
Description : Returns all of the details about the specified managed instance group.
Flat Path : projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}
▼ ▲ compute.globalPublicDelegatedPrefixes.insert
Parameter Order : project
Description : Creates a global PublicDelegatedPrefix in the specified project using the parameters that are included in the 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
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])?))
Scopes :
Flat Path : projects/{project}/global/publicDelegatedPrefixes
Apiversion : 2026-10-01-preview
Path : projects/{project}/global/publicDelegatedPrefixes
HTTP Method : POST
▼ ▲ compute.globalPublicDelegatedPrefixes.delete
HTTP Method : DELETE
Apiversion : 2026-10-01-preview
Parameter Order :
Scopes :
Description : Deletes the specified global PublicDelegatedPrefix.
Flat Path : projects/{project}/global/publicDelegatedPrefixes/{publicDelegatedPrefix}
Path : projects/{project}/global/publicDelegatedPrefixes/{publicDelegatedPrefix}
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
Description : An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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
Description : Name of the PublicDelegatedPrefix resource to delete.
Type : string
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
▼ ▲ compute.globalPublicDelegatedPrefixes.patch
Scopes :
Parameter Order :
Path : projects/{project}/global/publicDelegatedPrefixes/{publicDelegatedPrefix}
HTTP Method : PATCH
Apiversion : 2026-10-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])?))
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
publicDelegatedPrefix
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.
Type : string
Required : Yes
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.
▼ ▲ compute.globalPublicDelegatedPrefixes.get
Scopes :
Parameters :
publicDelegatedPrefix
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 PublicDelegatedPrefix resource to return.
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])?))
Path : projects/{project}/global/publicDelegatedPrefixes/{publicDelegatedPrefix}
Parameter Order :
Description : Returns the specified global PublicDelegatedPrefix resource.
HTTP Method : GET
Flat Path : projects/{project}/global/publicDelegatedPrefixes/{publicDelegatedPrefix}
Apiversion : 2026-10-01-preview
▼ ▲ compute.globalPublicDelegatedPrefixes.list
Description : Lists the global PublicDelegatedPrefixes for a project.
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/global/publicDelegatedPrefixes
Scopes :
HTTP Method : GET
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.
Location : query
Type : string
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
Minimum : 0
Type : integer
Format : uint32
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`)
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/publicDelegatedPrefixes
▼ ▲ compute.routes.get
Flat Path : projects/{project}/global/routes/{route}
Apiversion : 2026-10-01-preview
Parameter Order :
HTTP Method : GET
Description : Returns the specified Route resource.
Path : projects/{project}/global/routes/{route}
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])?))
route
Location : path
Description : Name of the Route resource to return.
Type : string
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Scopes :
▼ ▲ compute.routes.testIamPermissions
Parameter Order :
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
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}
Description : Returns permissions that a caller has on the specified resource.
Apiversion : 2026-10-01-preview
Path : projects/{project}/global/routes/{resource}/testIamPermissions
Flat Path : projects/{project}/global/routes/{resource}/testIamPermissions
HTTP Method : POST
Scopes :
▼ ▲ compute.routes.insert
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])?))
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 Route resource in the specified project using the data included in the request.
Flat Path : projects/{project}/global/routes
Parameter Order : project
Apiversion : 2026-10-01-preview
HTTP Method : POST
Path : projects/{project}/global/routes
Scopes :
▼ ▲ compute.routes.delete
Description : Deletes the specified Route resource.
Parameters :
route
Location : path
Description : Name of the Route resource to delete.
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
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])?))
Scopes :
Path : projects/{project}/global/routes/{route}
HTTP Method : DELETE
Parameter Order :
Flat Path : projects/{project}/global/routes/{route}
Apiversion : 2026-10-01-preview
▼ ▲ compute.routes.list
Flat Path : projects/{project}/global/routes
HTTP Method : GET
Scopes :
Parameter Order : project
Apiversion : 2026-10-01-preview
Description : Retrieves the list of Route 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.
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])?))
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
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
Default : 500
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.
Location : query
Type : string
Path : projects/{project}/global/routes
▼ ▲ compute.hosts.getVersion
Description : Allows customers to get SBOM versions of a host.
Parameter Order :
Path : projects/{project}/zones/{zone}/{association}/hosts/{host}/getVersion
Parameters :
host
Type : string
Required : Yes
Location : path
Description : The name of the host, formatted as RFC1035 or a resource ID number.
zone
Required : Yes
Type : string
Description : Name of the zone for this request. Zone name should conform to RFC1035.
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.
project
Location : path
Type : string
Description : Project ID for this request.
Required : Yes
association
Type : string
Location : path
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.
HTTP Method : POST
Apiversion : 2026-10-01-preview
Scopes :
Flat Path : projects/{project}/zones/{zone}/{association}/hosts/{host}/getVersion
▼ ▲ compute.hosts.list
Parameters :
zone
Description : The name of the zone for this request, formatted as RFC1035.
Type : string
Location : path
Required : Yes
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
Default : 500
Type : integer
Format : uint32
project
Location : path
Required : Yes
Description : The project ID for this request.
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.
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.
Scopes :
Path : projects/{project}/zones/{zone}/{association}/hosts
Description : Retrieves a list of hosts.
Parameter Order :
Flat Path : projects/{project}/zones/{zone}/{association}/hosts
Apiversion : 2026-10-01-preview
HTTP Method : GET
▼ ▲ compute.hosts.get
HTTP Method : GET
Apiversion : 2026-10-01-preview
Path : projects/{project}/zones/{zone}/{association}/hosts/{host}
Parameter Order :
Flat Path : projects/{project}/zones/{zone}/{association}/hosts/{host}
Description : Retrieves information about the specified host.
Parameters :
project
Description : The project ID for this request.
Location : path
Required : Yes
Type : string
association
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
Location : path
Required : Yes
host
Description : The name of the host, formatted as RFC1035 or a resource ID number.
Required : Yes
Location : path
Type : string
zone
Location : path
Description : The name of the zone for this request, formatted as RFC1035.
Required : Yes
Type : string
Scopes :
▼ ▲ compute.globalOrganizationOperations.list
Scopes :
Apiversion : 2026-10-01-preview
HTTP Method : GET
Flat Path : locations/global/operations
Parameters :
maxResults
Format : uint32
Default : 500
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`)
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
Type : string
Description : Parent ID for this request.
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.
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 a list of Operation resources contained within the specified organization.
Path : locations/global/operations
▼ ▲ compute.globalOrganizationOperations.delete
Apiversion : 2026-10-01-preview
Flat Path : locations/global/operations/{operation}
HTTP Method : DELETE
Scopes :
Description : Deletes the specified Operations resource.
Path : locations/global/operations/{operation}
Parameter Order : operation
Parameters :
parentId
Description : Parent ID for this request.
Location : query
Type : string
operation
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Description : Name of the Operations resource to delete, or its unique numeric identifier.
Required : Yes
Type : string
▼ ▲ compute.globalOrganizationOperations.get
Path : locations/global/operations/{operation}
Flat Path : locations/global/operations/{operation}
Scopes :
Parameters :
parentId
Type : string
Description : Parent ID for this request. Not used. Parent is derived from resource_id.
Location : query
operation
Type : string
Required : Yes
Description : Name of the Operations resource to return. Parent is derived from this field.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Parameter Order : operation
Apiversion : 2026-10-01-preview
HTTP Method : GET
Description : Retrieves the specified Operations resource. Gets a list of operations by making a `list()` request.
▼ ▲ compute.httpHealthChecks.update
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
httpHealthCheck
Required : Yes
Location : path
Type : string
Description : Name of the HttpHealthCheck resource to update.
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
Flat Path : projects/{project}/global/httpHealthChecks/{httpHealthCheck}
Description : Updates a HttpHealthCheck resource in the specified project using the data included in the request.
Apiversion : 2026-10-01-preview
Parameter Order :
Scopes :
Path : projects/{project}/global/httpHealthChecks/{httpHealthCheck}
HTTP Method : PUT
▼ ▲ compute.httpHealthChecks.testIamPermissions
Parameter Order :
Path : projects/{project}/global/httpHealthChecks/{resource}/testIamPermissions
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/global/httpHealthChecks/{resource}/testIamPermissions
Description : Returns permissions that a caller has on the specified resource.
HTTP Method : POST
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.
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
Scopes :
▼ ▲ compute.httpHealthChecks.get
Apiversion : 2026-10-01-preview
Description : Returns the specified HttpHealthCheck resource.
Scopes :
HTTP Method : GET
Flat Path : projects/{project}/global/httpHealthChecks/{httpHealthCheck}
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
httpHealthCheck
Required : Yes
Description : Name of the HttpHealthCheck resource to return.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Parameter Order :
Path : projects/{project}/global/httpHealthChecks/{httpHealthCheck}
▼ ▲ compute.httpHealthChecks.list
Description : Retrieves the list of HttpHealthCheck resources available to the specified project.
HTTP Method : GET
Apiversion : 2026-10-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
maxResults
Minimum : 0
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`)
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
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
Flat Path : projects/{project}/global/httpHealthChecks
Path : projects/{project}/global/httpHealthChecks
Scopes :
Parameter Order : project
▼ ▲ compute.httpHealthChecks.patch
Apiversion : 2026-10-01-preview
Scopes :
HTTP Method : PATCH
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.
Path : projects/{project}/global/httpHealthChecks/{httpHealthCheck}
Flat Path : projects/{project}/global/httpHealthChecks/{httpHealthCheck}
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).
httpHealthCheck
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 patch.
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
Description : Project ID for this request.
Required : Yes
Location : path
▼ ▲ compute.httpHealthChecks.insert
Apiversion : 2026-10-01-preview
Description : Creates a HttpHealthCheck resource in the specified project using the data included in the request.
HTTP Method : POST
Flat Path : projects/{project}/global/httpHealthChecks
Path : projects/{project}/global/httpHealthChecks
Parameter Order : project
Scopes :
Parameters :
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
Description : An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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.httpHealthChecks.delete
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).
httpHealthCheck
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the HttpHealthCheck resource to delete.
Location : path
Type : string
Required : Yes
Parameter Order :
Apiversion : 2026-10-01-preview
Description : Deletes the specified HttpHealthCheck resource.
HTTP Method : DELETE
Path : projects/{project}/global/httpHealthChecks/{httpHealthCheck}
Scopes :
Flat Path : projects/{project}/global/httpHealthChecks/{httpHealthCheck}
▼ ▲ compute.interconnectRemoteLocations.list
Scopes :
Flat Path : projects/{project}/global/interconnectRemoteLocations
HTTP Method : GET
Apiversion : 2026-10-01-preview
Description : Retrieves the list of interconnect remote locations available to the specified project.
Parameter Order : project
Parameters :
maxResults
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`)
Default : 500
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
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
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.
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.
Path : projects/{project}/global/interconnectRemoteLocations
▼ ▲ compute.interconnectRemoteLocations.get
Scopes :
Parameter Order :
Path : projects/{project}/global/interconnectRemoteLocations/{interconnectRemoteLocation}
HTTP Method : GET
Description : Returns the details for the specified interconnect remote location. Gets a list of available interconnect remote locations by making alist() request.
Apiversion : 2026-10-01-preview
Parameters :
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])?))
interconnectRemoteLocation
Location : path
Description : Name of the interconnect remote location to return.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Flat Path : projects/{project}/global/interconnectRemoteLocations/{interconnectRemoteLocation}
▼ ▲ compute.reservationSlots.getVersion
Scopes :
Path : projects/{project}/zones/{zone}/{+parentName}/reservationSlots/{reservationSlot}/getVersion
Parameters :
reservationSlot
Required : Yes
Location : path
Description : The name of the reservation slot. Name should conform to RFC1035 or be a resource ID.
Type : string
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
Description : An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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
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}
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
Location : path
Type : string
Parameter Order :
Description : Allows customers to get SBOM versions of a reservation slot.
HTTP Method : POST
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks/{reservationSubBlocksId}/reservationSlots/{reservationSlot}/getVersion
▼ ▲ compute.reservationSlots.list
Apiversion : 2026-10-01-preview
HTTP Method : GET
Flat Path : projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks/{reservationSubBlocksId}/reservationSlots
Description : Retrieves a list of reservation slots under a single reservation.
Scopes :
Path : projects/{project}/zones/{zone}/{+parentName}/reservationSlots
Parameter Order :
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`)
Minimum : 0
Default : 500
Location : query
Format : uint32
Type : integer
project
Type : string
Location : path
Description : The project ID for this request.
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
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}
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
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.
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
zone
Required : Yes
Type : string
Location : path
Description : The name of the zone for this request, formatted as RFC1035.
▼ ▲ compute.reservationSlots.update
Parameters :
zone
Description : The name of the zone for this request, formatted as RFC1035.
Type : string
Required : Yes
Location : path
project
Required : Yes
Description : The project ID for this request.
Location : path
Type : string
updateMask
Format : google-fieldmask
Location : query
Type : string
Description : The fields to be updated as part of this request.
reservationSlot
Description : The name of the slot resource.
Required : Yes
Type : string
Location : path
parentName
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
Type : string
Description : The name of the sub-block resource.
Location : path
Description : Update a reservation slot in the specified sub-block.
Scopes :
Parameter Order :
Path : projects/{project}/zones/{zone}/{+parentName}/reservationSlots/{reservationSlot}
Flat Path : projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks/{reservationSubBlocksId}/reservationSlots/{reservationSlot}
HTTP Method : POST
Apiversion : 2026-10-01-preview
▼ ▲ compute.reservationSlots.get
Scopes :
Parameter Order :
Description : Retrieves information about the specified reservation slot.
Parameters :
project
Location : path
Required : Yes
Type : string
Description : The project ID for this request.
zone
Type : string
Location : path
Description : The name of the zone for this request, formatted as RFC1035.
Required : Yes
reservationSlot
Type : string
Required : Yes
Description : The name of the reservation slot, formatted as RFC1035 or a resource ID number.
Location : path
parentName
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
Type : string
Description : The name of the parent reservation and parent block, formatted as reservations/{reservation_name}/reservationBlocks/{reservation_block_name}/reservationSubBlocks/{reservation_sub_block_name}
Location : path
Apiversion : 2026-10-01-preview
Path : projects/{project}/zones/{zone}/{+parentName}/reservationSlots/{reservationSlot}
HTTP Method : GET
Flat Path : projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks/{reservationSubBlocksId}/reservationSlots/{reservationSlot}
▼ ▲ compute.reservationSlots.getHealth
Flat Path : projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks/{reservationSubBlocksId}/reservationSlots/{reservationSlot}/getHealth
Scopes :
Parameters :
zone
Location : path
Type : string
Description : Name of the zone for this request. Zone name should conform to RFC1035.
Required : Yes
reservationSlot
Required : Yes
Location : path
Description : The name of the reservation slot. Name should conform to RFC1035 or be a resource ID.
Type : string
project
Required : Yes
Type : string
Location : path
Description : Project ID for this request.
requestId
Type : string
Location : query
Description : An optional request ID to identify requests.
parentName
Location : path
Type : string
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}
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
Apiversion : 2026-10-01-preview
Path : projects/{project}/zones/{zone}/{+parentName}/reservationSlots/{reservationSlot}/getHealth
HTTP Method : POST
Description : Get health info on a reservation slot.
Parameter Order :
▼ ▲ compute.securityPolicies.aggregatedList
Scopes :
HTTP Method : GET
Apiversion : 2026-10-01-preview
Path : projects/{project}/aggregated/securityPolicies
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
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
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
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
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
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 : Name of the project scoping this request.
Type : string
Required : Yes
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`.
Flat Path : projects/{project}/aggregated/securityPolicies
Parameter Order : project
▼ ▲ compute.securityPolicies.removeRule
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
securityPolicy
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Type : string
Description : Name of the security policy to update.
Location : path
Required : Yes
priority
Format : int32
Type : integer
Location : query
Description : The priority of the rule to remove from the security policy.
Flat Path : projects/{project}/global/securityPolicies/{securityPolicy}/removeRule
Parameter Order :
Description : Deletes a rule at the specified priority.
Apiversion : 2026-10-01-preview
HTTP Method : POST
Scopes :
Path : projects/{project}/global/securityPolicies/{securityPolicy}/removeRule
▼ ▲ compute.securityPolicies.list
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
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
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])?))
maxResults
Minimum : 0
Format : uint32
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`)
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 : List all the policies that have been configured for the specified project.
Scopes :
Parameter Order : project
Apiversion : 2026-10-01-preview
Path : projects/{project}/global/securityPolicies
Flat Path : projects/{project}/global/securityPolicies
HTTP Method : GET
▼ ▲ compute.securityPolicies.getRule
Flat Path : projects/{project}/global/securityPolicies/{securityPolicy}/getRule
Parameters :
priority
Format : int32
Type : integer
Description : The priority of the rule to get from the security policy.
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
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
Parameter Order :
Path : projects/{project}/global/securityPolicies/{securityPolicy}/getRule
Apiversion : 2026-10-01-preview
Scopes :
HTTP Method : GET
Description : Gets a rule at the specified priority.
▼ ▲ compute.securityPolicies.addRule
Description : Inserts a rule into a security policy.
Parameters :
validateOnly
Type : boolean
Location : query
Description : If true, the request will not be committed.
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
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 update.
Location : path
Scopes :
Flat Path : projects/{project}/global/securityPolicies/{securityPolicy}/addRule
Path : projects/{project}/global/securityPolicies/{securityPolicy}/addRule
Apiversion : 2026-10-01-preview
HTTP Method : POST
Parameter Order :
▼ ▲ compute.securityPolicies.insert
Description : Creates a new policy in the specified project using the data included in the request.
Flat Path : projects/{project}/global/securityPolicies
Parameter Order : project
Parameters :
validateOnly
Description : If true, the request will not be committed.
Type : boolean
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
Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-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
Path : projects/{project}/global/securityPolicies
HTTP Method : POST
Apiversion : 2026-10-01-preview
Scopes :
▼ ▲ compute.securityPolicies.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).
Location : query
Type : string
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
securityPolicy
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 security policy to delete.
Path : projects/{project}/global/securityPolicies/{securityPolicy}
Description : Deletes the specified policy.
Parameter Order :
Scopes :
HTTP Method : DELETE
Flat Path : projects/{project}/global/securityPolicies/{securityPolicy}
Apiversion : 2026-10-01-preview
▼ ▲ compute.securityPolicies.listPreconfiguredExpressionSets
Scopes :
Parameters :
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])?))
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
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
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`)
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 : Gets the current list of preconfigured Web Application Firewall (WAF) expressions.
HTTP Method : GET
Path : projects/{project}/global/securityPolicies/listPreconfiguredExpressionSets
Parameter Order : project
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/global/securityPolicies/listPreconfiguredExpressionSets
▼ ▲ compute.securityPolicies.setLabels
Description : Sets the labels on a security policy. To learn more about labels, read the Labeling Resources documentation.
Parameters :
project
Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Location : path
Description : Project ID for this request.
Required : Yes
Type : string
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
HTTP Method : POST
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/global/securityPolicies/{resource}/setLabels
Scopes :
Parameter Order :
Path : projects/{project}/global/securityPolicies/{resource}/setLabels
▼ ▲ compute.securityPolicies.get
Path : projects/{project}/global/securityPolicies/{securityPolicy}
Description : List all of the ordered rules present in a single specified policy.
Scopes :
HTTP Method : GET
Apiversion : 2026-10-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
securityPolicy
Required : Yes
Type : string
Description : Name of the security policy to get.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Flat Path : projects/{project}/global/securityPolicies/{securityPolicy}
▼ ▲ compute.securityPolicies.patchRule
Path : projects/{project}/global/securityPolicies/{securityPolicy}/patchRule
Flat Path : projects/{project}/global/securityPolicies/{securityPolicy}/patchRule
Parameter Order :
HTTP Method : POST
Apiversion : 2026-10-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])?))
Location : path
Description : Project ID for this request.
validateOnly
Description : If true, the request will not be committed.
Location : query
Type : boolean
priority
Location : query
Type : integer
Format : int32
Description : The priority of the rule to patch.
updateMask
Format : google-fieldmask
Location : query
Description : Indicates fields to be cleared as part of this request.
Type : string
securityPolicy
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 security policy to update.
Required : Yes
Description : Patches a rule at the specified priority. To clear fields in the rule, leave the fields empty and specify them in the updateMask.
Scopes :
▼ ▲ compute.securityPolicies.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.
Type : string
Location : path
securityPolicy
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 security policy 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
updateMask
Description : Indicates fields to be cleared as part of this request.
Format : google-fieldmask
Location : query
Type : string
Path : projects/{project}/global/securityPolicies/{securityPolicy}
Flat Path : projects/{project}/global/securityPolicies/{securityPolicy}
Parameter Order :
Scopes :
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.
Apiversion : 2026-10-01-preview
HTTP Method : PATCH
▼ ▲ compute.crossSiteNetworks.patch
Parameter Order :
Path : projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}
Flat Path : projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}
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
updateMask
Location : query
Type : string
Description : update_mask indicates fields to be updated as part of this request.
Format : google-fieldmask
crossSiteNetwork
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Description : Name of the cross-site network to update.
Type : string
Required : Yes
validateOnly
Type : boolean
Location : query
Description : [Input Only] Validate the new configuration, but don't update it.
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
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-10-01-preview
HTTP Method : PATCH
Scopes :
▼ ▲ compute.crossSiteNetworks.insert
Flat Path : projects/{project}/global/crossSiteNetworks
Description : Creates a cross-site network in the specified project in the given scope using the parameters that are included in the request.
Parameters :
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
validateOnly
Description : [Input Only] Validate the new configuration, but don't create it.
Location : query
Type : boolean
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
Path : projects/{project}/global/crossSiteNetworks
Scopes :
Parameter Order : project
HTTP Method : POST
Apiversion : 2026-10-01-preview
▼ ▲ compute.crossSiteNetworks.delete
Scopes :
Apiversion : 2026-10-01-preview
HTTP Method : DELETE
Description : Deletes the specified cross-site network in the given scope.
Parameter Order :
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])?))
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
crossSiteNetwork
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 cross-site network to delete.
Required : Yes
Flat Path : projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}
Path : projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}
▼ ▲ compute.crossSiteNetworks.list
Parameter Order : project
Flat Path : projects/{project}/global/crossSiteNetworks
Parameters :
maxResults
Location : query
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
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
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])?))
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
Apiversion : 2026-10-01-preview
Path : projects/{project}/global/crossSiteNetworks
Description : Lists the cross-site networks for a project in the given scope.
HTTP Method : GET
Scopes :
▼ ▲ compute.crossSiteNetworks.get
Parameters :
crossSiteNetwork
Required : Yes
Description : Name of the cross-site network to return.
Type : string
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 :
Parameter Order :
Path : projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}
Flat Path : projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}
HTTP Method : GET
Description : Returns the specified cross-site network in the given scope.
Apiversion : 2026-10-01-preview
▼ ▲ compute.regionDisks.addResourcePolicies
Flat Path : projects/{project}/regions/{region}/disks/{disk}/addResourcePolicies
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.
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
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.
disk
Required : Yes
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : The disk name 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 :
HTTP Method : POST
Scopes :
Apiversion : 2026-10-01-preview
▼ ▲ compute.regionDisks.setLabels
Path : projects/{project}/regions/{region}/disks/{resource}/setLabels
HTTP Method : POST
Apiversion : 2026-10-01-preview
Description : Sets the labels on the target regional disk.
Scopes :
Parameter Order :
Parameters :
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
region
Description : The region for this request.
Required : Yes
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
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
Description : An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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}/disks/{resource}/setLabels
▼ ▲ compute.regionDisks.get
Parameters :
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 : Name of the regional persistent disk to return.
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Location : path
Description : Name of the region for this request.
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
Scopes :
Path : projects/{project}/regions/{region}/disks/{disk}
HTTP Method : GET
Apiversion : 2026-10-01-preview
Description : Returns a specified regional persistent disk.
Flat Path : projects/{project}/regions/{region}/disks/{disk}
Parameter Order :
▼ ▲ compute.regionDisks.testIamPermissions
Description : Returns permissions that a caller has on the specified resource.
Apiversion : 2026-10-01-preview
Path : projects/{project}/regions/{region}/disks/{resource}/testIamPermissions
Flat Path : projects/{project}/regions/{region}/disks/{resource}/testIamPermissions
Parameter Order :
HTTP Method : POST
Scopes :
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.
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}
Type : string
Required : Yes
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
▼ ▲ compute.regionDisks.createSnapshot
HTTP Method : POST
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.
Flat Path : projects/{project}/regions/{region}/disks/{disk}/createSnapshot
Scopes :
Apiversion : 2026-10-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).
region
Location : path
Required : Yes
Type : string
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.
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])?))
disk
Description : Name of the regional persistent disk to snapshot.
Required : Yes
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Path : projects/{project}/regions/{region}/disks/{disk}/createSnapshot
Parameter Order :
▼ ▲ compute.regionDisks.insert
Description : Creates a persistent regional disk in the specified project using the data included in the request.
HTTP Method : POST
Apiversion : 2026-10-01-preview
Parameters :
sourceImage
Type : string
Location : query
Description : Source image to restore onto a disk. This field is optional.
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
Description : Name of the region for this request.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-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])?))
Flat Path : projects/{project}/regions/{region}/disks
Scopes :
Path : projects/{project}/regions/{region}/disks
Parameter Order :
▼ ▲ compute.regionDisks.setIamPolicy
Parameter Order :
Flat Path : projects/{project}/regions/{region}/disks/{resource}/setIamPolicy
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
Type : string
Location : path
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])?))
Location : path
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
Apiversion : 2026-10-01-preview
Description : Sets the access control policy on the specified resource. Replaces any existing policy.
Path : projects/{project}/regions/{region}/disks/{resource}/setIamPolicy
HTTP Method : POST
Scopes :
▼ ▲ compute.regionDisks.resize
HTTP Method : POST
Path : projects/{project}/regions/{region}/disks/{disk}/resize
Apiversion : 2026-10-01-preview
Parameters :
disk
Required : Yes
Type : string
Description : Name of the regional persistent disk.
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
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 : The project ID for this request.
region
Type : string
Required : Yes
Description : Name of the region for this request.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Parameter Order :
Flat Path : projects/{project}/regions/{region}/disks/{disk}/resize
Description : Resizes the specified regional persistent disk.
Scopes :
▼ ▲ compute.regionDisks.updateKmsKey
Parameter Order :
Apiversion : 2026-10-01-preview
HTTP Method : POST
Scopes :
Path : projects/{project}/regions/{region}/disks/{disk}/updateKmsKey
Flat Path : projects/{project}/regions/{region}/disks/{disk}/updateKmsKey
Description : Rotates the customer-managed encryption key to the latest version for the specified persistent disk.
Parameters :
region
Type : string
Location : path
Description : The name of the region for this request.
Required : Yes
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])?))
Description : Project ID for this request.
Required : Yes
disk
Location : path
Description : Name of the Disk resource, should conform to 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
▼ ▲ 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.
Parameters :
disk
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Type : string
Description : The disk name 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])?
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
paths
Type : string
Location : query
Repeated : Yes
updateMask
Description : update_mask indicates fields to be updated as part of this request.
Location : query
Format : google-fieldmask
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
Path : projects/{project}/regions/{region}/disks/{disk}
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/regions/{region}/disks/{disk}
HTTP Method : PATCH
Scopes :
Parameter Order :
▼ ▲ compute.regionDisks.removeResourcePolicies
Parameter Order :
Scopes :
HTTP Method : POST
Description : Removes resource policies from a regional disk.
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/regions/{region}/disks/{disk}/removeResourcePolicies
Path : projects/{project}/regions/{region}/disks/{disk}/removeResourcePolicies
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
disk
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Type : string
Description : The disk name for this request.
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.
Location : path
Type : string
region
Description : The name of the region for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Type : string
Required : Yes
▼ ▲ compute.regionDisks.startAsyncReplication
Path : projects/{project}/regions/{region}/disks/{disk}/startAsyncReplication
Apiversion : 2026-10-01-preview
HTTP Method : POST
Parameters :
disk
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : The name of the persistent disk.
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
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])?))
region
Required : Yes
Location : path
Description : The name of the region for this request.
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Flat Path : projects/{project}/regions/{region}/disks/{disk}/startAsyncReplication
Parameter Order :
Description : Starts asynchronous replication. Must be invoked on the primary disk.
Scopes :
▼ ▲ compute.regionDisks.stopAsyncReplication
Description : Stops asynchronous replication. Can be invoked either on the primary or on the secondary disk.
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
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
Description : The name of the persistent disk.
Required : Yes
Location : path
Type : string
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.
Type : string
Required : Yes
Path : projects/{project}/regions/{region}/disks/{disk}/stopAsyncReplication
Parameter Order :
Flat Path : projects/{project}/regions/{region}/disks/{disk}/stopAsyncReplication
Scopes :
Apiversion : 2026-10-01-preview
HTTP Method : POST
▼ ▲ compute.regionDisks.getIamPolicy
Parameters :
optionsRequestedPolicyVersion
Description : Requested IAM Policy version.
Location : query
Format : int32
Type : integer
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
Type : string
Required : Yes
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : The name of the region for this request.
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.
Description : Gets the access control policy for a resource. May be empty if no such policy or resource exists.
Path : projects/{project}/regions/{region}/disks/{resource}/getIamPolicy
Flat Path : projects/{project}/regions/{region}/disks/{resource}/getIamPolicy
HTTP Method : GET
Parameter Order :
Scopes :
Apiversion : 2026-10-01-preview
▼ ▲ compute.regionDisks.bulkInsert
Apiversion : 2026-10-01-preview
Parameter Order :
Path : projects/{project}/regions/{region}/disks/bulkInsert
HTTP Method : POST
Description : Bulk create a set of disks.
Scopes :
Flat Path : projects/{project}/regions/{region}/disks/bulkInsert
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.
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 name of the region for this request.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
▼ ▲ compute.regionDisks.stopGroupAsyncReplication
Scopes :
Parameter Order :
Description : Stops asynchronous replication for a consistency group of disks. Can be invoked either in the primary or secondary scope.
Apiversion : 2026-10-01-preview
HTTP Method : POST
Flat Path : projects/{project}/regions/{region}/disks/stopGroupAsyncReplication
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])?))
region
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
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.
Path : projects/{project}/regions/{region}/disks/stopGroupAsyncReplication
▼ ▲ compute.regionDisks.delete
Parameter Order :
Path : projects/{project}/regions/{region}/disks/{disk}
Parameters :
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
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
Pattern : \S{1,66}
Type : string
Required : Yes
Description : Name of the regional persistent disk to delete.
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
Scopes :
Apiversion : 2026-10-01-preview
HTTP Method : DELETE
Flat Path : projects/{project}/regions/{region}/disks/{disk}
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.
▼ ▲ compute.regionDisks.list
Apiversion : 2026-10-01-preview
HTTP Method : GET
Flat Path : projects/{project}/regions/{region}/disks
Description : Retrieves the list of persistent disks contained within the specified region.
Parameter Order :
Scopes :
Path : projects/{project}/regions/{region}/disks
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
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.
Type : string
Location : query
region
Location : path
Required : Yes
Description : Name of the region for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
maxResults
Minimum : 0
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`)
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.
▼ ▲ compute.targetHttpsProxies.setUrlMap
Scopes :
Description : Changes the URL map for TargetHttpsProxy.
Parameters :
targetHttpsProxy
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 TargetHttpsProxy resource whose URL map is to be set.
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
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}/targetHttpsProxies/{targetHttpsProxy}/setUrlMap
Parameter Order :
Path : projects/{project}/targetHttpsProxies/{targetHttpsProxy}/setUrlMap
HTTP Method : POST
Apiversion : 2026-10-01-preview
▼ ▲ compute.targetHttpsProxies.aggregatedList
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`.
Parameters :
maxResults
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`)
Minimum : 0
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
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
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
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
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.
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
Path : projects/{project}/aggregated/targetHttpsProxies
Flat Path : projects/{project}/aggregated/targetHttpsProxies
Parameter Order : project
Scopes :
Apiversion : 2026-10-01-preview
HTTP Method : GET
▼ ▲ compute.targetHttpsProxies.patch
Flat Path : projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}
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
targetHttpsProxy
Type : string
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}
Location : path
Required : Yes
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
HTTP Method : PATCH
Apiversion : 2026-10-01-preview
Path : projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}
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.
Parameter Order :
Scopes :
▼ ▲ compute.targetHttpsProxies.setQuicOverride
HTTP Method : POST
Apiversion : 2026-10-01-preview
Parameter Order :
Flat Path : projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}/setQuicOverride
Path : projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}/setQuicOverride
Description : Sets the QUIC override policy for TargetHttpsProxy.
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
Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-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
targetHttpsProxy
Description : Name of the TargetHttpsProxy resource to set the QUIC override policy for. The name should conform to RFC1035.
Location : path
Type : string
Required : Yes
Scopes :
▼ ▲ compute.targetHttpsProxies.insert
Description : Creates a TargetHttpsProxy resource in the specified project using the data included in the request.
Flat Path : projects/{project}/global/targetHttpsProxies
Parameter Order : project
HTTP Method : POST
Apiversion : 2026-10-01-preview
Parameters :
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.
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}/global/targetHttpsProxies
Scopes :
▼ ▲ compute.targetHttpsProxies.delete
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
Description : Project ID for this request.
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).
targetHttpsProxy
Type : string
Required : Yes
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}
Location : path
Description : Deletes the specified TargetHttpsProxy resource.
Scopes :
Flat Path : projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}
Parameter Order :
Path : projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}
HTTP Method : DELETE
Apiversion : 2026-10-01-preview
▼ ▲ compute.targetHttpsProxies.list
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
maxResults
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
Default : 500
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
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.
Scopes :
HTTP Method : GET
Description : Retrieves the list of TargetHttpsProxy resources available to the specified project.
Path : projects/{project}/global/targetHttpsProxies
Parameter Order : project
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/global/targetHttpsProxies
▼ ▲ compute.targetHttpsProxies.get
Parameter Order :
Flat Path : projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}
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
targetHttpsProxy
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 TargetHttpsProxy resource to return.
Description : Returns the specified TargetHttpsProxy resource.
Path : projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}
Apiversion : 2026-10-01-preview
HTTP Method : GET
▼ ▲ compute.targetHttpsProxies.setCertificateMap
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.
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
targetHttpsProxy
Location : path
Type : string
Required : Yes
Description : Name of the TargetHttpsProxy resource whose CertificateMap is to be set. The name must be 1-63 characters long, and comply with RFC1035.
Scopes :
Flat Path : projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}/setCertificateMap
Parameter Order :
Description : Changes the Certificate Map for TargetHttpsProxy.
Apiversion : 2026-10-01-preview
HTTP Method : POST
Path : projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}/setCertificateMap
▼ ▲ compute.targetHttpsProxies.setSslPolicy
Scopes :
Flat Path : projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}/setSslPolicy
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
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
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
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.
Apiversion : 2026-10-01-preview
Path : projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}/setSslPolicy
HTTP Method : POST
▼ ▲ compute.targetHttpsProxies.setSslCertificates
Parameters :
targetHttpsProxy
Description : Name of the TargetHttpsProxy resource to set an SslCertificates resource for.
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
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
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 :
Scopes :
Path : projects/{project}/targetHttpsProxies/{targetHttpsProxy}/setSslCertificates
Description : Replaces SslCertificates for TargetHttpsProxy.
Flat Path : projects/{project}/targetHttpsProxies/{targetHttpsProxy}/setSslCertificates
Apiversion : 2026-10-01-preview
HTTP Method : POST
▼ ▲ compute.nodeTypes.aggregatedList
Parameter Order : project
Flat Path : projects/{project}/aggregated/nodeTypes
Description : Retrieves an aggregated list of node types. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.
Scopes :
HTTP Method : GET
Apiversion : 2026-10-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
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.
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`)
Minimum : 0
Format : uint32
Default : 500
Type : integer
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.
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
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
Path : projects/{project}/aggregated/nodeTypes
▼ ▲ compute.nodeTypes.list
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
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
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
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Description : The name of the zone for this request.
Required : Yes
maxResults
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`)
Type : integer
Default : 500
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
Scopes :
Parameter Order :
Flat Path : projects/{project}/zones/{zone}/nodeTypes
HTTP Method : GET
Path : projects/{project}/zones/{zone}/nodeTypes
Description : Retrieves a list of node types available to the specified project.
Apiversion : 2026-10-01-preview
▼ ▲ compute.nodeTypes.get
Scopes :
Path : projects/{project}/zones/{zone}/nodeTypes/{nodeType}
HTTP Method : GET
Description : Returns the specified node type.
Apiversion : 2026-10-01-preview
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.
nodeType
Location : path
Description : Name of the node type to return.
Type : string
Required : Yes
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])?
Description : The name of the zone for this request.
Location : path
Required : Yes
Flat Path : projects/{project}/zones/{zone}/nodeTypes/{nodeType}
Parameter Order :
▼ ▲ compute.instantSnapshotGroups.testIamPermissions
Path : projects/{project}/zones/{zone}/instantSnapshotGroups/{resource}/testIamPermissions
Flat Path : projects/{project}/zones/{zone}/instantSnapshotGroups/{resource}/testIamPermissions
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])?))
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
zone
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : The name of the zone for this request.
Type : string
Location : path
Required : Yes
Description : Returns permissions that a caller has on the specified resource.
Scopes :
Parameter Order :
HTTP Method : POST
Apiversion : 2026-10-01-preview
▼ ▲ compute.instantSnapshotGroups.get
Scopes :
Flat Path : projects/{project}/zones/{zone}/instantSnapshotGroups/{instantSnapshotGroup}
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])?))
zone
Required : Yes
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : The name of the zone for this request.
instantSnapshotGroup
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 InstantSnapshotGroup resource to return.
Required : Yes
Description : returns the specified InstantSnapshotGroup resource in the specified zone.
Path : projects/{project}/zones/{zone}/instantSnapshotGroups/{instantSnapshotGroup}
HTTP Method : GET
Apiversion : 2026-10-01-preview
Parameter Order :
▼ ▲ compute.instantSnapshotGroups.getIamPolicy
Parameters :
optionsRequestedPolicyVersion
Type : integer
Description : Requested IAM Policy version.
Location : query
Format : int32
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
Required : Yes
Type : string
zone
Description : The name of the zone for this request.
Location : path
Type : string
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-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])?))
Flat Path : projects/{project}/zones/{zone}/instantSnapshotGroups/{resource}/getIamPolicy
Apiversion : 2026-10-01-preview
Scopes :
Path : projects/{project}/zones/{zone}/instantSnapshotGroups/{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.instantSnapshotGroups.insert
Parameter Order :
Apiversion : 2026-10-01-preview
HTTP Method : POST
Description : inserts a Zonal InstantSnapshotGroup 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])?))
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
sourceConsistencyGroup
Description : begin_interface: MixerMutationRequestBuilder
Location : query
Type : string
zone
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Type : string
Description : Name of the zone for this request.
Scopes :
Path : projects/{project}/zones/{zone}/instantSnapshotGroups
Flat Path : projects/{project}/zones/{zone}/instantSnapshotGroups
▼ ▲ compute.instantSnapshotGroups.delete
Flat Path : projects/{project}/zones/{zone}/instantSnapshotGroups/{instantSnapshotGroup}
HTTP Method : DELETE
Apiversion : 2026-10-01-preview
Parameters :
zone
Description : The name of the zone for this request.
Location : path
Type : string
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
instantSnapshotGroup
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 InstantSnapshot resource to delete.
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
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 :
Path : projects/{project}/zones/{zone}/instantSnapshotGroups/{instantSnapshotGroup}
Scopes :
Description : deletes a Zonal InstantSnapshotGroup resource
▼ ▲ compute.instantSnapshotGroups.setIamPolicy
Path : projects/{project}/zones/{zone}/instantSnapshotGroups/{resource}/setIamPolicy
HTTP Method : POST
Description : Sets the access control policy on the specified resource. Replaces any existing policy.
Apiversion : 2026-10-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
Description : Project ID for this request.
Required : Yes
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])?
resource
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 or id of the resource for this request.
Scopes :
Parameter Order :
Flat Path : projects/{project}/zones/{zone}/instantSnapshotGroups/{resource}/setIamPolicy
▼ ▲ compute.instantSnapshotGroups.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.
Location : query
Type : string
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])?))
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
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`)
Format : uint32
Type : integer
Minimum : 0
zone
Description : The name of the zone for this request.
Location : path
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Scopes :
Description : retrieves the list of InstantSnapshotGroup resources contained within the specified zone.
Flat Path : projects/{project}/zones/{zone}/instantSnapshotGroups
Path : projects/{project}/zones/{zone}/instantSnapshotGroups
HTTP Method : GET
Apiversion : 2026-10-01-preview
Parameter Order :
▼ ▲ compute.zoneVmExtensionPolicies.update
Parameter Order :
Parameters :
zone
Location : path
Type : string
Description : Name of the zone for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
vmExtensionPolicy
Location : path
Required : Yes
Description : Name of the zone VM extension 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
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])?))
Path : projects/{project}/zones/{zone}/vmExtensionPolicies/{vmExtensionPolicy}
Description : Modifies an existing zone VM extension policy within a project.
HTTP Method : PATCH
Scopes :
Flat Path : projects/{project}/zones/{zone}/vmExtensionPolicies/{vmExtensionPolicy}
Apiversion : 2026-10-01-preview
▼ ▲ compute.zoneVmExtensionPolicies.list
Flat Path : projects/{project}/zones/{zone}/vmExtensionPolicies
Apiversion : 2026-10-01-preview
Scopes :
HTTP Method : GET
Parameter Order :
Description : Lists all VM extension policies within a specific zone for a project.
Path : projects/{project}/zones/{zone}/vmExtensionPolicies
Parameters :
zone
Type : string
Required : Yes
Location : path
Description : Name of the zone for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
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
Type : integer
Location : query
Format : uint32
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])?))
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.
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
▼ ▲ compute.zoneVmExtensionPolicies.get
Scopes :
Description : Retrieves details of a specific zone VM extension policy within a project.
Parameter Order :
HTTP Method : GET
Path : projects/{project}/zones/{zone}/vmExtensionPolicies/{vmExtensionPolicy}
Apiversion : 2026-10-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
Description : Project ID for this request.
Required : Yes
vmExtensionPolicy
Required : Yes
Location : path
Type : string
Description : Name of the VM extension policy resource to return.
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])?
Required : Yes
Type : string
Description : Name of the zone for this request.
Location : path
Flat Path : projects/{project}/zones/{zone}/vmExtensionPolicies/{vmExtensionPolicy}
▼ ▲ compute.zoneVmExtensionPolicies.insert
Scopes :
HTTP Method : POST
Path : projects/{project}/zones/{zone}/vmExtensionPolicies
Apiversion : 2026-10-01-preview
Parameters :
zone
Description : Name of the zone for this request.
Required : Yes
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
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}/zones/{zone}/vmExtensionPolicies
Parameter Order :
Description : Creates a new zone-level VM extension policy within a project.
▼ ▲ compute.zoneVmExtensionPolicies.delete
Description : Deletes a specified zone VM extension policy within a project.
Parameters :
project
Required : Yes
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])?))
zone
Type : string
Required : Yes
Location : path
Description : Name of the zone for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
vmExtensionPolicy
Type : string
Location : path
Description : Name of the zone VM extension policy to delete.
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).
Path : projects/{project}/zones/{zone}/vmExtensionPolicies/{vmExtensionPolicy}
Parameter Order :
Flat Path : projects/{project}/zones/{zone}/vmExtensionPolicies/{vmExtensionPolicy}
HTTP Method : DELETE
Apiversion : 2026-10-01-preview
Scopes :
▼ ▲ compute.machineTypes.list
Scopes :
Apiversion : 2026-10-01-preview
HTTP Method : GET
Description : Retrieves a list of machine types available to the specified project.
Flat Path : projects/{project}/zones/{zone}/machineTypes
Path : projects/{project}/zones/{zone}/machineTypes
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
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
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
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
maxResults
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
Format : uint32
Default : 500
▼ ▲ compute.machineTypes.get
Path : projects/{project}/zones/{zone}/machineTypes/{machineType}
HTTP Method : GET
Description : Returns the specified machine type.
Apiversion : 2026-10-01-preview
Scopes :
Parameters :
machineType
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 machine type to return.
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
zone
Description : The name of the zone for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Type : string
Location : path
Flat Path : projects/{project}/zones/{zone}/machineTypes/{machineType}
Parameter Order :
▼ ▲ compute.machineTypes.aggregatedList
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.
maxResults
Minimum : 0
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`)
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
Format : int64
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
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
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
Description : Retrieves an aggregated list of machine types. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/aggregated/machineTypes
Parameter Order : project
Scopes :
HTTP Method : GET
Path : projects/{project}/aggregated/machineTypes
▼ ▲ compute.regionHealthChecks.update
Flat Path : projects/{project}/regions/{region}/healthChecks/{healthCheck}
HTTP Method : PUT
Description : Updates a HealthCheck resource in the specified project using the data included in the request.
Apiversion : 2026-10-01-preview
Path : projects/{project}/regions/{region}/healthChecks/{healthCheck}
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).
healthCheck
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 HealthCheck resource to update.
Location : path
region
Required : Yes
Location : path
Description : Name of the region scoping this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
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.
Parameter Order :
Scopes :
▼ ▲ compute.regionHealthChecks.get
Parameter Order :
Flat Path : projects/{project}/regions/{region}/healthChecks/{healthCheck}
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
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
healthCheck
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 HealthCheck resource to return.
Required : Yes
HTTP Method : GET
Apiversion : 2026-10-01-preview
Path : projects/{project}/regions/{region}/healthChecks/{healthCheck}
Description : Returns the specified HealthCheck resource.
▼ ▲ compute.regionHealthChecks.patch
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.
Parameters :
healthCheck
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 HealthCheck 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).
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
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
Apiversion : 2026-10-01-preview
Path : projects/{project}/regions/{region}/healthChecks/{healthCheck}
Flat Path : projects/{project}/regions/{region}/healthChecks/{healthCheck}
Parameter Order :
HTTP Method : PATCH
▼ ▲ compute.regionHealthChecks.list
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
maxResults
Location : query
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`)
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
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
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
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.
Scopes :
Flat Path : projects/{project}/regions/{region}/healthChecks
Parameter Order :
Path : projects/{project}/regions/{region}/healthChecks
Apiversion : 2026-10-01-preview
HTTP Method : GET
Description : Retrieves the list of HealthCheck resources available to the specified project.
▼ ▲ compute.regionHealthChecks.insert
Flat Path : projects/{project}/regions/{region}/healthChecks
Apiversion : 2026-10-01-preview
Parameter Order :
HTTP Method : POST
Parameters :
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.
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 : Name of the region scoping this request.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Scopes :
Description : Creates a HealthCheck resource in the specified project using the data included in the request.
Path : projects/{project}/regions/{region}/healthChecks
▼ ▲ compute.regionHealthChecks.delete
Flat Path : projects/{project}/regions/{region}/healthChecks/{healthCheck}
Parameter Order :
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
healthCheck
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
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
Apiversion : 2026-10-01-preview
Description : Deletes the specified HealthCheck resource.
HTTP Method : DELETE
Path : projects/{project}/regions/{region}/healthChecks/{healthCheck}
▼ ▲ compute.regionHealthChecks.testIamPermissions
Apiversion : 2026-10-01-preview
HTTP Method : POST
Scopes :
Description : Returns permissions that a caller has on the specified resource.
Flat Path : projects/{project}/regions/{region}/healthChecks/{resource}/testIamPermissions
Path : projects/{project}/regions/{region}/healthChecks/{resource}/testIamPermissions
Parameter Order :
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])?
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
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
▼ ▲ compute.wireGroups.insert
Parameters :
validateOnly
Type : boolean
Description : [Input Only] Validate the new configuration, but don't create it.
Location : query
crossSiteNetwork
Type : string
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
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). end_interface: MixerMutationRequestBuilder
Path : projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}/wireGroups
Description : Creates a wire group in the specified project in the given scope using the parameters that are included in the request.
Parameter Order :
Scopes :
HTTP Method : POST
Flat Path : projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}/wireGroups
Apiversion : 2026-10-01-preview
▼ ▲ compute.wireGroups.delete
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). end_interface: MixerMutationRequestBuilder
Type : string
wireGroup
Type : string
Description : Name of the wire group resource to delete.
Required : Yes
Location : path
crossSiteNetwork
Required : Yes
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.
Location : path
Type : string
Description : Deletes the specified wire group in the given scope.
Flat Path : projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}/wireGroups/{wireGroup}
Parameter Order :
Path : projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}/wireGroups/{wireGroup}
Apiversion : 2026-10-01-preview
HTTP Method : DELETE
▼ ▲ compute.wireGroups.list
Parameter Order :
Parameters :
maxResults
Location : query
Format : uint32
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
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
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.
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
crossSiteNetwork
Location : path
Type : string
Required : Yes
Description : Lists the wire groups for a project in the given scope.
Scopes :
HTTP Method : GET
Flat Path : projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}/wireGroups
Apiversion : 2026-10-01-preview
Path : projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}/wireGroups
▼ ▲ compute.wireGroups.get
HTTP Method : GET
Apiversion : 2026-10-01-preview
Scopes :
Flat Path : projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}/wireGroups/{wireGroup}
Path : projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}/wireGroups/{wireGroup}
Parameters :
crossSiteNetwork
Type : string
Required : Yes
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])?))
Required : Yes
Description : Project ID for this request.
Location : path
wireGroup
Type : string
Location : path
Description : Name of the wire group resource to return.
Required : Yes
Description : Gets the specified wire group resource in the given scope.
Parameter Order :
▼ ▲ compute.wireGroups.patch
Flat Path : projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}/wireGroups/{wireGroup}
Path : projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}/wireGroups/{wireGroup}
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
updateMask
Format : google-fieldmask
Location : query
Description : update_mask indicates fields to be updated as part of this request.
Type : string
crossSiteNetwork
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). end_interface: MixerMutationRequestBuilder
Location : query
Type : string
wireGroup
Location : path
Type : string
Required : Yes
Description : Name of the WireGroups resource to patch.
validateOnly
Location : query
Type : boolean
Description : [Input Only] Validate the new configuration, but don't update it.
Apiversion : 2026-10-01-preview
HTTP Method : PATCH
Parameter Order :
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.
Scopes :
▼ ▲ compute.reservationBlocks.get
Parameters :
zone
Description : Name of the zone for this request. Zone name should conform to RFC1035.
Required : Yes
Type : string
Location : path
view
Enum Descriptions :
Type : string
Location : query
Description : View of the Block.
Enum :
project
Required : Yes
Type : string
Location : path
Description : Project ID for this request.
reservationBlock
Location : path
Type : string
Description : The name of the reservation block. Name should conform to RFC1035 or be a resource ID.
Required : Yes
reservation
Required : Yes
Location : path
Type : string
Description : The name of the reservation. Name should conform to RFC1035 or be a resource ID.
Description : Retrieves information about the specified reservation block.
Scopes :
Path : projects/{project}/zones/{zone}/reservations/{reservation}/reservationBlocks/{reservationBlock}
Flat Path : projects/{project}/zones/{zone}/reservations/{reservation}/reservationBlocks/{reservationBlock}
Parameter Order :
HTTP Method : GET
Apiversion : 2026-10-01-preview
▼ ▲ compute.reservationBlocks.setIamPolicy
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
parentResource
Required : Yes
Type : string
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])?
Location : path
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
resource
Description : Name or id of the resource for this request.
Required : Yes
Location : path
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Parameter Order :
Flat Path : projects/{project}/zones/{zone}/reservations/{parentResource}/reservationBlocks/{resource}/setIamPolicy
Description : Sets the access control policy on the specified resource. Replaces any existing policy.
Apiversion : 2026-10-01-preview
Scopes :
HTTP Method : POST
Path : projects/{project}/zones/{zone}/reservations/{parentResource}/reservationBlocks/{resource}/setIamPolicy
▼ ▲ compute.reservationBlocks.list
Path : projects/{project}/zones/{zone}/reservations/{reservation}/reservationBlocks
HTTP Method : GET
Apiversion : 2026-10-01-preview
Scopes :
Parameter Order :
Flat Path : projects/{project}/zones/{zone}/reservations/{reservation}/reservationBlocks
Parameters :
maxResults
Default : 500
Type : integer
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
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
reservation
Type : string
Required : Yes
Location : path
Description : The name of the reservation. Name should conform to RFC1035 or be a resource ID.
zone
Type : string
Required : Yes
Location : path
Description : Name of the zone for this request. Zone name should conform to 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
project
Required : Yes
Description : Project ID for this request.
Type : string
Location : path
Description : Retrieves a list of reservation blocks under a single reservation.
▼ ▲ compute.reservationBlocks.getIamPolicy
Apiversion : 2026-10-01-preview
HTTP Method : GET
Scopes :
Parameter Order :
Path : projects/{project}/zones/{zone}/reservations/{parentResource}/reservationBlocks/{resource}/getIamPolicy
Flat Path : projects/{project}/zones/{zone}/reservations/{parentResource}/reservationBlocks/{resource}/getIamPolicy
Description : Gets the access control policy for a resource. May be empty if no such policy or resource exists.
Parameters :
parentResource
Pattern : [a-z](?:[-a-zA-Z0-9/]{0,255}[a-zA-Z0-9])?
Required : Yes
Description : Name or id of parent resource of the resource 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])?))
Required : Yes
Type : string
Description : Project ID for this request.
Location : path
optionsRequestedPolicyVersion
Description : Requested IAM Policy version.
Location : query
Format : int32
Type : integer
zone
Type : string
Location : path
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : The name of the zone for this request.
resource
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
Location : path
▼ ▲ compute.reservationBlocks.testIamPermissions
Flat Path : projects/{project}/zones/{zone}/reservations/{parentResource}/reservationBlocks/{resource}/testIamPermissions
Path : projects/{project}/zones/{zone}/reservations/{parentResource}/reservationBlocks/{resource}/testIamPermissions
Scopes :
Parameters :
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
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
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
parentResource
Required : Yes
Description : Name or id of parent resource of the resource for this request.
Location : path
Pattern : [a-z](?:[-a-zA-Z0-9/]{0,255}[a-zA-Z0-9])?
Type : string
Parameter Order :
Description : Returns permissions that a caller has on the specified resource.
HTTP Method : POST
Apiversion : 2026-10-01-preview
▼ ▲ compute.reservationBlocks.performMaintenance
Description : Allows customers to perform maintenance on a reservation block
Flat Path : projects/{project}/zones/{zone}/reservations/{reservation}/reservationBlocks/{reservationBlock}/performMaintenance
Parameters :
project
Type : string
Description : Project ID for this request.
Location : path
Required : Yes
reservationBlock
Location : path
Description : The name of the reservation block. Name should conform to RFC1035 or be a resource ID.
Required : Yes
Type : string
zone
Required : Yes
Description : Name of the zone for this request. Zone name should conform to RFC1035.
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
reservation
Required : Yes
Location : path
Type : string
Description : The name of the reservation. Name should conform to RFC1035 or be a resource ID.
Parameter Order :
Apiversion : 2026-10-01-preview
HTTP Method : POST
Path : projects/{project}/zones/{zone}/reservations/{reservation}/reservationBlocks/{reservationBlock}/performMaintenance
Scopes :
▼ ▲ compute.networkAttachments.insert
Path : projects/{project}/regions/{region}/networkAttachments
Parameters :
region
Location : path
Description : Name of the region of this request.
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
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
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
Parameter Order :
Scopes :
Apiversion : 2026-10-01-preview
Description : Creates a NetworkAttachment in the specified project in the given scope using the parameters that are included in the request.
Flat Path : projects/{project}/regions/{region}/networkAttachments
HTTP Method : POST
▼ ▲ compute.networkAttachments.delete
Description : Deletes the specified NetworkAttachment in the given scope
Path : projects/{project}/regions/{region}/networkAttachments/{networkAttachment}
Parameters :
networkAttachment
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Description : Name of the NetworkAttachment resource to delete.
Type : string
Location : path
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.
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
Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-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
Parameter Order :
Scopes :
HTTP Method : DELETE
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/regions/{region}/networkAttachments/{networkAttachment}
▼ ▲ compute.networkAttachments.setIamPolicy
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])?))
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
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])?
Path : projects/{project}/regions/{region}/networkAttachments/{resource}/setIamPolicy
Flat Path : projects/{project}/regions/{region}/networkAttachments/{resource}/setIamPolicy
Parameter Order :
Scopes :
Description : Sets the access control policy on the specified resource. Replaces any existing policy.
HTTP Method : POST
Apiversion : 2026-10-01-preview
▼ ▲ compute.networkAttachments.patch
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])?))
networkAttachment
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 NetworkAttachment 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). end_interface: MixerMutationRequestBuilder
Location : query
Type : string
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 :
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}
HTTP Method : PATCH
Path : projects/{project}/regions/{region}/networkAttachments/{networkAttachment}
Apiversion : 2026-10-01-preview
Scopes :
▼ ▲ compute.networkAttachments.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.
Required : Yes
Type : string
optionsRequestedPolicyVersion
Type : integer
Description : Requested IAM Policy version.
Location : query
Format : int32
region
Description : The name of the region for this request.
Location : path
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
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
Scopes :
Flat Path : projects/{project}/regions/{region}/networkAttachments/{resource}/getIamPolicy
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.
Parameter Order :
HTTP Method : GET
Apiversion : 2026-10-01-preview
▼ ▲ compute.networkAttachments.aggregatedList
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
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.
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
Location : query
Minimum : 0
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`)
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])?))
Required : Yes
Description : Project ID for this request.
Type : string
Location : path
Parameter Order : project
Path : projects/{project}/aggregated/networkAttachments
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`.
Flat Path : projects/{project}/aggregated/networkAttachments
Apiversion : 2026-10-01-preview
Scopes :
HTTP Method : GET
▼ ▲ compute.networkAttachments.get
Parameters :
region
Required : Yes
Type : string
Description : Name of the region of this request.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
networkAttachment
Description : Name of the NetworkAttachment 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
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
Scopes :
Description : Returns the specified NetworkAttachment resource in the given scope.
Parameter Order :
Path : projects/{project}/regions/{region}/networkAttachments/{networkAttachment}
HTTP Method : GET
Flat Path : projects/{project}/regions/{region}/networkAttachments/{networkAttachment}
Apiversion : 2026-10-01-preview
▼ ▲ compute.networkAttachments.list
HTTP Method : GET
Apiversion : 2026-10-01-preview
Path : projects/{project}/regions/{region}/networkAttachments
Scopes :
Flat Path : projects/{project}/regions/{region}/networkAttachments
Parameter Order :
Description : Lists the NetworkAttachments for a project in the given scope.
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
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
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Name of the region of this request.
Location : path
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.
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`)
Format : uint32
Minimum : 0
Location : query
Type : integer
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])?))
▼ ▲ compute.networkAttachments.testIamPermissions
Apiversion : 2026-10-01-preview
HTTP Method : POST
Flat Path : projects/{project}/regions/{region}/networkAttachments/{resource}/testIamPermissions
Path : projects/{project}/regions/{region}/networkAttachments/{resource}/testIamPermissions
Description : Returns permissions that a caller has on the specified resource.
Parameter Order :
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
Description : Project ID for this request.
Type : string
Location : path
resource
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.
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
▼ ▲ compute.targetPools.setSecurityPolicy
Description : Sets the Google Cloud Armor security policy for the specified target pool. For more information, seeGoogle Cloud Armor Overview
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
Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-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
Required : Yes
Description : Name of the region scoping this request.
targetPool
Description : Name of the TargetPool resource to which the security policy should be set. The name should conform to RFC1035.
Required : Yes
Location : path
Type : string
Flat Path : projects/{project}/regions/{region}/targetPools/{targetPool}/setSecurityPolicy
Parameter Order :
HTTP Method : POST
Path : projects/{project}/regions/{region}/targetPools/{targetPool}/setSecurityPolicy
Scopes :
Apiversion : 2026-10-01-preview
▼ ▲ compute.targetPools.getHealth
Path : projects/{project}/regions/{region}/targetPools/{targetPool}/getHealth
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.
targetPool
Type : string
Description : Name of the TargetPool resource to which the queried instance belongs.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
region
Location : path
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Description : Name of the region scoping this request.
Scopes :
Description : Gets the most recent health check results for each IP for the instance that is referenced by the given target pool.
Parameter Order :
Flat Path : projects/{project}/regions/{region}/targetPools/{targetPool}/getHealth
Apiversion : 2026-10-01-preview
HTTP Method : POST
▼ ▲ compute.targetPools.aggregatedList
Path : projects/{project}/aggregated/targetPools
Scopes :
Description : Retrieves an aggregated list of target pools. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.
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
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.
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
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
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])?))
maxResults
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
Minimum : 0
Parameter Order : project
Flat Path : projects/{project}/aggregated/targetPools
Apiversion : 2026-10-01-preview
HTTP Method : GET
▼ ▲ compute.targetPools.get
HTTP Method : GET
Path : projects/{project}/regions/{region}/targetPools/{targetPool}
Apiversion : 2026-10-01-preview
Description : Returns the specified target pool.
Parameter Order :
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.
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
targetPool
Description : Name of the TargetPool resource to return.
Location : path
Type : string
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Scopes :
Flat Path : projects/{project}/regions/{region}/targetPools/{targetPool}
▼ ▲ compute.targetPools.addHealthCheck
Scopes :
Parameters :
targetPool
Location : path
Description : Name of the target pool to add a health check to.
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.
Required : Yes
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])?))
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
Flat Path : projects/{project}/regions/{region}/targetPools/{targetPool}/addHealthCheck
HTTP Method : POST
Path : projects/{project}/regions/{region}/targetPools/{targetPool}/addHealthCheck
Apiversion : 2026-10-01-preview
Description : Adds health check URLs to a target pool.
Parameter Order :
▼ ▲ compute.targetPools.setBackup
Path : projects/{project}/regions/{region}/targetPools/{targetPool}/setBackup
Parameters :
targetPool
Location : path
Type : string
Required : Yes
Description : Name of the TargetPool resource to set a backup pool for.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
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
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).
Location : query
Type : string
failoverRatio
Format : float
Type : number
Description : New failoverRatio value for the target pool.
Location : query
Apiversion : 2026-10-01-preview
Parameter Order :
HTTP Method : POST
Description : Changes a backup target pool's configurations.
Flat Path : projects/{project}/regions/{region}/targetPools/{targetPool}/setBackup
Scopes :
▼ ▲ compute.targetPools.removeInstance
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
targetPool
Location : path
Type : string
Description : Name of the TargetPool resource to remove instances from.
Required : Yes
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
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-10-01-preview
Description : Removes instance URL from a target pool.
Flat Path : projects/{project}/regions/{region}/targetPools/{targetPool}/removeInstance
HTTP Method : POST
Scopes :
Path : projects/{project}/regions/{region}/targetPools/{targetPool}/removeInstance
▼ ▲ compute.targetPools.delete
Parameter Order :
Flat Path : projects/{project}/regions/{region}/targetPools/{targetPool}
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
Required : Yes
Description : Name of the region scoping this request.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
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
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 :
Description : Deletes the specified target pool.
Apiversion : 2026-10-01-preview
HTTP Method : DELETE
Path : projects/{project}/regions/{region}/targetPools/{targetPool}
▼ ▲ compute.targetPools.addInstance
Scopes :
Path : projects/{project}/regions/{region}/targetPools/{targetPool}/addInstance
Flat Path : projects/{project}/regions/{region}/targetPools/{targetPool}/addInstance
Apiversion : 2026-10-01-preview
Parameter Order :
HTTP Method : POST
Description : Adds an instance to a target pool.
Parameters :
targetPool
Required : Yes
Type : string
Description : Name of the TargetPool resource to add instances to.
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
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).
Location : query
Type : string
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Type : string
Required : Yes
Description : Name of the region scoping this request.
▼ ▲ compute.targetPools.insert
Path : projects/{project}/regions/{region}/targetPools
Apiversion : 2026-10-01-preview
HTTP Method : POST
Parameter Order :
Flat Path : projects/{project}/regions/{region}/targetPools
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
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
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 : Creates a target pool in the specified project and region using the data included in the request.
Scopes :
▼ ▲ compute.targetPools.testIamPermissions
Path : projects/{project}/regions/{region}/targetPools/{resource}/testIamPermissions
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.
Location : path
Type : string
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])?))
region
Description : The name of the region for this request.
Required : Yes
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Scopes :
Description : Returns permissions that a caller has on the specified resource.
HTTP Method : POST
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/regions/{region}/targetPools/{resource}/testIamPermissions
Parameter Order :
▼ ▲ compute.targetPools.removeHealthCheck
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
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
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])?))
Type : string
Location : path
Description : Project ID for this request.
targetPool
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the target pool to remove health checks from.
Required : Yes
Type : string
Location : path
Path : projects/{project}/regions/{region}/targetPools/{targetPool}/removeHealthCheck
Parameter Order :
Flat Path : projects/{project}/regions/{region}/targetPools/{targetPool}/removeHealthCheck
Description : Removes health check URL from a target pool.
Apiversion : 2026-10-01-preview
HTTP Method : POST
▼ ▲ compute.targetPools.list
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
region
Required : Yes
Type : string
Location : path
Description : Name of the region scoping this request.
Pattern : [a-z](?:[-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`)
Minimum : 0
Format : uint32
Location : query
Type : integer
Default : 500
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.
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.
Required : Yes
Type : string
Scopes :
Path : projects/{project}/regions/{region}/targetPools
Flat Path : projects/{project}/regions/{region}/targetPools
Parameter Order :
HTTP Method : GET
Description : Retrieves a list of target pools available to the specified project and region.
Apiversion : 2026-10-01-preview
▼ ▲ compute.regionNetworkEndpointGroups.attachNetworkEndpoints
Description : Attach a list of network endpoints to the specified network endpoint group.
Parameters :
networkEndpointGroup
Description : The name of the network endpoint group where you are attaching network endpoints to. It should comply with RFC1035.
Required : Yes
Type : string
Location : path
region
Description : The name of the region where you want to create the network endpoint group. It should comply with RFC1035.
Location : path
Required : Yes
Type : string
project
Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Type : string
Location : path
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
Parameter Order :
Flat Path : projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints
Scopes :
HTTP Method : POST
Path : projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints
Apiversion : 2026-10-01-preview
▼ ▲ compute.regionNetworkEndpointGroups.detachNetworkEndpoints
Parameters :
region
Location : path
Description : The name of the region where the network endpoint group is located. It should comply with RFC1035.
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
networkEndpointGroup
Location : path
Description : The name of the network endpoint group you are detaching network endpoints from. It should comply with RFC1035.
Required : Yes
Type : string
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.
Path : projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints
Description : Detach the network endpoint from the specified network endpoint group.
Parameter Order :
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints
HTTP Method : POST
Scopes :
▼ ▲ compute.regionNetworkEndpointGroups.list
Parameters :
region
Type : string
Description : The name of theregion where the network endpoint group is located. It should comply with RFC1035.
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.
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
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`)
Type : integer
Minimum : 0
Format : uint32
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.
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
Parameter Order :
Flat Path : projects/{project}/regions/{region}/networkEndpointGroups
Path : projects/{project}/regions/{region}/networkEndpointGroups
Description : Retrieves the list of regional network endpoint groups available to the specified project in the given region.
Scopes :
Apiversion : 2026-10-01-preview
HTTP Method : GET
▼ ▲ compute.regionNetworkEndpointGroups.get
Flat Path : projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}
Description : Returns the specified network endpoint group.
HTTP Method : GET
Parameter Order :
Scopes :
Apiversion : 2026-10-01-preview
Path : projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}
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
networkEndpointGroup
Description : The name of the network endpoint group. It should comply with RFC1035.
Required : Yes
Type : string
Location : path
region
Location : path
Type : string
Description : The name of the region where the network endpoint group is located. It should comply with RFC1035.
Required : Yes
▼ ▲ compute.regionNetworkEndpointGroups.insert
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
Flat Path : projects/{project}/regions/{region}/networkEndpointGroups
Apiversion : 2026-10-01-preview
Scopes :
Path : projects/{project}/regions/{region}/networkEndpointGroups
HTTP Method : POST
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])?))
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
Description : The name of the region where you want to create the network endpoint group. It should comply with RFC1035.
Required : Yes
Parameter Order :
▼ ▲ compute.regionNetworkEndpointGroups.delete
Scopes :
Path : projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}
Flat Path : projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}
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])?))
networkEndpointGroup
Description : The name of the network endpoint group to delete. It should comply with RFC1035.
Location : path
Required : Yes
Type : string
region
Required : Yes
Type : string
Description : The name of the region where the network endpoint group is located. It should comply with RFC1035.
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
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.
Apiversion : 2026-10-01-preview
Parameter Order :
HTTP Method : DELETE
▼ ▲ compute.regionNetworkEndpointGroups.listNetworkEndpoints
Scopes :
Apiversion : 2026-10-01-preview
HTTP Method : POST
Flat Path : projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}/listNetworkEndpoints
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])?))
networkEndpointGroup
Type : string
Required : Yes
Location : path
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.
maxResults
Location : query
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`)
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
region
Description : The name of theregion where the network endpoint group is located. It should comply with RFC1035.
Location : path
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.
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}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}/listNetworkEndpoints
Description : Lists the network endpoints in the specified network endpoint group.
▼ ▲ compute.interconnectAttachmentGroups.insert
Description : Creates a InterconnectAttachmentGroup in the specified project in the given scope using the parameters that are included in the request.
Path : projects/{project}/global/interconnectAttachmentGroups
Parameter Order : project
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
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
Flat Path : projects/{project}/global/interconnectAttachmentGroups
HTTP Method : POST
Apiversion : 2026-10-01-preview
Scopes :
▼ ▲ compute.interconnectAttachmentGroups.delete
Path : projects/{project}/global/interconnectAttachmentGroups/{interconnectAttachmentGroup}
Description : Deletes the specified InterconnectAttachmentGroup in the given scope
Apiversion : 2026-10-01-preview
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). end_interface: MixerMutationRequestBuilder
interconnectAttachmentGroup
Required : Yes
Description : Name of the InterconnectAttachmentGroup resource to delete.
Location : path
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
project
Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Type : string
Required : Yes
Description : Project ID for this request.
Location : path
Scopes :
Flat Path : projects/{project}/global/interconnectAttachmentGroups/{interconnectAttachmentGroup}
Parameter Order :
▼ ▲ compute.interconnectAttachmentGroups.getOperationalStatus
Path : projects/{project}/global/interconnectAttachmentGroups/{interconnectAttachmentGroup}/getOperationalStatus
Parameters :
interconnectAttachmentGroup
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 interconnectAttachmentGroup resource to query.
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
Flat Path : projects/{project}/global/interconnectAttachmentGroups/{interconnectAttachmentGroup}/getOperationalStatus
Scopes :
Description : Returns the InterconnectAttachmentStatuses for the specified InterconnectAttachmentGroup resource.
HTTP Method : GET
Apiversion : 2026-10-01-preview
Parameter Order :
▼ ▲ compute.interconnectAttachmentGroups.patch
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.
Apiversion : 2026-10-01-preview
Scopes :
HTTP Method : PATCH
Path : projects/{project}/global/interconnectAttachmentGroups/{interconnectAttachmentGroup}
Parameter Order :
Flat Path : projects/{project}/global/interconnectAttachmentGroups/{interconnectAttachmentGroup}
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). end_interface: MixerMutationRequestBuilder
Location : query
updateMask
Format : google-fieldmask
Location : query
Description : The list of fields to update.
Type : string
interconnectAttachmentGroup
Location : path
Description : Name of the InterconnectAttachmentGroup resource to patch.
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])?))
Type : string
Location : path
Required : Yes
Description : Project ID for this request.
▼ ▲ compute.interconnectAttachmentGroups.list
Path : projects/{project}/global/interconnectAttachmentGroups
HTTP Method : GET
Parameter Order : project
Apiversion : 2026-10-01-preview
Scopes :
Description : Lists the InterconnectAttachmentGroups for a project in the given scope.
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
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.
orderBy
Location : query
Description : Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.
Type : string
maxResults
Location : query
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
Minimum : 0
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}/global/interconnectAttachmentGroups
▼ ▲ compute.interconnectAttachmentGroups.getIamPolicy
Parameter Order :
Path : projects/{project}/global/interconnectAttachmentGroups/{resource}/getIamPolicy
Flat Path : projects/{project}/global/interconnectAttachmentGroups/{resource}/getIamPolicy
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.
optionsRequestedPolicyVersion
Type : integer
Location : query
Format : int32
Description : Requested IAM Policy version.
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 :
HTTP Method : GET
Apiversion : 2026-10-01-preview
Description : Gets the access control policy for a resource. May be empty if no such policy or resource exists.
▼ ▲ compute.interconnectAttachmentGroups.get
Path : projects/{project}/global/interconnectAttachmentGroups/{interconnectAttachmentGroup}
HTTP Method : GET
Flat Path : projects/{project}/global/interconnectAttachmentGroups/{interconnectAttachmentGroup}
Apiversion : 2026-10-01-preview
Scopes :
Description : Returns the specified InterconnectAttachmentGroup resource in the given scope.
Parameters :
interconnectAttachmentGroup
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 InterconnectAttachmentGroup resource to return.
Location : path
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 :
▼ ▲ compute.interconnectAttachmentGroups.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.
Location : path
Type : string
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.
Location : path
Type : string
Required : Yes
Apiversion : 2026-10-01-preview
Path : projects/{project}/global/interconnectAttachmentGroups/{resource}/testIamPermissions
Scopes :
Flat Path : projects/{project}/global/interconnectAttachmentGroups/{resource}/testIamPermissions
HTTP Method : POST
Parameter Order :
▼ ▲ compute.interconnectAttachmentGroups.setIamPolicy
Flat Path : projects/{project}/global/interconnectAttachmentGroups/{resource}/setIamPolicy
Scopes :
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])?))
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
Description : Sets the access control policy on the specified resource. Replaces any existing policy.
HTTP Method : POST
Apiversion : 2026-10-01-preview
Parameter Order :
Path : projects/{project}/global/interconnectAttachmentGroups/{resource}/setIamPolicy
▼ ▲ compute.storagePools.get
Parameter Order :
Parameters :
storagePool
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 storage pool to return.
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
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}/zones/{zone}/storagePools/{storagePool}
Scopes :
Description : Returns a specified storage pool. Gets a list of available storage pools by making a list() request.
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/zones/{zone}/storagePools/{storagePool}
HTTP Method : GET
▼ ▲ compute.storagePools.testIamPermissions
Scopes :
Flat Path : projects/{project}/zones/{zone}/storagePools/{resource}/testIamPermissions
Parameters :
zone
Required : Yes
Type : string
Location : path
Description : The name of the zone for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
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
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
Parameter Order :
HTTP Method : POST
Apiversion : 2026-10-01-preview
Path : projects/{project}/zones/{zone}/storagePools/{resource}/testIamPermissions
Description : Returns permissions that a caller has on the specified resource.
▼ ▲ compute.storagePools.update
HTTP Method : PATCH
Scopes :
Apiversion : 2026-10-01-preview
Path : projects/{project}/zones/{zone}/storagePools/{storagePool}
Parameter Order :
Flat Path : projects/{project}/zones/{zone}/storagePools/{storagePool}
Parameters :
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.
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
storagePool
Description : The storagePool 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}
Location : path
updateMask
Description : update_mask indicates fields to be updated as part of this request.
Type : string
Format : google-fieldmask
Location : query
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.
▼ ▲ compute.storagePools.list
Description : Retrieves a list of storage pools contained within the specified zone.
Scopes :
Parameters :
maxResults
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`)
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
Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-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
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
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
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.
Apiversion : 2026-10-01-preview
HTTP Method : GET
Path : projects/{project}/zones/{zone}/storagePools
Parameter Order :
Flat Path : projects/{project}/zones/{zone}/storagePools
▼ ▲ compute.storagePools.listDisks
Flat Path : projects/{project}/zones/{zone}/storagePools/{storagePool}/listDisks
Parameter Order :
Scopes :
HTTP Method : GET
Description : Lists the disks in a specified storage pool.
Apiversion : 2026-10-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
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
Default : 500
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`)
zone
Required : Yes
Location : path
Description : The name of the zone for this request.
Type : string
Pattern : [a-z](?:[-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
storagePool
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 storage pool to list disks of.
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
Path : projects/{project}/zones/{zone}/storagePools/{storagePool}/listDisks
▼ ▲ compute.storagePools.getIamPolicy
Description : Gets the access control policy for a resource. May be empty if no such policy or resource exists.
Apiversion : 2026-10-01-preview
Scopes :
Path : projects/{project}/zones/{zone}/storagePools/{resource}/getIamPolicy
Parameter Order :
HTTP Method : GET
Flat Path : projects/{project}/zones/{zone}/storagePools/{resource}/getIamPolicy
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
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.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
Type : string
zone
Location : path
Description : The name of the zone for this request.
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
▼ ▲ compute.storagePools.insert
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
Type : string
Required : Yes
Location : path
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
Type : string
Location : path
Description : Project ID for this request.
Flat Path : projects/{project}/zones/{zone}/storagePools
Parameter Order :
Description : Creates a storage pool in the specified project using the data in the request.
Scopes :
Path : projects/{project}/zones/{zone}/storagePools
HTTP Method : POST
Apiversion : 2026-10-01-preview
▼ ▲ compute.storagePools.delete
Flat Path : projects/{project}/zones/{zone}/storagePools/{storagePool}
Parameter Order :
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.
Apiversion : 2026-10-01-preview
HTTP Method : DELETE
Path : projects/{project}/zones/{zone}/storagePools/{storagePool}
Parameters :
storagePool
Location : path
Type : string
Description : Name of the storage pool to delete.
Required : Yes
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.
Type : string
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
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])?))
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
Scopes :
▼ ▲ compute.storagePools.setIamPolicy
HTTP Method : POST
Path : projects/{project}/zones/{zone}/storagePools/{resource}/setIamPolicy
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/zones/{zone}/storagePools/{resource}/setIamPolicy
Description : Sets the access control policy on the specified resource. Replaces any existing policy.
Parameter Order :
Parameters :
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.
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
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])?))
Scopes :
▼ ▲ compute.storagePools.aggregatedList
Path : projects/{project}/aggregated/storagePools
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.
Type : string
Location : query
Format : int64
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
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`)
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])?))
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.
Type : string
Location : query
Scopes :
Parameter Order : project
Description : Retrieves an aggregated list of storage pools. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/aggregated/storagePools
HTTP Method : GET
▼ ▲ compute.resourcePolicies.setIamPolicy
Scopes :
Description : Sets the access control policy on the specified resource. Replaces any existing policy.
Parameters :
region
Location : path
Required : Yes
Description : The name of the region for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
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
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
Parameter Order :
Apiversion : 2026-10-01-preview
Path : projects/{project}/regions/{region}/resourcePolicies/{resource}/setIamPolicy
Flat Path : projects/{project}/regions/{region}/resourcePolicies/{resource}/setIamPolicy
HTTP Method : POST
▼ ▲ compute.resourcePolicies.getIamPolicy
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
optionsRequestedPolicyVersion
Description : Requested IAM Policy version.
Location : query
Format : int32
Type : integer
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Type : string
Description : The name of the region for this request.
Location : path
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.
Description : Gets the access control policy for a resource. May be empty if no such policy or resource exists.
Parameter Order :
Scopes :
Flat Path : projects/{project}/regions/{region}/resourcePolicies/{resource}/getIamPolicy
Path : projects/{project}/regions/{region}/resourcePolicies/{resource}/getIamPolicy
Apiversion : 2026-10-01-preview
HTTP Method : GET
▼ ▲ compute.resourcePolicies.testIamPermissions
Path : projects/{project}/regions/{region}/resourcePolicies/{resource}/testIamPermissions
Parameters :
region
Required : Yes
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : The name of the region for this request.
Type : string
resource
Description : Name or id of the resource for this request.
Required : Yes
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
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.
Flat Path : projects/{project}/regions/{region}/resourcePolicies/{resource}/testIamPermissions
Description : Returns permissions that a caller has on the specified resource.
Apiversion : 2026-10-01-preview
Scopes :
Parameter Order :
HTTP Method : POST
▼ ▲ compute.resourcePolicies.patch
HTTP Method : PATCH
Apiversion : 2026-10-01-preview
Description : Modify the specified resource policy.
Parameter Order :
Path : projects/{project}/regions/{region}/resourcePolicies/{resourcePolicy}
Flat Path : projects/{project}/regions/{region}/resourcePolicies/{resourcePolicy}
Parameters :
updateMask
Location : query
Description : update_mask indicates fields to be updated as part of this request.
Type : string
Format : google-fieldmask
resourcePolicy
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Type : string
Description : Id of the resource policy to patch.
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
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
Required : Yes
Type : string
Description : Name of the region for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Scopes :
▼ ▲ compute.resourcePolicies.get
Path : projects/{project}/regions/{region}/resourcePolicies/{resourcePolicy}
Flat Path : projects/{project}/regions/{region}/resourcePolicies/{resourcePolicy}
Scopes :
Apiversion : 2026-10-01-preview
HTTP Method : GET
Parameters :
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.
resourcePolicy
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 resource policy to retrieve.
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.
Description : Retrieves all information of the specified resource policy.
Parameter Order :
▼ ▲ compute.resourcePolicies.insert
Path : projects/{project}/regions/{region}/resourcePolicies
Flat Path : projects/{project}/regions/{region}/resourcePolicies
Description : Creates a new resource 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
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
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
Parameter Order :
Scopes :
Apiversion : 2026-10-01-preview
HTTP Method : POST
▼ ▲ compute.resourcePolicies.delete
Parameter Order :
Description : Deletes the specified resource policy.
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
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])?
resourcePolicy
Description : Name of the resource policy to delete.
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
Description : Project ID for this request.
Required : Yes
Path : projects/{project}/regions/{region}/resourcePolicies/{resourcePolicy}
Apiversion : 2026-10-01-preview
Scopes :
Flat Path : projects/{project}/regions/{region}/resourcePolicies/{resourcePolicy}
HTTP Method : DELETE
▼ ▲ compute.resourcePolicies.list
Path : projects/{project}/regions/{region}/resourcePolicies
Description : A list all the resource policies that have been configured for the specified project in specified region.
Apiversion : 2026-10-01-preview
Parameter Order :
Flat Path : projects/{project}/regions/{region}/resourcePolicies
HTTP Method : GET
Scopes :
Parameters :
region
Type : string
Required : Yes
Location : path
Description : Name of the region for this request.
Pattern : [a-z](?:[-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
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.
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
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
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
▼ ▲ compute.resourcePolicies.aggregatedList
Flat Path : projects/{project}/aggregated/resourcePolicies
Parameter Order : project
Scopes :
Apiversion : 2026-10-01-preview
HTTP Method : GET
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
Description : Project ID for this request.
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`)
Location : query
Minimum : 0
Type : integer
Format : uint32
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
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
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
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.
Description : Retrieves an aggregated list of resource policies. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.
Path : projects/{project}/aggregated/resourcePolicies
▼ ▲ compute.healthChecks.testIamPermissions
Parameter Order :
Scopes :
Flat Path : projects/{project}/global/healthChecks/{resource}/testIamPermissions
Apiversion : 2026-10-01-preview
HTTP Method : POST
Parameters :
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}
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
Path : projects/{project}/global/healthChecks/{resource}/testIamPermissions
Description : Returns permissions that a caller has on the specified resource.
▼ ▲ compute.healthChecks.list
Apiversion : 2026-10-01-preview
Parameter Order : project
Description : Retrieves the list of HealthCheck resources available to the specified project.
HTTP Method : GET
Path : projects/{project}/global/healthChecks
Scopes :
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.
Type : string
Location : query
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
Location : query
Default : 500
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
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.
Flat Path : projects/{project}/global/healthChecks
▼ ▲ compute.healthChecks.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])?))
Required : Yes
Description : Project ID for this request.
Type : string
Description : Creates a HealthCheck resource in the specified project using the data included in the request.
Flat Path : projects/{project}/global/healthChecks
Parameter Order : project
Path : projects/{project}/global/healthChecks
Apiversion : 2026-10-01-preview
HTTP Method : POST
▼ ▲ compute.healthChecks.delete
Apiversion : 2026-10-01-preview
Description : Deletes the specified HealthCheck resource.
HTTP Method : DELETE
Flat Path : projects/{project}/global/healthChecks/{healthCheck}
Path : projects/{project}/global/healthChecks/{healthCheck}
Parameter Order :
Scopes :
Parameters :
healthCheck
Type : string
Location : path
Description : Name of the HealthCheck resource to delete.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
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.
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.healthChecks.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
healthCheck
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 HealthCheck resource to patch.
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
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.
Path : projects/{project}/global/healthChecks/{healthCheck}
Flat Path : projects/{project}/global/healthChecks/{healthCheck}
HTTP Method : PATCH
Parameter Order :
Apiversion : 2026-10-01-preview
▼ ▲ compute.healthChecks.update
Scopes :
Parameters :
healthCheck
Location : path
Description : Name of the HealthCheck resource to update.
Type : string
Required : Yes
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
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
Parameter Order :
Apiversion : 2026-10-01-preview
HTTP Method : PUT
Flat Path : projects/{project}/global/healthChecks/{healthCheck}
Path : projects/{project}/global/healthChecks/{healthCheck}
Description : Updates a HealthCheck resource in the specified project using the data included in the request.
▼ ▲ compute.healthChecks.aggregatedList
Scopes :
Parameters :
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
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
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 : Name of the project scoping this request.
Location : path
serviceProjectNumber
Location : query
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.
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
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.
Path : projects/{project}/aggregated/healthChecks
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/aggregated/healthChecks
Parameter Order : project
HTTP Method : GET
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`.
▼ ▲ compute.healthChecks.get
Scopes :
Apiversion : 2026-10-01-preview
Path : projects/{project}/global/healthChecks/{healthCheck}
HTTP Method : GET
Description : Returns the specified HealthCheck resource.
Parameter Order :
Flat Path : projects/{project}/global/healthChecks/{healthCheck}
Parameters :
healthCheck
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 HealthCheck resource to return.
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.
▼ ▲ compute.nodeGroups.setNodeTemplate
Scopes :
Parameters :
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])?))
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.
nodeGroup
Required : Yes
Description : Name of the NodeGroup resource to update.
Type : string
Location : path
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
Parameter Order :
Path : projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/setNodeTemplate
HTTP Method : POST
Description : Updates the node template of the node group.
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/setNodeTemplate
▼ ▲ compute.nodeGroups.listNodes
Description : Lists nodes in the node group.
Parameter Order :
Parameters :
nodeGroup
Type : string
Location : path
Description : Name of the NodeGroup resource whose nodes you want to list.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
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
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
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
zone
Location : path
Type : string
Required : Yes
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.
Location : query
Type : string
maxResults
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`)
Format : uint32
Location : query
Type : integer
HTTP Method : POST
Apiversion : 2026-10-01-preview
Path : projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/listNodes
Flat Path : projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/listNodes
Scopes :
▼ ▲ compute.nodeGroups.testIamPermissions
Path : projects/{project}/zones/{zone}/nodeGroups/{resource}/testIamPermissions
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])?))
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])?
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
Scopes :
Description : Returns permissions that a caller has on the specified resource.
Apiversion : 2026-10-01-preview
Parameter Order :
Flat Path : projects/{project}/zones/{zone}/nodeGroups/{resource}/testIamPermissions
HTTP Method : POST
▼ ▲ compute.nodeGroups.getIamPolicy
Apiversion : 2026-10-01-preview
Description : Gets the access control policy for a resource. May be empty if no such policy or resource exists.
HTTP Method : GET
Scopes :
Parameter Order :
Parameters :
zone
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Required : Yes
Location : path
Description : The name of the zone 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
Type : string
Required : Yes
resource
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 or id of the resource for this request.
optionsRequestedPolicyVersion
Description : Requested IAM Policy version.
Location : query
Format : int32
Type : integer
Path : projects/{project}/zones/{zone}/nodeGroups/{resource}/getIamPolicy
Flat Path : projects/{project}/zones/{zone}/nodeGroups/{resource}/getIamPolicy
▼ ▲ compute.nodeGroups.deleteNodes
Scopes :
Parameter Order :
HTTP Method : POST
Path : projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/deleteNodes
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/deleteNodes
Parameters :
nodeGroup
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 NodeGroup resource whose nodes will be deleted.
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
Description : Project ID for this request.
Location : path
zone
Description : The name of the zone for this request.
Location : path
Required : Yes
Pattern : [a-z](?:[-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
Description : Deletes specified nodes from the node group.
▼ ▲ compute.nodeGroups.aggregatedList
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.
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
maxResults
Type : integer
Format : uint32
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
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.
serviceProjectNumber
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
Type : string
Path : projects/{project}/aggregated/nodeGroups
Scopes :
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`.
Flat Path : projects/{project}/aggregated/nodeGroups
HTTP Method : GET
Parameter Order : project
Apiversion : 2026-10-01-preview
▼ ▲ compute.nodeGroups.delete
Apiversion : 2026-10-01-preview
HTTP Method : DELETE
Scopes :
Description : Deletes the specified NodeGroup resource.
Flat Path : projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}
Parameter Order :
Path : projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}
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
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])?))
zone
Description : The name of the zone for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Type : string
Location : path
nodeGroup
Location : path
Description : Name of the NodeGroup resource to delete.
Type : string
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
▼ ▲ compute.nodeGroups.performMaintenance
Scopes :
Flat Path : projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/performMaintenance
HTTP Method : POST
Description : Perform maintenance on a subset of nodes in the node group.
Apiversion : 2026-10-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])?))
Location : path
Required : Yes
Type : string
Description : Project ID for this request.
nodeGroup
Description : Name of the node group scoping this request.
Required : Yes
Location : path
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])?
Description : The name of the zone for this request.
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).
Type : string
Location : query
Path : projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/performMaintenance
▼ ▲ compute.nodeGroups.addNodes
Path : projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/addNodes
Description : Adds specified number of nodes to the node group.
HTTP Method : POST
Parameter Order :
Apiversion : 2026-10-01-preview
Scopes :
Parameters :
nodeGroup
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Name of the NodeGroup resource.
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. This prevents clients from accidentally creating 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
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
Flat Path : projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/addNodes
▼ ▲ compute.nodeGroups.list
Description : Retrieves a list of node groups available to the specified project. Note: use nodeGroups.listNodes for more details about each group.
HTTP Method : GET
Flat Path : projects/{project}/zones/{zone}/nodeGroups
Path : projects/{project}/zones/{zone}/nodeGroups
Apiversion : 2026-10-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])?))
Required : Yes
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`)
Format : uint32
Default : 500
Location : query
Type : integer
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
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
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.
Parameter Order :
Scopes :
▼ ▲ compute.nodeGroups.patch
Parameter Order :
Description : Updates the specified node group.
Parameters :
zone
Location : path
Description : The name of the zone for this request.
Required : Yes
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
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 to update.
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
Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-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
Apiversion : 2026-10-01-preview
HTTP Method : PATCH
Path : projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}
Flat Path : projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}
Scopes :
▼ ▲ compute.nodeGroups.simulateMaintenanceEvent
Parameters :
nodeGroup
Description : Name of the NodeGroup resource whose nodes will go under maintenance simulation.
Location : path
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])?
Location : path
Type : string
Required : Yes
Description : The name of the zone 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
Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-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
Description : Simulates maintenance event on specified nodes from the node group.
Scopes :
Parameter Order :
Flat Path : projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/simulateMaintenanceEvent
Path : projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/simulateMaintenanceEvent
HTTP Method : POST
Apiversion : 2026-10-01-preview
▼ ▲ compute.nodeGroups.setIamPolicy
Flat Path : projects/{project}/zones/{zone}/nodeGroups/{resource}/setIamPolicy
Parameters :
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
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
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
Scopes :
Path : projects/{project}/zones/{zone}/nodeGroups/{resource}/setIamPolicy
HTTP Method : POST
Apiversion : 2026-10-01-preview
Parameter Order :
Description : Sets the access control policy on the specified resource. Replaces any existing policy.
▼ ▲ compute.nodeGroups.insert
Parameters :
initialNodeCount
Format : int32
Description : Initial count of nodes in the node group.
Location : query
Type : integer
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])?))
Type : string
Required : Yes
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])?
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}/nodeGroups
Description : Creates a NodeGroup resource in the specified project using the data included in the request.
Parameter Order :
Scopes :
HTTP Method : POST
Flat Path : projects/{project}/zones/{zone}/nodeGroups
Apiversion : 2026-10-01-preview
▼ ▲ compute.nodeGroups.get
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.
nodeGroup
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 node group to return.
zone
Location : path
Type : string
Required : Yes
Description : The name of the zone for this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Path : projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}
Scopes :
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.
Parameter Order :
Flat Path : projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}
HTTP Method : GET
Apiversion : 2026-10-01-preview
▼ ▲ compute.regionHealthCheckServices.patch
Scopes :
Path : projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}
Flat Path : projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}
HTTP Method : 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.
Apiversion : 2026-10-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
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
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
healthCheckService
Location : path
Type : string
Required : Yes
Description : Name of the HealthCheckService to update. The name must be 1-63 characters long, and comply with RFC1035.
Parameter Order :
▼ ▲ compute.regionHealthCheckServices.list
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
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
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
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
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
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 : Lists all the HealthCheckService resources that have been configured for the specified project in the given region.
Scopes :
Flat Path : projects/{project}/regions/{region}/healthCheckServices
Path : projects/{project}/regions/{region}/healthCheckServices
HTTP Method : GET
Apiversion : 2026-10-01-preview
Parameter Order :
▼ ▲ compute.regionHealthCheckServices.aggregatedList
Flat Path : projects/{project}/aggregated/healthCheckServices
Path : projects/{project}/aggregated/healthCheckServices
Parameters :
project
Description : Name of the project scoping 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])?))
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
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
Location : query
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`)
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.
Type : string
Location : query
serviceProjectNumber
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
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 :
HTTP Method : GET
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`.
Apiversion : 2026-10-01-preview
Parameter Order : project
▼ ▲ compute.regionHealthCheckServices.testIamPermissions
Parameter Order :
Parameters :
region
Location : path
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Description : The name of the region for 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])?))
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
Flat Path : projects/{project}/regions/{region}/healthCheckServices/{resource}/testIamPermissions
Description : Returns permissions that a caller has on the specified resource.
Scopes :
Path : projects/{project}/regions/{region}/healthCheckServices/{resource}/testIamPermissions
HTTP Method : POST
Apiversion : 2026-10-01-preview
▼ ▲ compute.regionHealthCheckServices.get
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])?))
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
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Description : Name of the region scoping this request.
Type : string
Location : path
Parameter Order :
Description : Returns the specified regional HealthCheckService resource.
Path : projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}
Scopes :
Flat Path : projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}
HTTP Method : GET
Apiversion : 2026-10-01-preview
▼ ▲ compute.regionHealthCheckServices.insert
HTTP Method : POST
Description : Creates a regional HealthCheckService resource in the specified project and region using the data included in the request.
Flat Path : projects/{project}/regions/{region}/healthCheckServices
Apiversion : 2026-10-01-preview
Path : projects/{project}/regions/{region}/healthCheckServices
Scopes :
Parameter Order :
Parameters :
region
Required : Yes
Type : string
Location : path
Description : Name of the region scoping this request.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
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])?))
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.regionHealthCheckServices.delete
Apiversion : 2026-10-01-preview
HTTP Method : DELETE
Path : projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}
Description : Deletes the specified regional HealthCheckService.
Flat Path : projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}
Scopes :
Parameters :
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Type : string
Required : Yes
Description : Name of the region scoping this request.
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
healthCheckService
Required : Yes
Location : path
Description : Name of the HealthCheckService to delete. The name must be 1-63 characters long, and comply with RFC1035.
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
Parameter Order :
▼ ▲ compute.imageFamilyViews.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])?))
Type : string
Required : Yes
Location : path
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
family
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 image family to search for.
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.
Path : projects/{project}/zones/{zone}/imageFamilyViews/{family}
HTTP Method : GET
Parameter Order :
Scopes :
Apiversion : 2026-10-01-preview
▼ ▲ compute.networkProfiles.get
Parameter Order :
Description : Returns the specified network profile.
Apiversion : 2026-10-01-preview
HTTP Method : GET
Parameters :
networkProfile
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 profile to return.
Location : path
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])?))
Flat Path : projects/{project}/global/networkProfiles/{networkProfile}
Path : projects/{project}/global/networkProfiles/{networkProfile}
Scopes :
▼ ▲ compute.networkProfiles.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.
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
Type : integer
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.
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
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
Description : Retrieves a list of network profiles available to the specified project.
Scopes :
Parameter Order : project
Flat Path : projects/{project}/global/networkProfiles
Path : projects/{project}/global/networkProfiles
HTTP Method : GET
Apiversion : 2026-10-01-preview
▼ ▲ compute.rollouts.cancel
HTTP Method : PATCH
Flat Path : projects/{project}/global/rollouts/{rollout}
Description : Cancels a Rollout.
Apiversion : 2026-10-01-preview
Path : projects/{project}/global/rollouts/{rollout}
Parameters :
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 : Name of the Rollout resource to cancel.
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).
rollback
Type : boolean
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.
Location : query
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 :
Parameter Order :
▼ ▲ compute.rollouts.pause
Flat Path : projects/{project}/global/rollouts/{rollout}/pause
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).
rollout
Required : Yes
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Description : Required. Name of the Rollout resource to pause.
Location : path
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.
Location : query
Type : string
project
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])?))
Required : Yes
Location : path
Type : string
Apiversion : 2026-10-01-preview
Path : projects/{project}/global/rollouts/{rollout}/pause
HTTP Method : POST
Scopes :
Parameter Order :
Description : Pauses a Rollout.
▼ ▲ compute.rollouts.delete
Description : Deletes a Rollout.
HTTP Method : DELETE
Path : projects/{project}/global/rollouts/{rollout}
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/global/rollouts/{rollout}
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])?))
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).
rollout
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 Rollout resource to delete.
Type : string
Parameter Order :
▼ ▲ compute.rollouts.list
Flat Path : projects/{project}/global/rollouts
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])?))
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
Location : query
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
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.
Path : projects/{project}/global/rollouts
Description : Lists Rollouts in a given project and location.
Parameter Order : project
Scopes :
Apiversion : 2026-10-01-preview
HTTP Method : GET
▼ ▲ compute.rollouts.get
Parameter Order :
Description : Gets details of a single project-scoped Rollout.
Path : projects/{project}/global/rollouts/{rollout}
Flat Path : projects/{project}/global/rollouts/{rollout}
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])?))
rollout
Location : path
Description : Name of the persistent rollout to return.
Type : string
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Apiversion : 2026-10-01-preview
HTTP Method : GET
Scopes :
▼ ▲ compute.rollouts.advance
Parameters :
project
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])?))
Required : Yes
Type : string
Location : path
currentWaveNumber
Location : query
Description : Required. Wave number of the current wave.
Format : int64
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
rollout
Type : string
Description : Required. Name of the Rollout resource to advance.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Location : path
Scopes :
Parameter Order :
Description : Advances a Rollout to the next wave, or completes it if no waves remain.
Apiversion : 2026-10-01-preview
Path : projects/{project}/global/rollouts/{rollout}/advance
Flat Path : projects/{project}/global/rollouts/{rollout}/advance
HTTP Method : POST
▼ ▲ compute.rollouts.resume
Path : projects/{project}/global/rollouts/{rollout}/resume
Description : Resumes a Rollout.
Apiversion : 2026-10-01-preview
Scopes :
Parameter Order :
HTTP Method : POST
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).
etag
Location : query
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
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 : Required. Project ID for this request.
Location : path
rollout
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 resume.
Required : Yes
Flat Path : projects/{project}/global/rollouts/{rollout}/resume
▼ ▲ compute.managedRulesets.get
HTTP Method : GET
Apiversion : 2026-10-01-preview
Path : projects/{project}/global/managedRulesets/{managedRuleset}
Parameter Order :
Scopes :
Description : Gets the details for the specified managed ruleset name.
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
Description : Project ID for this request.
Location : path
managedRuleset
Type : string
Location : path
Required : Yes
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}
Flat Path : projects/{project}/global/managedRulesets/{managedRuleset}
▼ ▲ compute.managedRulesets.list
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
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
Location : query
Type : integer
Default : 500
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
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
Description : Retrieves the list of all the managed rulesets available.
Path : projects/{project}/global/managedRulesets
Parameter Order : project
Flat Path : projects/{project}/global/managedRulesets
HTTP Method : GET
Apiversion : 2026-10-01-preview
Scopes :
▼ ▲ compute.regionTargetHttpProxies.insert
Scopes :
Flat Path : projects/{project}/regions/{region}/targetHttpProxies
Apiversion : 2026-10-01-preview
HTTP Method : POST
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).
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
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
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.delete
Apiversion : 2026-10-01-preview
HTTP Method : DELETE
Scopes :
Flat Path : projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}
Description : Deletes the specified TargetHttpProxy resource.
Parameter Order :
Parameters :
targetHttpProxy
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 TargetHttpProxy resource to delete.
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
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])?))
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
Path : projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}
▼ ▲ compute.regionTargetHttpProxies.list
Parameter Order :
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.
Type : string
Location : query
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
Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-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
maxResults
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`)
Minimum : 0
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
Scopes :
Flat Path : projects/{project}/regions/{region}/targetHttpProxies
Apiversion : 2026-10-01-preview
Description : Retrieves the list of TargetHttpProxy resources available to the specified project in the specified region.
HTTP Method : GET
Path : projects/{project}/regions/{region}/targetHttpProxies
▼ ▲ compute.regionTargetHttpProxies.get
Parameter Order :
Apiversion : 2026-10-01-preview
HTTP Method : GET
Scopes :
Parameters :
targetHttpProxy
Description : Name of the TargetHttpProxy 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
region
Description : Name of the region scoping this request.
Type : string
Required : Yes
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])?))
Required : Yes
Type : string
Description : Project ID for this request.
Location : path
Description : Returns the specified TargetHttpProxy resource in the specified region.
Flat Path : projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}
Path : projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}
▼ ▲ compute.regionTargetHttpProxies.setUrlMap
Flat Path : projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}/setUrlMap
Apiversion : 2026-10-01-preview
Parameter Order :
HTTP Method : POST
Path : projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}/setUrlMap
Description : Changes the URL map for TargetHttpProxy.
Parameters :
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.
targetHttpProxy
Description : Name of the TargetHttpProxy to set a URL map for.
Type : string
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
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
Scopes :
▼ ▲ compute.interconnects.get
Flat Path : projects/{project}/global/interconnects/{interconnect}
Path : projects/{project}/global/interconnects/{interconnect}
Apiversion : 2026-10-01-preview
HTTP Method : GET
Description : Returns the specified Interconnect. Get a list of available Interconnects by making a list() request.
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
interconnect
Description : Name of the interconnect 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
Scopes :
Parameter Order :
▼ ▲ compute.interconnects.getMacsecConfig
Path : projects/{project}/global/interconnects/{interconnect}/getMacsecConfig
Description : Returns the interconnectMacsecConfig for the specified Interconnect.
Flat Path : projects/{project}/global/interconnects/{interconnect}/getMacsecConfig
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])?))
interconnect
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 interconnect resource to query.
Required : Yes
Scopes :
HTTP Method : GET
Apiversion : 2026-10-01-preview
Parameter Order :
▼ ▲ compute.interconnects.insert
Scopes :
Path : projects/{project}/global/interconnects
Parameter Order : project
Apiversion : 2026-10-01-preview
HTTP Method : POST
Description : Creates an Interconnect in the specified project using the data included in the request.
Flat Path : projects/{project}/global/interconnects
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.
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.interconnects.delete
HTTP Method : DELETE
Path : projects/{project}/global/interconnects/{interconnect}
Apiversion : 2026-10-01-preview
Scopes :
Flat Path : projects/{project}/global/interconnects/{interconnect}
Description : Deletes the specified Interconnect.
Parameter Order :
Parameters :
interconnect
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 delete.
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).
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.interconnects.patch
Flat Path : projects/{project}/global/interconnects/{interconnect}
HTTP Method : PATCH
Parameter Order :
Apiversion : 2026-10-01-preview
Scopes :
Parameters :
interconnect
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 interconnect to update.
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])?))
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 : Updates the specified Interconnect with the data included in the request. This method supportsPATCH semantics and uses theJSON merge patch format and processing rules.
Path : projects/{project}/global/interconnects/{interconnect}
▼ ▲ compute.interconnects.list
Scopes :
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
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
Type : integer
Format : uint32
Location : query
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
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
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
Description : Retrieves the list of Interconnects available to the specified project.
Flat Path : projects/{project}/global/interconnects
Apiversion : 2026-10-01-preview
HTTP Method : GET
Path : projects/{project}/global/interconnects
▼ ▲ compute.interconnects.setLabels
Parameter Order :
Scopes :
HTTP Method : POST
Apiversion : 2026-10-01-preview
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
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.
Flat Path : projects/{project}/global/interconnects/{resource}/setLabels
Path : projects/{project}/global/interconnects/{resource}/setLabels
Description : Sets the labels on an Interconnect. To learn more about labels, read the Labeling Resources documentation.
▼ ▲ 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.
Apiversion : 2026-10-01-preview
Parameters :
interconnect
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 interconnect resource to query.
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
Scopes :
Parameter Order :
Flat Path : projects/{project}/global/interconnects/{interconnect}/getDiagnostics
Path : projects/{project}/global/interconnects/{interconnect}/getDiagnostics
▼ ▲ compute.httpsHealthChecks.update
Apiversion : 2026-10-01-preview
HTTP Method : PUT
Scopes :
Description : Updates a HttpsHealthCheck resource in the specified project using the data included in the request.
Flat Path : projects/{project}/global/httpsHealthChecks/{httpsHealthCheck}
Path : projects/{project}/global/httpsHealthChecks/{httpsHealthCheck}
Parameter Order :
Parameters :
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
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
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 update.
Required : Yes
▼ ▲ compute.httpsHealthChecks.get
Path : projects/{project}/global/httpsHealthChecks/{httpsHealthCheck}
Scopes :
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/global/httpsHealthChecks/{httpsHealthCheck}
HTTP Method : GET
Parameter Order :
Parameters :
httpsHealthCheck
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 HttpsHealthCheck resource to return.
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
Description : Returns the specified HttpsHealthCheck resource.
▼ ▲ compute.httpsHealthChecks.list
HTTP Method : GET
Apiversion : 2026-10-01-preview
Path : projects/{project}/global/httpsHealthChecks
Scopes :
Flat Path : projects/{project}/global/httpsHealthChecks
Parameter Order : project
Parameters :
maxResults
Format : uint32
Location : query
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`)
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
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
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
Description : Retrieves the list of HttpsHealthCheck resources available to the specified project.
▼ ▲ compute.httpsHealthChecks.patch
Apiversion : 2026-10-01-preview
HTTP Method : PATCH
Flat Path : projects/{project}/global/httpsHealthChecks/{httpsHealthCheck}
Parameter Order :
Scopes :
Parameters :
httpsHealthCheck
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 patch.
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
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])?))
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.
Path : projects/{project}/global/httpsHealthChecks/{httpsHealthCheck}
▼ ▲ compute.httpsHealthChecks.testIamPermissions
HTTP Method : POST
Path : projects/{project}/global/httpsHealthChecks/{resource}/testIamPermissions
Apiversion : 2026-10-01-preview
Description : Returns permissions that a caller has on the specified resource.
Flat Path : projects/{project}/global/httpsHealthChecks/{resource}/testIamPermissions
Parameters :
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
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
Scopes :
Parameter Order :
▼ ▲ compute.httpsHealthChecks.insert
Path : projects/{project}/global/httpsHealthChecks
Scopes :
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])?))
requestId
Description : An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Location : query
Type : string
Flat Path : projects/{project}/global/httpsHealthChecks
Parameter Order : project
Description : Creates a HttpsHealthCheck resource in the specified project using the data included in the request.
Apiversion : 2026-10-01-preview
HTTP Method : POST
▼ ▲ compute.httpsHealthChecks.delete
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
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
httpsHealthCheck
Description : Name of the HttpsHealthCheck resource to delete.
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Required : Yes
Type : string
Location : path
Description : Deletes the specified HttpsHealthCheck resource.
Path : projects/{project}/global/httpsHealthChecks/{httpsHealthCheck}
Scopes :
Parameter Order :
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/global/httpsHealthChecks/{httpsHealthCheck}
HTTP Method : DELETE
▼ ▲ compute.regionSslPolicies.insert
Description : Creates a new policy in the specified project and region using the data included in the request.
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
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
region
Location : path
Required : Yes
Type : string
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Description : Name of the region scoping this request.
HTTP Method : POST
Apiversion : 2026-10-01-preview
Parameter Order :
Flat Path : projects/{project}/regions/{region}/sslPolicies
Path : projects/{project}/regions/{region}/sslPolicies
▼ ▲ compute.regionSslPolicies.delete
HTTP Method : 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.
Apiversion : 2026-10-01-preview
Parameter Order :
Scopes :
Flat Path : projects/{project}/regions/{region}/sslPolicies/{sslPolicy}
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
sslPolicy
Required : Yes
Type : string
Location : path
Description : Name of the SSL policy to delete. The name must be 1-63 characters long, and comply with RFC1035.
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
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}/regions/{region}/sslPolicies/{sslPolicy}
▼ ▲ compute.regionSslPolicies.list
Flat Path : projects/{project}/regions/{region}/sslPolicies
HTTP Method : GET
Description : Lists all the SSL policies that have been configured for the specified project and region.
Scopes :
Apiversion : 2026-10-01-preview
Path : projects/{project}/regions/{region}/sslPolicies
Parameters :
region
Description : Name of the region scoping this request.
Required : Yes
Location : path
Type : string
Pattern : [a-z](?:[-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
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])?))
Required : Yes
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
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
Parameter Order :
▼ ▲ compute.regionSslPolicies.listAvailableFeatures
HTTP Method : GET
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/regions/{region}/sslPolicies/listAvailableFeatures
Parameter Order :
Path : projects/{project}/regions/{region}/sslPolicies/listAvailableFeatures
Scopes :
Description : Lists all features that can be specified in the SSL policy when using custom profile.
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
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
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
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
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`)
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.
Location : query
Type : string
▼ ▲ compute.regionSslPolicies.patch
Description : Patches the specified SSL policy with the data included in the request.
Path : projects/{project}/regions/{region}/sslPolicies/{sslPolicy}
Parameters :
sslPolicy
Location : path
Description : Name of the SSL policy to update. The name must be 1-63 characters long, and comply with RFC1035.
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
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.
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-10-01-preview
HTTP Method : PATCH
Flat Path : projects/{project}/regions/{region}/sslPolicies/{sslPolicy}
Parameter Order :
▼ ▲ compute.regionSslPolicies.get
HTTP Method : GET
Description : Lists all of the ordered rules present in a single specified policy.
Apiversion : 2026-10-01-preview
Scopes :
Parameters :
sslPolicy
Required : Yes
Type : string
Location : path
Description : Name of the SSL policy to update. The name must be 1-63 characters long, and comply with 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.
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
Flat Path : projects/{project}/regions/{region}/sslPolicies/{sslPolicy}
Path : projects/{project}/regions/{region}/sslPolicies/{sslPolicy}
Parameter Order :
▼ ▲ compute.machineImages.list
Parameters :
project
Required : Yes
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])?))
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.
Type : string
Location : query
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
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.
Location : query
Type : string
Description : Retrieves a list of machine images that are contained within the specified project.
Flat Path : projects/{project}/global/machineImages
Parameter Order : project
Path : projects/{project}/global/machineImages
Apiversion : 2026-10-01-preview
Scopes :
HTTP Method : GET
▼ ▲ compute.machineImages.get
HTTP Method : GET
Description : Returns the specified machine image.
Apiversion : 2026-10-01-preview
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
machineImage
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
Type : string
Required : Yes
Path : projects/{project}/global/machineImages/{machineImage}
Flat Path : projects/{project}/global/machineImages/{machineImage}
Parameter Order :
▼ ▲ compute.machineImages.setIamPolicy
Parameter Order :
Apiversion : 2026-10-01-preview
Description : Sets the access control policy on the specified resource. Replaces any existing policy.
HTTP Method : POST
Scopes :
Path : projects/{project}/global/machineImages/{resource}/setIamPolicy
Flat Path : projects/{project}/global/machineImages/{resource}/setIamPolicy
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.
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}
▼ ▲ compute.machineImages.testIamPermissions
Path : projects/{project}/global/machineImages/{resource}/testIamPermissions
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
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
Scopes :
HTTP Method : POST
Apiversion : 2026-10-01-preview
Parameter Order :
Description : Returns permissions that a caller has on the specified resource.
Flat Path : projects/{project}/global/machineImages/{resource}/testIamPermissions
▼ ▲ compute.machineImages.insert
Path : projects/{project}/global/machineImages
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
sourceInstance
Description : Required. Source instance that is used to create the machine image from.
Location : query
Type : string
Flat Path : projects/{project}/global/machineImages
Scopes :
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.
Parameter Order : project
Apiversion : 2026-10-01-preview
HTTP Method : POST
▼ ▲ compute.machineImages.delete
Description : Deletes the specified machine image. Deleting a machine image is permanent and cannot be undone.
Path : projects/{project}/global/machineImages/{machineImage}
HTTP Method : DELETE
Apiversion : 2026-10-01-preview
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])?))
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
machineImage
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 machine image to delete.
Location : path
Flat Path : projects/{project}/global/machineImages/{machineImage}
Scopes :
▼ ▲ compute.machineImages.setLabels
Description : Sets the labels on a machine image. To learn more about labels, read theLabeling Resources documentation.
Path : projects/{project}/global/machineImages/{resource}/setLabels
Flat Path : projects/{project}/global/machineImages/{resource}/setLabels
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
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 :
HTTP Method : POST
Apiversion : 2026-10-01-preview
Scopes :
▼ ▲ compute.machineImages.getIamPolicy
Flat Path : projects/{project}/global/machineImages/{resource}/getIamPolicy
Scopes :
Description : Gets the access control policy for a resource. May be empty if no such policy or resource exists.
Parameters :
optionsRequestedPolicyVersion
Description : Requested IAM Policy version.
Location : query
Format : int32
Type : integer
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])?))
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
Parameter Order :
Apiversion : 2026-10-01-preview
HTTP Method : GET
Path : projects/{project}/global/machineImages/{resource}/getIamPolicy
▼ ▲ compute.instanceGroups.addInstances
Flat Path : projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/addInstances
Parameters :
project
Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Location : path
Description : Project ID for this request.
Required : Yes
Type : string
zone
Description : The name of the zone where the instance group is located.
Type : string
Location : path
Required : Yes
instanceGroup
Location : path
Required : Yes
Description : The name of the instance group where you are adding instances.
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
Scopes :
Path : projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/addInstances
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.
Apiversion : 2026-10-01-preview
Parameter Order :
HTTP Method : POST
▼ ▲ compute.instanceGroups.removeInstances
Scopes :
Parameters :
instanceGroup
Location : path
Required : Yes
Description : The name of the instance group where the specified instances will be removed.
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
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
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}/removeInstances
Path : projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/removeInstances
HTTP Method : POST
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.
Parameter Order :
Apiversion : 2026-10-01-preview
▼ ▲ compute.instanceGroups.list
Apiversion : 2026-10-01-preview
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.
Flat Path : projects/{project}/zones/{zone}/instanceGroups
Parameter Order :
Scopes :
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.
zone
Location : path
Required : Yes
Description : The name of thezone where the instance group is located.
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.
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
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
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
Location : query
Default : 500
▼ ▲ compute.instanceGroups.get
HTTP Method : GET
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}
Parameters :
zone
Required : Yes
Location : path
Description : The name of the zone where the instance group is located.
Type : string
instanceGroup
Type : string
Location : path
Required : Yes
Description : The name of the instance group.
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
Path : projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}
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.
Parameter Order :
Scopes :
▼ ▲ compute.instanceGroups.insert
Scopes :
Apiversion : 2026-10-01-preview
HTTP Method : POST
Description : Creates an instance group in the specified project using the parameters that are included in the request.
Parameter Order :
Path : projects/{project}/zones/{zone}/instanceGroups
Flat Path : projects/{project}/zones/{zone}/instanceGroups
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
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])?))
zone
Type : string
Description : The name of the zone where you want to create the instance group.
Required : Yes
Location : path
▼ ▲ compute.instanceGroups.delete
Apiversion : 2026-10-01-preview
Scopes :
HTTP Method : DELETE
Flat 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.
Parameter Order :
Path : projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}
Parameters :
zone
Type : string
Location : path
Required : Yes
Description : The name of the zone where the instance group is located.
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
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).
instanceGroup
Type : string
Location : path
Required : Yes
Description : The name of the instance group to delete.
▼ ▲ compute.instanceGroups.listInstances
Apiversion : 2026-10-01-preview
Scopes :
Parameter Order :
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.
HTTP Method : POST
Path : projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/listInstances
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
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
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
Location : query
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
Location : path
Description : Project ID for this request.
zone
Type : string
Required : Yes
Location : path
Description : The name of the zone where the instance group is located.
instanceGroup
Required : Yes
Description : The name of the instance group from which you want to generate a list of included instances.
Type : string
Location : path
Flat Path : projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/listInstances
▼ ▲ compute.instanceGroups.setNamedPorts
Path : projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/setNamedPorts
Description : Sets the named ports for the specified instance group.
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.
zone
Type : string
Location : path
Required : Yes
Description : The name of the zone where the instance group is located.
instanceGroup
Type : string
Location : path
Required : Yes
Description : The name of the instance group where the named ports are updated.
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}/zones/{zone}/instanceGroups/{instanceGroup}/setNamedPorts
Apiversion : 2026-10-01-preview
HTTP Method : POST
Scopes :
▼ ▲ compute.instanceGroups.testIamPermissions
Parameter Order :
Path : projects/{project}/zones/{zone}/instanceGroups/{resource}/testIamPermissions
Parameters :
resource
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 or id of the resource for this request.
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])?))
Required : Yes
Description : Project ID for this request.
Type : string
Location : path
Scopes :
Apiversion : 2026-10-01-preview
Description : Returns permissions that a caller has on the specified resource.
HTTP Method : POST
Flat Path : projects/{project}/zones/{zone}/instanceGroups/{resource}/testIamPermissions
▼ ▲ compute.instanceGroups.aggregatedList
Apiversion : 2026-10-01-preview
Path : projects/{project}/aggregated/instanceGroups
HTTP Method : GET
Flat Path : projects/{project}/aggregated/instanceGroups
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
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
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
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.
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
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
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
Scopes :
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`.
Parameter Order : project
▼ ▲ compute.globalForwardingRules.setTarget
Scopes :
Parameter Order :
Apiversion : 2026-10-01-preview
HTTP Method : POST
Description : Changes target URL for the GlobalForwardingRule resource. The new target should be of the same type as the old target.
Parameters :
forwardingRule
Location : path
Type : string
Description : Name of the ForwardingRule resource in which target is to be set.
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
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.
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}/global/forwardingRules/{forwardingRule}/setTarget
Flat Path : projects/{project}/global/forwardingRules/{forwardingRule}/setTarget
▼ ▲ compute.globalForwardingRules.get
Parameters :
view
Type : string
Enum Descriptions :
Location : query
Enum :
forwardingRule
Type : string
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}
Required : Yes
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
Required : Yes
Description : Project ID for this request.
Scopes :
Description : Returns the specified GlobalForwardingRule resource. Gets a list of available forwarding rules by making a list() request.
Flat Path : projects/{project}/global/forwardingRules/{forwardingRule}
Parameter Order :
HTTP Method : GET
Path : projects/{project}/global/forwardingRules/{forwardingRule}
Apiversion : 2026-10-01-preview
▼ ▲ compute.globalForwardingRules.insert
Flat Path : projects/{project}/global/forwardingRules
Path : projects/{project}/global/forwardingRules
HTTP Method : POST
Description : Creates a GlobalForwardingRule resource in the specified project using the data included in the request.
Apiversion : 2026-10-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.
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
Scopes :
Parameter Order : project
▼ ▲ compute.globalForwardingRules.delete
Scopes :
HTTP Method : DELETE
Apiversion : 2026-10-01-preview
Description : Deletes the specified GlobalForwardingRule resource.
Path : projects/{project}/global/forwardingRules/{forwardingRule}
Parameter Order :
Flat Path : projects/{project}/global/forwardingRules/{forwardingRule}
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).
forwardingRule
Required : Yes
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 delete.
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
▼ ▲ compute.globalForwardingRules.list
Flat Path : projects/{project}/global/forwardingRules
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.
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
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
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
maxResults
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`)
Type : integer
Default : 500
Path : projects/{project}/global/forwardingRules
HTTP Method : GET
Apiversion : 2026-10-01-preview
Description : Retrieves a list of GlobalForwardingRule resources available to the specified project.
Scopes :
Parameter Order : project
▼ ▲ compute.globalForwardingRules.setLabels
HTTP Method : POST
Description : Sets the labels on the specified resource. To learn more about labels, read the Labeling resources documentation.
Apiversion : 2026-10-01-preview
Path : projects/{project}/global/forwardingRules/{resource}/setLabels
Parameter Order :
Flat Path : projects/{project}/global/forwardingRules/{resource}/setLabels
Scopes :
Parameters :
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.
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
▼ ▲ compute.globalForwardingRules.patch
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
forwardingRule
Type : string
Description : Name of the ForwardingRule resource to patch.
Required : Yes
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).
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.
Path : projects/{project}/global/forwardingRules/{forwardingRule}
Parameter Order :
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/global/forwardingRules/{forwardingRule}
Scopes :
HTTP Method : PATCH
▼ ▲ compute.networkEndpointGroups.aggregatedList
Scopes :
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
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
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
Default : 500
Type : integer
Location : query
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`)
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
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.
Format : int64
Location : query
Type : string
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-10-01-preview
Path : projects/{project}/aggregated/networkEndpointGroups
Parameter Order : project
HTTP Method : GET
▼ ▲ compute.networkEndpointGroups.attachNetworkEndpoints
Apiversion : 2026-10-01-preview
Path : projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints
Description : Attach a list of network endpoints to the specified network endpoint group.
HTTP Method : POST
Flat Path : projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints
Parameter Order :
Scopes :
Parameters :
zone
Description : The name of the zone where the network endpoint group is located. It should comply with RFC1035.
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
networkEndpointGroup
Type : string
Description : The name of the network endpoint group where you are attaching network endpoints to. It should comply with RFC1035.
Required : Yes
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])?))
▼ ▲ compute.networkEndpointGroups.listNetworkEndpoints
Path : projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/listNetworkEndpoints
Parameter Order :
Description : Lists the network endpoints in the specified network endpoint group.
Parameters :
maxResults
Default : 500
Location : query
Type : integer
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`)
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.
Type : string
Location : path
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
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
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
Type : string
Description : The name of the zone where the network endpoint group is located. It should comply with RFC1035.
Required : Yes
Location : path
Scopes :
Apiversion : 2026-10-01-preview
HTTP Method : POST
Flat Path : projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/listNetworkEndpoints
▼ ▲ compute.networkEndpointGroups.testIamPermissions
Scopes :
Parameter Order :
Description : Returns permissions that a caller has on the specified resource.
Parameters :
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
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}
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
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/zones/{zone}/networkEndpointGroups/{resource}/testIamPermissions
HTTP Method : POST
Path : projects/{project}/zones/{zone}/networkEndpointGroups/{resource}/testIamPermissions
▼ ▲ compute.networkEndpointGroups.insert
Parameter Order :
HTTP Method : POST
Apiversion : 2026-10-01-preview
Scopes :
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}/zones/{zone}/networkEndpointGroups
Parameters :
zone
Required : Yes
Description : The name of the zone where you want to create the network endpoint group. It should comply with 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).
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}/zones/{zone}/networkEndpointGroups
▼ ▲ compute.networkEndpointGroups.delete
Scopes :
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
zone
Location : path
Required : Yes
Type : string
Description : The name of the zone where the network endpoint group is located. It should comply with RFC1035.
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
Type : string
Location : path
Description : The name of the network endpoint group to delete. It should comply with RFC1035.
Apiversion : 2026-10-01-preview
HTTP Method : DELETE
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}
Parameter Order :
▼ ▲ compute.networkEndpointGroups.list
Parameter Order :
Description : Retrieves the list of network endpoint groups that are located in the specified project and zone.
Scopes :
Apiversion : 2026-10-01-preview
HTTP Method : GET
Flat Path : projects/{project}/zones/{zone}/networkEndpointGroups
Path : projects/{project}/zones/{zone}/networkEndpointGroups
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
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.
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.
Required : Yes
Type : string
zone
Location : path
Required : Yes
Description : The name of thezone where the network endpoint group is located. It should comply with RFC1035.
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`)
Default : 500
Location : query
Minimum : 0
▼ ▲ compute.networkEndpointGroups.detachNetworkEndpoints
HTTP Method : POST
Apiversion : 2026-10-01-preview
Description : Detach a list of network endpoints from the specified network endpoint group.
Parameter Order :
Path : projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints
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
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
Type : string
Location : path
Required : Yes
Description : The name of the zone where the network endpoint group is located. It should comply with RFC1035.
networkEndpointGroup
Type : string
Description : The name of the network endpoint group where you are removing network endpoints. It should comply with RFC1035.
Required : Yes
Location : path
Flat Path : projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints
▼ ▲ compute.networkEndpointGroups.get
Parameter Order :
HTTP Method : GET
Apiversion : 2026-10-01-preview
Description : Returns the specified network endpoint group.
Scopes :
Path : projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}
Parameters :
zone
Description : The name of the zone where the network endpoint group is located. It should comply with RFC1035.
Type : string
Required : Yes
Location : path
networkEndpointGroup
Location : path
Required : Yes
Description : The name of the network endpoint group. It should comply with RFC1035.
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.
Flat Path : projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}
▼ ▲ compute.publicDelegatedPrefixes.insert
Flat Path : projects/{project}/regions/{region}/publicDelegatedPrefixes
Description : Creates a PublicDelegatedPrefix in the specified project in the given region using the parameters that are included in the request.
Scopes :
Parameter Order :
Parameters :
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Type : string
Required : Yes
Description : Name of the region of 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 : An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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-10-01-preview
HTTP Method : POST
Path : projects/{project}/regions/{region}/publicDelegatedPrefixes
▼ ▲ compute.publicDelegatedPrefixes.delete
Description : Deletes the specified PublicDelegatedPrefix in the given region.
HTTP Method : DELETE
Flat Path : projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix}
Apiversion : 2026-10-01-preview
Path : projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix}
Parameters :
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])?))
publicDelegatedPrefix
Description : Name of the PublicDelegatedPrefix resource to delete.
Type : string
Required : Yes
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location : path
region
Location : path
Description : Name of the region of this request.
Type : string
Required : Yes
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
Parameter Order :
Scopes :
▼ ▲ compute.publicDelegatedPrefixes.list
Apiversion : 2026-10-01-preview
Scopes :
Flat Path : projects/{project}/regions/{region}/publicDelegatedPrefixes
HTTP Method : GET
Description : Lists the PublicDelegatedPrefixes for a project in the given region.
Path : projects/{project}/regions/{region}/publicDelegatedPrefixes
Parameter Order :
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.
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
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
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
region
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Location : path
Required : Yes
Type : string
Description : Name of the region of this request.
▼ ▲ compute.publicDelegatedPrefixes.announce
Flat Path : projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix}/announce
Apiversion : 2026-10-01-preview
HTTP Method : POST
Parameter Order :
Path : projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix}/announce
Parameters :
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
publicDelegatedPrefix
Required : Yes
Location : path
Type : string
Description : The name of the public delegated prefix. It should comply with RFC1035.
region
Location : path
Type : string
Required : Yes
Description : The name of theregion where the public delegated prefix is located. It should comply with RFC1035.
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 : Announces the specified PublicDelegatedPrefix in the given region.
Scopes :
▼ ▲ compute.publicDelegatedPrefixes.patch
Path : projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix}
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
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
publicDelegatedPrefix
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 patch.
Location : path
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
Scopes :
Parameter Order :
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.
Apiversion : 2026-10-01-preview
HTTP Method : PATCH
▼ ▲ compute.publicDelegatedPrefixes.withdraw
HTTP Method : POST
Apiversion : 2026-10-01-preview
Flat Path : projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix}/withdraw
Parameter Order :
Scopes :
Description : Withdraws the specified PublicDelegatedPrefix in the given region.
Path : projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix}/withdraw
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
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).
publicDelegatedPrefix
Required : Yes
Location : path
Type : string
Description : The name of the public delegated prefix. It should comply with RFC1035.
region
Location : path
Required : Yes
Description : The name of theregion where the public delegated prefix is located. It should comply with RFC1035.
Type : string
▼ ▲ compute.publicDelegatedPrefixes.aggregatedList
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
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
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
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
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
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
Flat Path : projects/{project}/aggregated/publicDelegatedPrefixes
Parameter Order : project
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`.
Path : projects/{project}/aggregated/publicDelegatedPrefixes
Scopes :
HTTP Method : GET
Apiversion : 2026-10-01-preview
▼ ▲ compute.publicDelegatedPrefixes.get
Parameter Order :
HTTP Method : GET
Flat Path : projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix}
Apiversion : 2026-10-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
publicDelegatedPrefix
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 return.
Required : Yes
Type : string
region
Location : path
Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
Required : Yes
Type : string
Description : Name of the region of this request.
Description : Returns the specified PublicDelegatedPrefix resource in the given region.
Scopes :
Path : projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix}