- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization Scopes
- IAM Permissions
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://www.googleapis.com/compute/beta/projects/{project}/global/instanceTemplates
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters | |
|---|---|
project |
Project ID for this request. |
Query parameters
| Parameters | |
|---|---|
requestId |
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 ( |
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": , "machineType": string, "canIpForward": boolean, "networkInterfaces": [ ], "disks": [ ], "metadata": , "serviceAccounts": [ ], "scheduling": , "labels": { object }, "guestAccelerators": [ ], "minCpuPlatform": string, "shieldedVmConfig": , "allocationAffinity": , "shieldedInstanceConfig": , "displayDevice": }, "selfLink": string, "sourceInstance": string, "sourceInstanceParams": { "diskConfigs": [ ] }, "kind": string } |
|
| Fields | |
|---|---|
id |
[Output Only] A unique identifier for this instance template. The server defines this identifier. |
creationTimestamp |
[Output Only] The creation timestamp for this instance template in RFC3339 text format. |
name |
[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 |
description |
An optional description of this resource. Provide this property when you create the resource. |
properties |
The instance properties for this instance template. |
properties.description |
An optional text description for the instances that are created from this instance template. |
properties.tags |
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. |
properties.tags.items[] |
An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035. |
properties.tags.fingerprint |
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 A base64-encoded string. |
properties.machineType |
[REQUIRED] The machine type to use for instances that are created from this template. |
properties.canIpForward |
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 |
properties.networkInterfaces[] |
An array of network access configurations for this interface. |
properties.networkInterfaces[].network |
URL of the network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network This field is optional when creating a firewall rule. If not specified when creating a firewall rule, the default network 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 Google IAM permission on the specified resource
|
properties.networkInterfaces[].subnetwork |
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:
Authorization requires the following Google IAM permission on the specified resource
|
properties.networkInterfaces[].networkIP |
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. |
properties.networkInterfaces[].name |
[Output Only] The name of the network interface, generated by the server. For network devices, these are |
properties.networkInterfaces[].accessConfigs[] |
An array of configurations for this interface. Currently, only one access config, |
properties.networkInterfaces[].accessConfigs[].type |
The type of configuration. The default and only option is |
properties.networkInterfaces[].accessConfigs[].name |
The name of this access configuration. The default and recommended name is |
properties.networkInterfaces[].accessConfigs[].natIP |
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[].setPublicPtr |
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 |
The DNS domain name for the public PTR record. This field can only be set when the setPublicPtr field is enabled. |
properties.networkInterfaces[].accessConfigs[].networkTier |
This signifies the networking tier used for configuring this access configuration and can only take the following values: 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 |
[Output Only] Type of the resource. Always |
properties.networkInterfaces[].aliasIpRanges[] |
An array of alias IP ranges for this network interface. Can only be specified for network interfaces on subnet-mode networks. |
properties.networkInterfaces[].aliasIpRanges[].ipCidrRange |
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. |
properties.networkInterfaces[].aliasIpRanges[].subnetworkRangeName |
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. |
properties.networkInterfaces[].fingerprint |
Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an A base64-encoded string. |
properties.networkInterfaces[].kind |
[Output Only] Type of the resource. Always |
properties.disks[] |
An array of disks that are associated with the instances that are created from this template. |
properties.disks[].type |
Specifies the type of the disk, either |
properties.disks[].mode |
The mode in which to attach this disk, either |
properties.disks[].source |
Specifies a valid partial or full URL to an existing Persistent Disk resource. When creating a new instance, one of 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. |
properties.disks[].deviceName |
Specifies a unique device name of your choice that is reflected into the If not specified, the server chooses a default device name to apply to this disk, in the form |
properties.disks[].index |
[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. |
properties.disks[].boot |
Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem. |
properties.disks[].initializeParams |
[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 |
properties.disks[].initializeParams.diskName |
Specifies the disk name. If not specified, the default is to use the name of the instance. If the disk with the instance name exists already in the given zone/region, a new name will be automatically generated. |
properties.disks[].initializeParams.sourceImage |
The source image to create this disk. When creating a new instance, one of To create a disk with one of the public operating system images, specify the image by its family name. For example, specify
Alternatively, use a specific version of a public operating system image:
To create a disk with a custom image that you created, specify the image name in the following format:
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
If the source image is deleted later, this field will not be set. Authorization requires the following Google IAM permission on the specified resource
|
properties.disks[].initializeParams.diskSizeGb |
Specifies the size of the disk in base-2 GB. |
properties.disks[].initializeParams.diskType |
Specifies the disk type to use to create the instance. If not specified, the default is
Other values include
|
properties.disks[].initializeParams.sourceImageEncryptionKey |
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. |
properties.disks[].initializeParams.sourceImageEncryptionKey.rawKey |
Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. |
properties.disks[].initializeParams.sourceImageEncryptionKey.rsaEncryptedKey |
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:
https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem |
properties.disks[].initializeParams.sourceImageEncryptionKey.kmsKeyName |
The name of the encryption key that is stored in Google Cloud KMS. |
properties.disks[].initializeParams.sourceImageEncryptionKey.sha256 |
[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. |
properties.disks[].initializeParams.labels |
Labels to apply to this disk. These can be later modified by the An object containing a list of |
properties.disks[].initializeParams.description |
An optional description. Provide this property when creating the disk. |
properties.disks[].initializeParams.guestOsFeatures[] |
A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. Guest OS features are applied by merging |
properties.disks[].initializeParams.guestOsFeatures[].type |
The ID of a supported feature. Read Enabling guest operating system features to see a list of available options. |
properties.disks[].autoDelete |
Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance). |
properties.disks[].licenses[] |
[Output Only] Any valid publicly visible licenses. |
properties.disks[].interface |
Specifies the disk interface to use for attaching this disk, which is either |
properties.disks[].guestOsFeatures[] |
A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. |
properties.disks[].guestOsFeatures[].type |
The ID of a supported feature. Read Enabling guest operating system features to see a list of available options. |
properties.disks[].diskEncryptionKey |
Encrypts or decrypts a disk using a customer-supplied encryption key. If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key. If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance. If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later. Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group. |
properties.disks[].diskEncryptionKey.rawKey |
Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. |
properties.disks[].diskEncryptionKey.rsaEncryptedKey |
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:
https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem |
properties.disks[].diskEncryptionKey.kmsKeyName |
The name of the encryption key that is stored in Google Cloud KMS. |
properties.disks[].diskEncryptionKey.sha256 |
[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. |
properties.disks[].kind |
[Output Only] Type of the resource. Always |
properties.metadata |
The metadata key/value pairs to assign to instances that are created from this template. These pairs can consist of custom metadata or predefined keys. See Project and instance metadata for more information. |
properties.metadata.fingerprint |
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, otherwise the request will fail with error To see the latest fingerprint, make a A base64-encoded string. |
properties.metadata.items[] |
Array of key/value pairs. The total size of all keys and values must be less than 512 KB. |
properties.metadata.items[].key |
Key for the metadata entry. Keys must conform to the following regexp: |
properties.metadata.items[].value |
Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 262144 bytes (256 KiB). |
properties.metadata.kind |
[Output Only] Type of the resource. Always |
properties.serviceAccounts[] |
A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from this template. Use metadata queries to obtain the access tokens for these instances. |
properties.serviceAccounts[].email |
Email address of the service account. |
properties.serviceAccounts[].scopes[] |
The list of scopes to be made available for this service account. |
properties.scheduling |
Specifies the scheduling options for the instances that are created from this template. |
properties.scheduling.onHostMaintenance |
Defines the maintenance behavior for this instance. For standard instances, the default behavior is |
properties.scheduling.automaticRestart |
Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to |
properties.scheduling.preemptible |
Defines whether the instance is preemptible. This can only be set during instance creation, it cannot be set or changed after the instance has been created. |
properties.scheduling.nodeAffinities[] |
A set of node affinity and anti-affinity. |
properties.scheduling.nodeAffinities[].key |
Corresponds to the label key of Node resource. |
properties.scheduling.nodeAffinities[].operator |
Defines the operation of node selection. |
properties.scheduling.nodeAffinities[].values[] |
Corresponds to the label values of Node resource. |
properties.labels |
Labels to apply to instances that are created from this template. An object containing a list of |
properties.guestAccelerators[] |
A list of guest accelerator cards' type and count to use for instances created from the instance template. |
properties.guestAccelerators[].acceleratorType |
Full or partial URL of the accelerator type resource to attach to this instance. For example: |
properties.guestAccelerators[].acceleratorCount |
The number of the guest accelerator cards exposed to this instance. |
properties.minCpuPlatform |
Minimum cpu/platform to be used by this instance. The instance may be scheduled on the specified or newer cpu/platform. Applicable values are the friendly names of CPU platforms, such as |
properties.shieldedVmConfig |
Specifies the Shielded VM options for the instances that are created from this template. |
properties.shieldedVmConfig.enableSecureBoot |
Defines whether the instance has Secure Boot enabled. |
properties.shieldedVmConfig.enableVtpm |
Defines whether the instance has the vTPM enabled. |
properties.shieldedVmConfig.enableIntegrityMonitoring |
Defines whether the instance has integrity monitoring enabled. |
properties.allocationAffinity |
The configuration of desired allocations which this Instance could consume capacity from. |
properties.allocationAffinity.consumeAllocationType |
|
properties.allocationAffinity.key |
Corresponds to the label key of allocation resource. |
properties.allocationAffinity.values[] |
Corresponds to the label values of allocation resource. |
properties.shieldedInstanceConfig |
|
properties.shieldedInstanceConfig.enableSecureBoot |
Defines whether the instance has Secure Boot enabled. |
properties.shieldedInstanceConfig.enableVtpm |
Defines whether the instance has the vTPM enabled. |
properties.shieldedInstanceConfig.enableIntegrityMonitoring |
Defines whether the instance has integrity monitoring enabled. |
properties.displayDevice |
Display Device properties to enable support for remote display products like: Teradici, VNC and TeamViewer |
properties.displayDevice.enableDisplay |
Defines whether the instance has Display enabled. |
selfLink |
[Output Only] The URL for this instance template. The server defines this URL. |
sourceInstance |
The source instance used to create the template. You can provide this as a partial or full URL to the resource. For example, the following are valid values:
Authorization requires the following Google IAM permission on the specified resource
|
sourceInstanceParams |
The source instance params to use to create this instance template. |
sourceInstanceParams.diskConfigs[] |
Attached disks configuration. If not provided, defaults are applied: For boot disk and any other R/W disks, new custom images will be created from each disk. For read-only disks, they will be attached in read-only mode. Local SSD disks will be created as blank volumes. |
sourceInstanceParams.diskConfigs[].deviceName |
Specifies the device name of the disk to which the configurations apply to. |
sourceInstanceParams.diskConfigs[].instantiateFrom |
Specifies whether to include the disk and what image to use. Possible values are:
|
sourceInstanceParams.diskConfigs[].autoDelete |
Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance). |
sourceInstanceParams.diskConfigs[].customImage |
The custom source image to be used to restore this disk when instantiating this instance template. |
kind |
[Output Only] The resource type, which is always |
Response body
If successful, the response body contains data with the following structure:
An Operation resource, used to manage asynchronous API requests.
| JSON representation | |
|---|---|
{ "id": string, "creationTimestamp": string, "name": string, "zone": string, "clientOperationId": string, "operationType": string, "targetLink": string, "targetId": string, "status": enum, "statusMessage": string, "user": string, "progress": number, "insertTime": string, "startTime": string, "endTime": string, "error": { "errors": [ { "code": string, "location": string, "message": string } ] }, "warnings": [ { "code": enum, "message": string, "data": [ { "key": string, "value": string } ] } ], "httpErrorStatusCode": number, "httpErrorMessage": string, "selfLink": string, "region": string, "description": string, "kind": string } |
|
| Fields | |
|---|---|
id |
[Output Only] The unique identifier for the resource. This identifier is defined by the server. |
creationTimestamp |
[Deprecated] This field is deprecated. |
name |
[Output Only] Name of the resource. |
zone |
[Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. |
clientOperationId |
[Output Only] The value of |
operationType |
[Output Only] The type of operation, such as |
targetLink |
[Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. |
targetId |
[Output Only] The unique target ID, which identifies a specific incarnation of the target resource. |
status |
[Output Only] The status of the operation, which can be one of the following: |
statusMessage |
[Output Only] An optional textual description of the current status of the operation. |
user |
[Output Only] User who requested the operation, for example: |
progress |
[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 |
[Output Only] The time that this operation was requested. This value is in RFC3339 text format. |
startTime |
[Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. |
endTime |
[Output Only] The time that this operation was completed. This value is in RFC3339 text format. |
error |
[Output Only] If errors are generated during processing of the operation, this field will be populated. |
error.errors[] |
[Output Only] The array of errors encountered while processing this operation. |
error.errors[].code |
[Output Only] The error type identifier for this error. |
error.errors[].location |
[Output Only] Indicates the field in the request that caused the error. This property is optional. |
error.errors[].message |
[Output Only] An optional, human-readable error message. |
warnings[] |
[Output Only] If warning messages are generated during processing of the operation, this field will be populated. |
warnings[].code |
[Output Only] A warning code, if applicable. For example, Compute Engine returns |
warnings[].message |
[Output Only] A human-readable description of the warning code. |
warnings[].data[] |
[Output Only] Metadata about this warning in "data": [ { "key": "scope", "value": "zones/us-east1-d" }
|
warnings[].data[].key |
[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 |
warnings[].data[].value |
[Output Only] A warning data value corresponding to the key. |
httpErrorStatusCode |
[Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a |
httpErrorMessage |
[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as |
selfLink |
[Output Only] Server-defined URL for the resource. |
region |
[Output Only] The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. |
description |
[Output Only] A textual description of the operation, which is set when the operation is created. |
kind |
[Output Only] Type of the resource. Always |
Authorization Scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/computehttps://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
IAM Permissions
In addition to any permissions specified on the fields above, authorization requires one or more of the following Google IAM permissions:
compute.instanceTemplates.create
To find predefined roles that contain those permissions, see Compute Engine IAM Roles.
