Compute Engine API (compute:alpha)

2026-07-05

11 new methods

Additions

    Methods
  • compute.acceleratorPodControllers.list

      Flat Path : projects/{project}/zones/{zone}/acceleratorPodControllers

      Parameter Order :

    • project
    • zone
    • 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

          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

        returnPartialSuccess

          Location : query

          Description : Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

          Type : boolean

        maxResults

          Type : integer

          Default : 500

          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

        zone

          Location : path

          Required : Yes

          Type : string

        project

          Location : path

          Type : string

          Required : Yes

        filter

          Location : query

          Description : A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based onresource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using GoogleRE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.

          Type : string

      Path : projects/{project}/zones/{zone}/acceleratorPodControllers

      Description : Lists the AcceleratorPodController resources in the specified zone.

      HTTP Method : GET

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/compute
    • https://www.googleapis.com/auth/compute.readonly
  • compute.acceleratorPodControllers.insert

      Flat Path : projects/{project}/zones/{zone}/acceleratorPodControllers

      Parameter Order :

    • project
    • zone
    • Parameters :

        requestId

          Type : string

          Location : query

        zone

          Location : path

          Required : Yes

          Type : string

        project

          Location : path

          Type : string

          Required : Yes

      Path : projects/{project}/zones/{zone}/acceleratorPodControllers

      Description : Inserts a new AcceleratorPodController resource.

      HTTP Method : POST

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/compute
  • compute.acceleratorPodControllers.patch

      Flat Path : projects/{project}/zones/{zone}/acceleratorPodControllers/{resourceId}

      Parameter Order :

    • project
    • zone
    • resourceId
    • Parameters :

        updateMask

          Location : query

          Type : string

          Format : google-fieldmask

        requestId

          Location : query

          Type : string

        project

          Location : path

          Required : Yes

          Type : string

        resourceId

          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

          Required : Yes

          Type : string

      Path : projects/{project}/zones/{zone}/acceleratorPodControllers/{resourceId}

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/compute
    • Description : Patches the specified AcceleratorPodController resource.

      HTTP Method : PATCH

  • compute.acceleratorPodControllers.get

      HTTP Method : GET

      Description : Gets the specified AcceleratorPodController resource.

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/compute
    • https://www.googleapis.com/auth/compute.readonly
    • Path : projects/{project}/zones/{zone}/acceleratorPodControllers/{resourceId}

      Parameters :

        resourceId

          Type : string

          Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}

          Required : Yes

          Location : path

        zone

          Location : path

          Type : string

          Required : Yes

        project

          Type : string

          Required : Yes

          Location : path

      Parameter Order :

    • project
    • zone
    • resourceId
    • Flat Path : projects/{project}/zones/{zone}/acceleratorPodControllers/{resourceId}

  • compute.acceleratorPodControllers.delete

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/compute
    • Description : Deletes the specified AcceleratorPodController resource.

      HTTP Method : DELETE

      Path : projects/{project}/zones/{zone}/acceleratorPodControllers/{resourceId}

      Parameters :

        project

          Type : string

          Required : Yes

          Location : path

        requestId

          Type : string

          Location : query

        resourceId

          Type : string

          Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}

          Required : Yes

          Location : path

        zone

          Required : Yes

          Type : string

          Location : path

      Flat Path : projects/{project}/zones/{zone}/acceleratorPodControllers/{resourceId}

      Parameter Order :

    • project
    • zone
    • resourceId
  • compute.dhcpOptionsConfigs.insert

      Path : projects/{project}/regions/{region}/dhcpOptionsConfigs

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/compute
    • Description : Creates a DhcpOptionsConfig in the specified project in the given location using the parameters that are included in the request.

      HTTP Method : POST

      Flat Path : projects/{project}/regions/{region}/dhcpOptionsConfigs

      Parameter Order :

    • project
    • 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). end_interface: MixerMutationRequestBuilder

          Type : string

        region

          Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?

          Type : string

          Location : path

          Description : Name of the region of this request.

          Required : Yes

        project

          Description : Project ID for this request.

          Required : Yes

          Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

          Type : string

          Location : path

  • compute.dhcpOptionsConfigs.patch

      Path : projects/{project}/regions/{region}/dhcpOptionsConfigs/{dhcpOptionsConfig}

      Description : Patches the specified DhcpOptionsConfig resource with the data included in the request. This method supports PATCH semantics and usesJSON merge patch format and processing rules.

      HTTP Method : PATCH

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/compute
    • Flat Path : projects/{project}/regions/{region}/dhcpOptionsConfigs/{dhcpOptionsConfig}

      Parameter Order :

    • project
    • region
    • dhcpOptionsConfig
    • Parameters :

        dhcpOptionsConfig

          Description : Name of the DhcpOptionsConfig resource to patch.

          Required : Yes

          Location : path

          Type : string

          Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}

        project

          Location : path

          Type : string

          Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

          Description : Project ID for this request.

          Required : Yes

        region

          Description : Name of the region for this request.

          Required : Yes

          Location : path

          Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?

          Type : string

        updateMask

          Type : string

          Format : google-fieldmask

          Description : update_mask indicates fields to be updated as part of this request.

          Location : query

        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

  • compute.dhcpOptionsConfigs.list

      Parameters :

        returnPartialSuccess

          Location : query

          Type : boolean

          Description : Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

        orderBy

          Location : query

          Description : Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.

          Type : string

        pageToken

          Location : query

          Description : Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.

          Type : string

        filter

          Description : A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based onresource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using GoogleRE2 library syntax. The literal value must match the entire field. For example, to filter for 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

          Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-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 of this request.

          Required : Yes

          Location : path

          Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?

          Type : string

        maxResults

          Description : The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)

          Format : uint32

          Minimum : 0

          Type : integer

          Location : query

          Default : 500

      Flat Path : projects/{project}/regions/{region}/dhcpOptionsConfigs

      Parameter Order :

    • project
    • region
    • Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/compute
    • https://www.googleapis.com/auth/compute.readonly
    • Description : Lists the DhcpOptionsConfigs for a project in the given location.

      HTTP Method : GET

      Path : projects/{project}/regions/{region}/dhcpOptionsConfigs

  • compute.dhcpOptionsConfigs.get

      Path : projects/{project}/regions/{region}/dhcpOptionsConfigs/{dhcpOptionsConfig}

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/compute
    • https://www.googleapis.com/auth/compute.readonly
    • HTTP Method : GET

      Description : Returns the specified DhcpOptionsConfig resource in the given location.

      Parameter Order :

    • project
    • region
    • dhcpOptionsConfig
    • Flat Path : projects/{project}/regions/{region}/dhcpOptionsConfigs/{dhcpOptionsConfig}

      Parameters :

        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

          Location : path

          Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-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

        dhcpOptionsConfig

          Description : Name of the DhcpOptionsConfig 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

  • compute.dhcpOptionsConfigs.delete

      Description : Deletes the specified DhcpOptionsConfig in the given location

      HTTP Method : DELETE

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/compute
    • Path : projects/{project}/regions/{region}/dhcpOptionsConfigs/{dhcpOptionsConfig}

      Parameters :

        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

        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

        dhcpOptionsConfig

          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 DhcpOptionsConfig resource to delete.

          Required : Yes

        project

          Location : path

          Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

          Type : string

          Description : Project ID for this request.

          Required : Yes

      Flat Path : projects/{project}/regions/{region}/dhcpOptionsConfigs/{dhcpOptionsConfig}

      Parameter Order :

    • project
    • region
    • dhcpOptionsConfig
  • compute.dhcpOptionsConfigs.testIamPermissions

      Path : projects/{project}/regions/{region}/dhcpOptionsConfigs/{resource}/testIamPermissions

      HTTP Method : POST

      Description : Returns permissions that a caller has on the specified resource.

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/compute
    • https://www.googleapis.com/auth/compute.readonly
    • Parameter Order :

    • project
    • region
    • resource
    • Flat Path : projects/{project}/regions/{region}/dhcpOptionsConfigs/{resource}/testIamPermissions

      Parameters :

        project

          Description : Project ID for this request.

          Required : Yes

          Location : path

          Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

          Type : string

        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

          Description : The name of the region for this request.

          Required : Yes

          Location : path

          Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?

          Type : string