Compute Engine API (compute:v1)

2026-07-27

5 new methods | 2 updated methods

Additions

    Methods
  • compute.hosts.get

      HTTP Method : GET

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/compute
    • https://www.googleapis.com/auth/compute.readonly
    • Description : Retrieves information about the specified host.

      Path : projects/{project}/zones/{zone}/{association}/hosts/{host}

      Flat Path : projects/{project}/zones/{zone}/{association}/hosts/{host}

      Parameters :

        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. 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.

        host

          Location : path

          Required : Yes

          Type : string

          Description : The name of the host, formatted as RFC1035 or a resource ID number.

        zone

          Location : path

          Required : Yes

          Type : string

          Description : The name of the zone for this request, formatted as RFC1035.

        project

          Description : The project ID for this request.

          Location : path

          Required : Yes

          Type : string

      Parameter Order :

    • project
    • zone
    • association
    • host
  • compute.hosts.list

      Parameter Order :

    • project
    • zone
    • association
    • Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/compute
    • https://www.googleapis.com/auth/compute.readonly
    • Description : Retrieves a list of hosts.

      Path : projects/{project}/zones/{zone}/{association}/hosts

      Flat Path : projects/{project}/zones/{zone}/{association}/hosts

      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

        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

        zone

          Type : string

          Location : path

          Required : Yes

          Description : The name of the zone for this request, formatted as RFC1035.

        project

          Description : The project ID for this request.

          Type : string

          Location : path

          Required : Yes

        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

        returnPartialSuccess

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

          Location : query

          Type : boolean

        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

      HTTP Method : GET

  • compute.hosts.getVersion

      HTTP Method : POST

      Parameter Order :

    • project
    • zone
    • association
    • host
    • Flat Path : projects/{project}/zones/{zone}/{association}/hosts/{host}/getVersion

      Parameters :

        host

          Description : The name of the host, formatted as RFC1035 or a resource ID number.

          Location : path

          Required : Yes

          Type : string

        project

          Location : path

          Required : Yes

          Type : string

          Description : Project ID for this request.

        zone

          Type : string

          Location : path

          Required : Yes

          Description : Name of the zone for this request. Zone name should conform to RFC1035.

        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.

          Type : string

          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.

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/compute
    • Description : Allows customers to get SBOM versions of a host.

      Path : projects/{project}/zones/{zone}/{association}/hosts/{host}/getVersion

  • compute.reliabilityRisks.get

      HTTP Method : GET

      Parameter Order :

    • project
    • reliabilityRisk
    • Flat Path : projects/{project}/global/reliabilityRisks/{reliabilityRisk}

      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

        reliabilityRisk

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

      Path : projects/{project}/global/reliabilityRisks/{reliabilityRisk}

      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 ReliabilityRisk resource.

  • compute.reliabilityRisks.list

      HTTP Method : GET

      Path : projects/{project}/global/reliabilityRisks

      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 reliabilityRisks available in the specified project.

      Flat Path : projects/{project}/global/reliabilityRisks

      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

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

          Location : path

          Description : Project ID for this request.

          Type : string

          Required : Yes

        maxResults

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

          Minimum : 0

          Location : query

          Default : 500

          Format : uint32

          Type : integer

        returnPartialSuccess

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

          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

        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 : project

Updates

    Methods
  • compute.instances.delete

      Parameters :

        noGracefulShutdown

          Type : boolean

          Location : query

          Description : If set to true, Graceful Shutdown is skipped.

  • compute.instances.stop

      Parameters :

        noGracefulShutdown

          Type : boolean

          Location : query

          Description : If set to true, Graceful Shutdown is skipped.