Method: instanceTemplates.list

Retrieves a list of instance templates that are contained within the specified project and zone.

HTTP request

GET https://compute.googleapis.com/compute/beta/projects/{project}/global/instanceTemplates

The URL uses Google API HTTP annotation syntax.

Path parameters

Parameters
project

string

Project ID for this request.

Query parameters

Parameters
maxResults

number (uint32 format)

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

string

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

string

Sets a filter {expression} for filtering listed resources. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example-instance, you would use name ne example-instance.

You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

orderBy

string

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.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

A list of instance templates.

JSON representation
{
  "id": string,
  "items": [
    {
      "id": string,
      "creationTimestamp": string,
      "name": string,
      "description": string,
      "properties": {
        "description": string,
        "tags": {
          "items": string,
          "fingerprint": string
        },
        "machineType": string,
        "canIpForward": boolean,
        "networkInterfaces": [
          {
            "network": string,
            "subnetwork": string,
            "networkIP": string,
            "name": string,
            "accessConfigs": {
              "type": enum,
              "name": string,
              "natIP": string,
              "setPublicPtr": boolean,
              "publicPtrDomainName": string,
              "networkTier": enum,
              "kind": string
            },
            "aliasIpRanges": {
              "ipCidrRange": string,
              "subnetworkRangeName": string
            },
            "fingerprint": string,
            "kind": string
          }
        ],
        "disks": [
          {
            "type": enum,
            "mode": enum,
            "source": string,
            "deviceName": string,
            "index": number,
            "boot": boolean,
            "initializeParams": {
              "diskName": string,
              "sourceImage": string,
              "diskSizeGb": string,
              "diskStorageType": enum,
              "diskType": string,
              "sourceImageEncryptionKey": {
                "rawKey": string,
                "rsaEncryptedKey": string,
                "sha256": string
              },
              "labels": {
                string: string,
                ...
              }
            },
            "autoDelete": boolean,
            "licenses": string,
            "interface": enum,
            "guestOsFeatures": {
              "type": enum
            },
            "diskEncryptionKey": {
              "sha256": string,

              
              "rawKey": string,
              "rsaEncryptedKey": string,
              
            },
            "kind": string
          }
        ],
        "metadata": {
          "fingerprint": string,
          "items": {
            "key": string,
            "value": string
          },
          "kind": string
        },
        "serviceAccounts": [
          {
            "email": string,
            "scopes": string
          }
        ],
        "scheduling": {
          "onHostMaintenance": enum,
          "automaticRestart": boolean,
          "preemptible": boolean
        },
        "labels": {
          string: string,
          ...
        },
        "guestAccelerators": [
          {
            "acceleratorType": string,
            "acceleratorCount": number
          }
        ],
        "minCpuPlatform": string
      },
      "selfLink": string,
      "sourceInstance": string,
      "sourceInstanceParams": {
        "diskConfigs": [
          {
            "deviceName": string,
            "instantiateFrom": enum,
            "autoDelete": boolean,
            "customImage": string
          }
        ]
      },
      "kind": string
    }
  ],
  "nextPageToken": string,
  "selfLink": string,
  "warning": {
    "code": enum,
    "message": string,
    "data": {
      "key": string,
      "value": string
    }
  },
  "kind": string,
}
Fields
id

string

[Output Only] Unique identifier for the resource; defined by the server.

items[]

object

A list of InstanceTemplate resources.

items[].id

string (fixed64 format)

[Output Only] A unique identifier for this instance template. The server defines this identifier.

items[].creationTimestamp

string

[Output Only] The creation timestamp for this instance template in RFC3339 text format.

items[].name

string

Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

items[].description

string

An optional description of this resource. Provide this property when you create the resource.

items[].properties

object

The instance properties for this instance template.

items[].properties.description

string

An optional text description for the instances that are created from this instance template.

items[].properties.tags

object

A list of tags to apply to the instances that are created from this template. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. Each tag within the list must comply with RFC1035.

items[].properties.tags.items[]

string

An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.

items[].properties.tags.fingerprint

string (bytes format)

Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.

To see the latest fingerprint, make get() request to the instance.

A base64-encoded string.

items[].properties.machineType

string

The machine type to use for instances that are created from this template.

items[].properties.canIpForward

boolean

Enables instances created based on this template to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify true. If unsure, leave this set to false. See the Enable IP forwarding documentation for more information.

items[].properties.networkInterfaces[]

object

An array of network access configurations for this interface.

items[].properties.networkInterfaces[].network

string

URL of the network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used; if the network is not specified but the subnetwork is specified, the network is inferred.

This field is optional when creating a firewall rule. If not specified when creating a firewall rule, the default network global/networks/default is used.

If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:

items[].properties.networkInterfaces[].subnetwork

string

The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:

items[].properties.networkInterfaces[].networkIP

string

An IPv4 internal network address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.

items[].properties.networkInterfaces[].name

string

[Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc.

items[].properties.networkInterfaces[].accessConfigs[]

object

An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access.

items[].properties.networkInterfaces[].accessConfigs[].type

enum

The type of configuration. The default and only option is ONE_TO_ONE_NAT.

items[].properties.networkInterfaces[].accessConfigs[].name

string

The name of this access configuration. The default and recommended name is External NAT but you can use any arbitrary string you would like. For example, My external IP or Network Access.

items[].properties.networkInterfaces[].accessConfigs[].natIP

string

An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.

items[].properties.networkInterfaces[].accessConfigs[].setPublicPtr

boolean

Specifies whether a public DNS ‘PTR’ record should be created to map the external IP address of the instance to a DNS domain name.

items[].properties.networkInterfaces[].accessConfigs[].publicPtrDomainName

string

The DNS domain name for the public PTR record. This field can only be set when the setPublicPtr field is enabled.

items[].properties.networkInterfaces[].accessConfigs[].networkTier

enum

This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.

If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

If an AccessConfig with a valid external IP address is specified, it must match that of the networkTier associated with the Address resource owning that IP.

items[].properties.networkInterfaces[].accessConfigs[].kind

string

[Output Only] Type of the resource. Always compute#accessConfig for access configs.

items[].properties.networkInterfaces[].aliasIpRanges[]

object

An array of alias IP ranges for this network interface. Can only be specified for network interfaces on subnet-mode networks.

items[].properties.networkInterfaces[].aliasIpRanges[].ipCidrRange

string

The IP CIDR range represented by this alias IP range. This IP CIDR range must belong to the specified subnetwork and cannot contain IP addresses reserved by system or used by other network interfaces. This range may be a single IP address (e.g. 10.2.3.4), a netmask (e.g. /24) or a CIDR format string (e.g. 10.1.2.0/24).

items[].properties.networkInterfaces[].aliasIpRanges[].subnetworkRangeName

string

Optional subnetwork secondary range name specifying the secondary range from which to allocate the IP CIDR range for this alias IP range. If left unspecified, the primary range of the subnetwork will be used.

items[].properties.networkInterfaces[].fingerprint

string (bytes format)

Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface.

A base64-encoded string.

items[].properties.networkInterfaces[].kind

string

[Output Only] Type of the resource. Always compute#networkInterface for network interfaces.

items[].properties.disks[]

object

An array of disks that are associated with the instances that are created from this template.

items[].properties.disks[].type

enum

Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.

items[].properties.disks[].mode

enum

The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.

items[].properties.disks[].source

string

Specifies a valid partial or full URL to an existing Persistent Disk resource. When creating a new instance, one of initializeParams.sourceImage or disks.source is required except for local SSD.

If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks.

Note that for InstanceTemplate, specify the disk name, not the URL for the disk.

items[].properties.disks[].deviceName

string

Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.

If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disks-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.

items[].properties.disks[].index

number

[Output Only] A zero-based index to this disk, where 0 is reserved for the boot disk. If you have many disks attached to an instance, each disk would have a unique index number.

items[].properties.disks[].boot

boolean

Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.

items[].properties.disks[].initializeParams

object

[Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.

This property is mutually exclusive with the source property; you can only define one or the other, but not both.

items[].properties.disks[].initializeParams.diskName

string

Specifies the disk name. If not specified, the default is to use the name of the instance.

items[].properties.disks[].initializeParams.sourceImage

string

The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage or disks.source is required except for local SSD.

To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:

projects/debian-cloud/global/images/family/debian-8

Alternatively, use a specific version of a public operating system image:

projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD

To create a disk with a custom image that you created, specify the image name in the following format:

global/images/my-custom-image

You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:

global/images/family/my-image-family

If the source image is deleted later, this field will not be set.

items[].properties.disks[].initializeParams.diskSizeGb

string (int64 format)

Specifies the size of the disk in base-2 GB.

items[].properties.disks[].initializeParams.diskStorageType
(deprecated)

enum

[Deprecated] Storage type of the disk.

items[].properties.disks[].initializeParams.diskType

string

Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:

https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard

Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:

Note that for InstanceTemplate, this is the name of the disk type, not URL.

items[].properties.disks[].initializeParams.sourceImageEncryptionKey

object

The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.

Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.

items[].properties.disks[].initializeParams.sourceImageEncryptionKey.rawKey

string

Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

items[].properties.disks[].initializeParams.sourceImageEncryptionKey.rsaEncryptedKey

string

Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

The key must meet the following requirements before you can provide it to Compute Engine:

  1. The key is wrapped using a RSA public key certificate provided by Google.
  2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding.
acceleratorTypes.get the RSA public key certificate provided by Google at:
https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

items[].properties.disks[].initializeParams.sourceImageEncryptionKey.sha256

string

[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

items[].properties.disks[].initializeParams.labels

map (key: string, value: string)

Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

items[].properties.disks[].autoDelete

boolean

Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).

items[].properties.disks[].licenses[]

string

[Output Only] Any valid publicly visible licenses.

items[].properties.disks[].interface

enum

Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.

items[].properties.disks[].guestOsFeatures[]

object

A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features