REST Resource: instanceTemplates

Resource: InstanceTemplate

Represents an Instance Template resource.

You can use instance templates to create VM instances and managed instance groups. For more information, read Instance Templates.

JSON representation
{
  "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,
        "ipv6Address": string,
        "name": string,
        "accessConfigs": [
          {
            "type": enum,
            "name": string,
            "natIP": string,
            "externalIpv6": string,
            "externalIpv6PrefixLength": integer,
            "setPublicPtr": boolean,
            "publicPtrDomainName": string,
            "networkTier": enum,
            "kind": string
          }
        ],
        "ipv6AccessConfigs": [
          {
            "type": enum,
            "name": string,
            "natIP": string,
            "externalIpv6": string,
            "externalIpv6PrefixLength": integer,
            "setPublicPtr": boolean,
            "publicPtrDomainName": string,
            "networkTier": enum,
            "kind": string
          }
        ],
        "aliasIpRanges": [
          {
            "ipCidrRange": string,
            "subnetworkRangeName": string
          }
        ],
        "fingerprint": string,
        "stackType": enum,
        "ipv6AccessType": enum,
        "queueCount": integer,
        "nicType": enum,
        "kind": string
      }
    ],
    "disks": [
      {
        "type": enum,
        "mode": enum,
        "source": string,
        "deviceName": string,
        "index": integer,
        "boot": boolean,
        "initializeParams": {
          "diskName": string,
          "sourceImage": string,
          "diskSizeGb": string,
          "diskType": string,
          "sourceImageEncryptionKey": {
            "sha256": string,
            "kmsKeyServiceAccount": string,

            
            "rawKey": string,
            "rsaEncryptedKey": string,
            "kmsKeyName": string
            
          },
          "labels": {
            string: string,
            ...
          },
          "sourceSnapshot": string,
          "sourceSnapshotEncryptionKey": {
            "sha256": string,
            "kmsKeyServiceAccount": string,

            
            "rawKey": string,
            "rsaEncryptedKey": string,
            "kmsKeyName": string
            
          },
          "description": string,
          "resourcePolicies": [
            string
          ],
          "onUpdateAction": enum,
          "provisionedIops": string
        },
        "autoDelete": boolean,
        "licenses": [
          string
        ],
        "interface": enum,
        "guestOsFeatures": [
          {
            "type": enum
          }
        ],
        "diskEncryptionKey": {
          "rawKey": string,
          "rsaEncryptedKey": string,
          "kmsKeyName": string,
          "sha256": string,
          "kmsKeyServiceAccount": string
        },
        "diskSizeGb": string,
        "shieldedInstanceInitialState": {
          "pk": {
            "content": string,
            "fileType": enum
          },
          "keks": [
            {
              "content": string,
              "fileType": enum
            }
          ],
          "dbs": [
            {
              "content": string,
              "fileType": enum
            }
          ],
          "dbxs": [
            {
              "content": string,
              "fileType": enum
            }
          ]
        },
        "kind": string
      }
    ],
    "metadata": {
      "fingerprint": string,
      "items": [
        {
          "key": string,
          "value": string
        }
      ],
      "kind": string
    },
    "serviceAccounts": [
      {
        "email": string,
        "scopes": [
          string
        ]
      }
    ],
    "scheduling": {
      "onHostMaintenance": enum,
      "automaticRestart": boolean,
      "preemptible": boolean,
      "nodeAffinities": [
        {
          "key": string,
          "operator": enum,
          "values": [
            string
          ]
        }
      ],
      "minNodeCpus": integer,
      "locationHint": string
    },
    "labels": {
      string: string,
      ...
    },
    "guestAccelerators": [
      {
        "acceleratorType": string,
        "acceleratorCount": integer
      }
    ],
    "minCpuPlatform": string,
    "reservationAffinity": {
      "consumeReservationType": enum,
      "key": string,
      "values": [
        string
      ]
    },
    "shieldedInstanceConfig": {
      "enableSecureBoot": boolean,
      "enableVtpm": boolean,
      "enableIntegrityMonitoring": boolean
    },
    "resourcePolicies": [
      string
    ],
    "confidentialInstanceConfig": {
      "enableConfidentialCompute": boolean
    },
    "privateIpv6GoogleAccess": enum,
    "advancedMachineFeatures": {
      "enableNestedVirtualization": boolean,
      "threadsPerCore": integer
    }
  },
  "selfLink": string,
  "sourceInstance": string,
  "sourceInstanceParams": {
    "diskConfigs": [
      {
        "deviceName": string,
        "instantiateFrom": enum,
        "autoDelete": boolean,
        "customImage": string
      }
    ]
  },
  "kind": string
}
Fields
id

string (fixed64 format)

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

creationTimestamp

string

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

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.

description

string

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

properties

object

The instance properties for this instance template.

properties.description

string

An optional text description for the instances that are created from these properties.

properties.tags

object

A list of tags to apply to the instances that are created from these properties. 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.

properties.tags.items[]

string

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

properties.tags.fingerprint

string (bytes format)

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

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

A base64-encoded string.

properties.machineType

string

The machine type to use for instances that are created from these properties.

properties.canIpForward

boolean

Enables instances created based on these properties 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.