Method: instanceTemplates.insert

Creates an instance template in the specified project using the data that is included in the request. If you are creating a new template to update an existing instance group, your new instance template must use the same network or, if applicable, the same subnetwork as the original template.

HTTP request

POST https://compute.googleapis.com/compute/v1/projects/{project}/global/instanceTemplates

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
project

string

Project ID for this request.

Query parameters

Parameters
requestId

string

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

Request body

The request body contains data with the following structure:

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,
            "kmsKeyName": string
            
          },
          "labels": {
            string: string,
            ...
          },
          "sourceSnapshot": string,
          "sourceSnapshotEncryptionKey": {
            "sha256": string,
            "kmsKeyServiceAccount": string,

            
            "rawKey": string,
            "kmsKeyName": string
            
          },
          "description": string,
          "resourcePolicies": [
            string
          ],
          "onUpdateAction": enum,
          "provisionedIops": string
        },
        "autoDelete": boolean,
        "licenses": [
          string
        ],
        "interface": enum,
        "guestOsFeatures": [
          {
            "type": enum
          }
        ],
        "diskEncryptionKey": {
          "rawKey": 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

[REQUIRED] 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

[REQUIRED] 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.

properties.networkInterfaces[]

object

An array of network access configurations for this interface.

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.

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

Authorization requires the following IAM permission on the specified resource network:

  • compute.networks.get
properties.networkInterfaces[].subnetwork

string

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

Authorization requires the following IAM permission on the specified resource subnetwork:

  • compute.subnetworks.get
properties.networkInterfaces[].networkIP

string

An IPv4 internal IP 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.

properties.networkInterfaces[].ipv6Address

string

[Output Only] An IPv6 internal network address for this network interface.

properties.networkInterfaces[].name

string

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

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.

properties.networkInterfaces[].accessConfigs[].type

enum

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

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, such as My external IP or Network Access.

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.

properties.networkInterfaces[].accessConfigs[].externalIpv6

string

[Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically.

properties.networkInterfaces[].accessConfigs[].externalIpv6PrefixLength

integer

[Output Only] The prefix length of the external IPv6 range.

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.

properties.networkInterfaces[].accessConfigs[].publicPtrDomainName

string

The DNS domain name for the public PTR record. You can set this field only if the setPublicPtr field is enabled.

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.

properties.networkInterfaces[].accessConfigs[].kind

string

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

properties.networkInterfaces[].ipv6AccessConfigs[]

object

An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access.

properties.networkInterfaces[].ipv6AccessConfigs[].type

enum

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

properties.networkInterfaces[].ipv6AccessConfigs[].name

string

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

properties.networkInterfaces[].ipv6AccessConfigs[].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.

properties.networkInterfaces[].ipv6AccessConfigs[].externalIpv6

string

[Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically.

properties.networkInterfaces[].ipv6AccessConfigs[].externalIpv6PrefixLength

integer

[Output Only] The prefix length of the external IPv6 range.

properties.networkInterfaces[].ipv6AccessConfigs[].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.

properties.networkInterfaces[].ipv6AccessConfigs[].publicPtrDomainName

string

The DNS domain name for the public PTR record. You can set this field only if the setPublicPtr field is enabled.

properties.networkInterfaces[].ipv6AccessConfigs[].networkTier