Compute Engine API (compute:alpha)

2026-05-08

4 new methods | 9 updated methods | 1 removed method

Additions

    Methods
  • compute.rollouts.advance

      HTTP Method : POST

      Path : projects/{project}/global/rollouts/{rollout}/advance

      Flat Path : projects/{project}/global/rollouts/{rollout}/advance

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/compute
    • Description : Advances a Rollout to the next wave, or completes it if no waves remain.

      Parameters :

        project

          Required : Yes

          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])?))

        requestId

          Description : An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. 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

        currentWaveNumber

          Location : query

          Format : int64

          Description : Required. Wave number of the current wave.

          Type : string

        rollout

          Location : path

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

          Required : Yes

          Description : Required. Name of the Rollout resource to advance.

          Type : string

      Parameter Order :

    • project
    • rollout
  • compute.imageViews.list

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

      HTTP Method : GET

      Parameters :

        pageToken

          Location : query

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

          Type : string

        orderBy

          Location : query

          Description : Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use 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

        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

        project

          Required : Yes

          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])?))

        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

          Format : uint32

          Minimum : 0

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

          Type : integer

        region

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

          Location : path

          Required : Yes

          Description : Required. Name of the region for this request.

          Type : string

      Parameter Order :

    • project
    • region
    • Flat Path : projects/{project}/regions/{region}/imageViews

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/compute
    • https://www.googleapis.com/auth/compute.readonly
    • Description : Retrieves the list of global Image resources available to the project by providing a regional context to read the metadata from the Global Clone in the region.

  • compute.imageViews.get

      HTTP Method : GET

      Path : projects/{project}/regions/{region}/imageViews/{resourceId}

      Flat Path : projects/{project}/regions/{region}/imageViews/{resourceId}

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/compute
    • https://www.googleapis.com/auth/compute.readonly
    • Description : Returns the specified global Image resource by providing a regional context to read the metadata from the Global Clone in the region.

      Parameters :

        project

          Required : Yes

          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])?))

        region

          Location : path

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

          Description : Required. Name of the region for this request.

          Type : string

          Required : Yes

        resourceId

          Description : Name of the image resource to return.

          Type : string

          Required : Yes

          Location : path

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

      Parameter Order :

    • project
    • region
    • resourceId
  • compute.projectViews.get

      HTTP Method : GET

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

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

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/compute
    • https://www.googleapis.com/auth/compute.readonly
    • Description : Returns the specified global ProjectViews resource, with a regional context.

      Parameters :

        region

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

          Location : path

          Description : Required. Name of the region for this request. This is part of the URL path.

          Type : string

          Required : Yes

        project

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

          Location : path

          Required : Yes

          Description : Required. Project ID for this request. This is part of the URL path.

          Type : string

      Parameter Order :

    • project
    • region

Updates

    Methods
  • compute.regionInstanceGroupManagers.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

  • compute.regionInstanceGroupManagers.stopInstances

      Parameters :

        noGracefulShutdown

          Location : query

          Description : When set, graceful shutdown is skipped for instance stopping even if it's configured for the instances.

          Default : false

          Type : boolean

  • compute.regionInstanceGroupManagers.recreateInstances

      Parameters :

        noGracefulShutdown

          Description : When set, graceful shutdown is skipped for instance recreation even if it's configured for the instances.

          Default : false

          Type : boolean

          Location : query

  • compute.regionInstanceGroupManagers.delete

      Parameters :

        noGracefulShutdown

          Description : When set, graceful shutdown is skipped for instance deletion even if it's configured for the instances.

          Default : false

          Type : boolean

          Location : query

  • compute.instanceGroupManagers.deleteInstances

      Parameters :

        noGracefulShutdown

          Description : When set, graceful shutdown is skipped for instance deletion even if it's configured for the instances.

          Default : false

          Type : boolean

          Location : query

  • compute.instanceGroupManagers.stopInstances

      Parameters :

        noGracefulShutdown

          Location : query

          Description : When set, graceful shutdown is skipped for instance stopping even if it's configured for the instances.

          Default : false

          Type : boolean

  • compute.instanceGroupManagers.delete

      Parameters :

        noGracefulShutdown

          Description : When set, graceful shutdown is skipped for instance deletion even if it's configured for the instances.

          Default : false

          Type : boolean

          Location : query

  • compute.instanceGroupManagers.recreateInstances

      Parameters :

        noGracefulShutdown

          Location : query

          Description : When set, graceful shutdown is skipped for instance recreation even if it's configured for the instances.

          Default : false

          Type : boolean

  • compute.haControllers.delete

      Parameters :

        force

          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.

          Type : boolean

Deletions

    Methods
  • compute.rollouts.startNextWave

      Path : projects/{project}/global/rollouts/{rollout}/startNextWave

      Flat Path : projects/{project}/global/rollouts/{rollout}/startNextWave

      HTTP Method : POST

      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])?))

          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

        rollout

          Description : Required. Name of the Rollout resource to start next wave.

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

          Location : path

          Required : Yes

          Type : string

        waveNumber

          Description : Required. Wave number of the current wave.

          Location : query

          Type : string

          Format : int64

      Parameter Order :

    • project
    • rollout
    • Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/compute
    • Description : Starts the next wave of a Rollout.