InstanceTemplates: insert

Requires authorization

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



Parameter name Value Description
Path parameters
project string Project ID for this request.


This request requires authorization with at least one of the following scopes (read more about authentication and authorization).


Request body

In the request body, supply an InstanceTemplates resource with the following properties:

Property name Value Description Notes
Required Properties
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.
properties.networkInterfaces[] list An array of network interfaces for this virtual machines.
properties.networkInterfaces[].accessConfigs[] list Array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external Internet access.
properties.networkInterfaces[].accessConfigs[].name string Name of this access configuration.
properties.networkInterfaces[].accessConfigs[].type string Type of configuration. Must be set to ONE_TO_ONE_NAT. 

Acceptable values are:
  • "ONE_TO_ONE_NAT": Configures port-for-port NAT to the internet.
properties.networkInterfaces[].network string The URL of the network resource attached to this interface.
properties.machineType string Name of the machine type resource describing which machine type to use to host the instances created based on this template. Notice this differs from how the machine type is specified in the Compute Engine API, as the machine type name is required for instance templates, whereas the machine type URL is required in the API. For example, n1-standard-1.
properties.disks[] list Array of disks associated with instance created based on this template.
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.
properties.disks[].mode string The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If you are attaching or creating a boot disk, this must be in read-write mode. If you are attaching a non-boot data disk, you can attach the disk to one instance in read-write mode, or attach to multiple instances in read-only mode.

Acceptable values are:
  • "READ_ONLY": Attaches this disk in read-only mode.
  • "READ_WRITE": Attaches this disk in read-write mode.
All virtual machines must have a persistent boot disk. You must provide either a disks[].source property to attach an existing boot disk, or a disks[].initializeParams object to create a new persistent boot disk.
properties.disks[].source string The name (not URL) of an existing persistent disk to use for this template. Specifying this option tells the service to look for an existing persistent disk in the zone that the instance group is deployed.
properties.disks[].initializeParams nested object The initialization parameters that define a new disk for this template.
properties.disks[].initializeParams.sourceImage string The source image used to create this disk. You must define either a sourceImage (which creates a new boot disk) or the source property (which uses an existing boot disk) when creating a virtual machine but cannot define both in your configuration.

You can provide a private (custom) image using the following input, and Compute Engine will use the corresponding image from your project. For example:
Or you can provide an from a publicly-available project. For example, to use a Debian image from the debian-cloud project, make sure to include the project in the URL:
where vYYYYMMDD is the image version. The fully-qualified URL will also work in both cases.
properties.disks[].initializeParams.diskName string Specifies the name of the new disk for this template. By default, the new disk name is the same as the name of the instance.
properties.disks[].initializeParams.diskSizeGb integer Specifies the size of the new disk in this template. The size is specified in base-2 GB.
properties.disks[].initializeParams.diskType string Specifies what disk type to create for the new disk in this template. You can specify pd-standard, pd-ssd, or local-ssd.


If successful, this method returns a response body with the following structure:

  "kind": "compute#operation",
  "id": unsigned long,
  "creationTimestamp": string,
  "name": string,
  "zone": string,
  "clientOperationId": string,
  "operationType": string,
  "targetLink": string,
  "targetId": unsigned long,
  "status": string,
  "statusMessage": string,
  "user": string,
  "progress": integer,
  "insertTime": string,
  "startTime": string,
  "endTime": string,
  "error": {
    "errors": [
        "code": string,
        "location": string,
        "message": string
  "warnings": [
      "code": string,
      "message": string,
      "data": [
          "key": string,
          "value": string
  "httpErrorStatusCode": integer,
  "httpErrorMessage": string,
  "selfLink": string,
  "region": string,
  "description": string
Property name Value Description Notes
kind string [Output Only] Type of the resource. Always compute#operation for Operation resources.
id unsigned long [Output Only] The unique identifier for the resource. This identifier is defined by the server.
creationTimestamp string [Deprecated] This field is deprecated.
name string [Output Only] Name of the resource.
zone string [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations.
clientOperationId string [Output Only] Reserved for future use.
operationType string [Output Only] The type of operation, such as insert, update, or delete, and so on.
targetId unsigned long [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
status string [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
statusMessage string [Output Only] An optional textual description of the current status of the operation.
user string [Output Only] User who requested the operation, for example:
progress integer [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
insertTime string [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
startTime string [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
endTime string [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
error object [Output Only] If errors are generated during processing of the operation, this field will be populated.
error.errors[] list [Output Only] The array of errors encountered while processing this operation.
error.errors[].code string [Output Only] The error type identifier for this error.
error.errors[].location string [Output Only] Indicates the field in the request that caused the error. This property is optional.
error.errors[].message string [Output Only] An optional, human-readable error message.
warnings[] list [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
warnings[].code string [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
warnings[].message string [Output Only] A human-readable description of the warning code.
warnings[].data[] list [Output Only] Metadata about this warning in key: value format. For example:
"data": [ { "key": "scope", "value": "zones/us-east1-d" }
warnings[].data[].key string [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
warnings[].data[].value string [Output Only] A warning data value corresponding to the key.
httpErrorStatusCode integer [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
httpErrorMessage string [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
region string [Output Only] The URL of the region where the operation resides. Only available when performing regional operations.
description string [Output Only] A textual description of the operation, which is set when the operation is created.

Send feedback about...

Compute Engine