Compute Engine API (compute:preview)

2026-09-27

1 updated method | 8 removed methods

Updates

    Methods
  • ▼ ▲ compute.instances.reset

      Parameters :

        resetMode

          Enum :

        • HARD_RESET
        • POWER_CYCLE
        • RESET_MODE_UNSPECIFIED
        • SOFT_RESET
        • Enum Descriptions :

        • Performs a hard reset on the instance. This immediately restarts the instance without gracefully shutting down the guest operating system.
        • Performs a machine-level power cycle.
        • Default value. Defaults to HARD_RESET.
        • Sends a graceful reset command to the guest operating system (e.g., equivalent to running `sudo reboot`).
        • Description : Mode of reset operation. Defaults to HARD_RESET if not provided.

          Type : string

          Location : query

Deletions

    Methods
  • ▼ ▲ compute.interconnects.setName

      Description : Sets name of an interconnect.

      Parameter Order :

    • project
    • interconnect
    • 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).

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

        interconnect

          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 interconnect to update.

          Location : path

      HTTP Method : POST

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/compute
    • Path : projects/{project}/global/interconnects/{interconnect}/setName

      Flat Path : projects/{project}/global/interconnects/{interconnect}/setName

  • ▼ ▲ compute.acceleratorInterconnects.delete

      Path : projects/{project}/zones/{zone}/acceleratorInterconnects/{acceleratorInterconnect}

      Flat Path : projects/{project}/zones/{zone}/acceleratorInterconnects/{acceleratorInterconnect}

      Description : Deletes the specified accelerator interconnect.

      Parameter Order :

    • project
    • zone
    • acceleratorInterconnect
    • Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/compute
    • Apiversion : 2026-10-01-preview

      Parameters :

        acceleratorInterconnect

          Required : Yes

          Location : path

          Description : The name of the accelerator interconnect to delete. Name should conform to RFC1035.

          Type : string

        zone

          Type : string

          Required : Yes

          Location : path

          Description : The name of thezone where the accelerator interconnect is located. Zone name should conform to RFC1035.

        project

          Required : Yes

          Description : Project ID for this request.

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

          Location : path

          Type : string

        requestId

          Description : An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

          Location : query

          Type : string

      HTTP Method : DELETE

  • ▼ ▲ compute.acceleratorInterconnects.get

      Scopes :

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

    • project
    • zone
    • acceleratorInterconnect
    • Flat Path : projects/{project}/zones/{zone}/acceleratorInterconnects/{acceleratorInterconnect}

      Description : Returns all of the details about the specified accelerator interconnect.

      HTTP Method : GET

      Apiversion : 2026-10-01-preview

      Parameters :

        zone

          Type : string

          Description : The name of thezone where the accelerator interconnect is located. Zone name should conform to RFC1035.

          Location : path

          Required : Yes

        project

          Required : Yes

          Description : Project ID for this request.

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

          Type : string

          Location : path

        acceleratorInterconnect

          Description : The name of the accelerator interconnect. Name should conform to RFC1035.

          Required : Yes

          Type : string

          Location : path

      Path : projects/{project}/zones/{zone}/acceleratorInterconnects/{acceleratorInterconnect}

  • ▼ ▲ compute.acceleratorInterconnects.insert

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

      Scopes :

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

      Description : Creates an accelerator interconnect using the information that you specify in the request.

      Apiversion : 2026-10-01-preview

      Parameters :

        requestId

          Type : string

          Description : An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

          Location : query

        zone

          Type : string

          Location : path

          Description : The name of the zone where you want to create the accelerator interconnect. Zone name should conform to RFC1035.

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

      HTTP Method : POST

      Parameter Order :

    • project
    • zone
  • ▼ ▲ compute.acceleratorInterconnects.list

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

      Scopes :

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

      Apiversion : 2026-10-01-preview

      Parameters :

        maxResults

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

          Minimum : 0

          Type : integer

          Default : 500

          Location : query

          Format : uint32

        pageToken

          Type : string

          Location : query

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

        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

        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.

        zone

          Required : Yes

          Location : path

          Type : string

          Description : The name of thezone where the accelerator interconnect is located. Zone name should conform to RFC1035.

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

      Parameter Order :

    • project
    • zone
    • Description : Retrieves a list of accelerator interconnects that are contained within the specified project and zone.

  • ▼ ▲ compute.acceleratorInterconnects.queryFormability

      HTTP Method : POST

      Apiversion : 2026-10-01-preview

      Parameters :

        zone

          Type : string

          Location : path

          Required : Yes

          Description : The name of thezone where the request is located. Zone name should conform to RFC1035.

        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

          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

          Default : 500

          Minimum : 0

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

          Location : query

          Type : integer

        project

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

        orderBy

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

          Location : query

          Type : string

      Path : projects/{project}/zones/{zone}/acceleratorInterconnects:queryFormability

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/compute
    • Description : Queries hierarchical formability over dense reservations.

      Parameter Order :

    • project
    • zone
    • Flat Path : projects/{project}/zones/{zone}/acceleratorInterconnects:queryFormability

  • ▼ ▲ compute.instances.troubleshoot

      Scopes :

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

    • project
    • zone
    • instance
    • Description : Initiates diagnostic troubleshooting on the specified instance. This operation cannot be cancelled.

      HTTP Method : POST

      Path : projects/{project}/zones/{zone}/instances/{instance}/troubleshoot

      Apiversion : 2026-10-01-preview

      Parameters :

        zone

          Required : Yes

          Description : The name of the zone for this request.

          Type : string

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

          Location : path

        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.

          Required : Yes

          Type : string

          Location : path

        params.endTime

          Type : string

          Description : Input only. Timestamp representing the end of the troubleshooting window in RFC3339 text format. If omitted, defaults to 'now'.

          Location : query

        params.startTime

          Description : Input only. Timestamp representing the beginning of the troubleshooting window in RFC3339 text format. If omitted, defaults to the last 12 hours.

          Location : query

          Type : string

        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.

          Required : Yes

          Location : path

          Type : string

      Flat Path : projects/{project}/zones/{zone}/instances/{instance}/troubleshoot

  • ▼ ▲ compute.acceleratorInterconnectMemberInstances.list

      Path : projects/{project}/zones/{zone}/acceleratorInterconnects/{acceleratorInterconnect}/memberInstances

      Scopes :

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

      Apiversion : 2026-10-01-preview

      Parameters :

        acceleratorInterconnect

          Required : Yes

          Description : Name of the parent AcceleratorInterconnect. The name should conform to RFC1035 or be a resource ID.

          Type : string

          Location : path

        maxResults

          Location : query

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

          Default : 500

          Type : integer

          Format : uint32

          Minimum : 0

        orderBy

          Location : query

          Type : string

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

        filter

          Location : query

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

          Type : string

        zone

          Location : path

          Description : Zone where the AcceleratorInterconnect is located. Zone name should conform to RFC1035.

          Required : Yes

          Type : string

        project

          Type : string

          Location : path

          Required : Yes

          Description : Project ID for the request.

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

      Parameter Order :

    • project
    • zone
    • acceleratorInterconnect
    • Flat Path : projects/{project}/zones/{zone}/acceleratorInterconnects/{acceleratorInterconnect}/memberInstances

      Description : Lists member instances of the AcceleratorInterconnect.