Method: machineImages.insert

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

HTTP request

POST https://compute.googleapis.com/compute/beta/projects/{project}/global/machineImages

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

sourceInstance

string

Required. Source instance that is used to create the machine image from.

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

  • compute.instances.useReadOnly

Request body

The request body contains data with the following structure:

JSON representation
{
  "id": string,
  "creationTimestamp": string,
  "name": string,
  "description": string,
  "selfLink": string,
  "sourceInstance": string,
  "status": enum,
  "sourceInstanceProperties": {
    "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,
        "nicType": enum,
        "kind": string
      }
    ],
    "disks": [
      {
        "type": enum,
        "mode": enum,
        "source": string,
        "deviceName": string,
        "index": integer,
        "boot": boolean,
        "autoDelete": boolean,
        "licenses": [
          string
        ],
        "interface": enum,
        "guestOsFeatures": [
          {
            "type": enum
          }
        ],
        "diskEncryptionKey": {
          "rawKey": string,
          "rsaEncryptedKey": string,
          "kmsKeyName": string,
          "sha256": string,
          "kmsKeyServiceAccount": string
        },
        "diskSizeGb": string,
        "storageBytes": string,
        "storageBytesStatus": enum,
        "diskType": 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,
      "nodeAffinities": [
        {
          "key": string,
          "operator": enum,
          "values": [
            string
          ]
        }
      ],
      "minNodeCpus": integer,
      "locationHint": string,
      "maintenanceFreezeDurationHours": integer,
      "maintenanceInterval": enum,
      "hostErrorTimeoutSeconds": integer
    },
    "labels": {
      string: string,
      ...
    },
    "guestAccelerators": [
      {
        "acceleratorType": string,
        "acceleratorCount": integer
      }
    ],
    "minCpuPlatform": string,
    "deletionProtection": boolean,
    "postKeyRevocationActionType": enum
  },
  "storageLocations": [
    string
  ],
  "machineImageEncryptionKey": {
    "rawKey": string,
    "rsaEncryptedKey": string,
    "kmsKeyName": string,
    "sha256": string,
    "kmsKeyServiceAccount": string
  },
  "guestFlush": boolean,
  "sourceDiskEncryptionKeys": [
    {
      "sourceDisk": string,
      "diskEncryptionKey": {
        "sha256": string,
        "kmsKeyServiceAccount": string,

        
        "rawKey": string,
        "rsaEncryptedKey": string,
        "kmsKeyName": string
        
      }
    }
  ],
  "totalStorageBytes": string,
  "satisfiesPzs": boolean,
  "kind": string
}
Fields
id

string (fixed64 format)

[Output Only] A unique identifier for this machine image. The server defines this identifier.

creationTimestamp

string

[Output Only] The creation timestamp for this machine image 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.

sourceInstance

string

The source instance used to create the machine image. You can provide this as a partial or full URL to the resource. For example, the following are valid values:

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

  • compute.instances.useReadOnly
status

enum

[Output Only] The status of the machine image. One of the following values: INVALID, CREATING, READY, DELETING, and UPLOADING.

sourceInstanceProperties

object

[Output Only] Properties of source instance.

sourceInstanceProperties.description

string

An optional text description for the instances that are created from this machine image.

sourceInstanceProperties.tags

object

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

sourceInstanceProperties.tags.items[]

string

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

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

sourceInstanceProperties.machineType

string

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

sourceInstanceProperties.canIpForward

boolean

Enables instances created based on this machine image 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.

sourceInstanceProperties.networkInterfaces[]

object

An array of network access configurations for this interface.

sourceInstanceProperties.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:

sourceInstanceProperties.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:

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

sourceInstanceProperties.networkInterfaces[].ipv6Address

string

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

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

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

sourceInstanceProperties.networkInterfaces[].accessConfigs[].type

enum

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

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

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

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

sourceInstanceProperties.networkInterfaces[].accessConfigs[].externalIpv6PrefixLength

integer

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

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

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

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

sourceInstanceProperties.networkInterfaces[].accessConfigs[].kind

string

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

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

sourceInstanceProperties.networkInterfaces[].ipv6AccessConfigs[].type

enum

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

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

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

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

sourceInstanceProperties.networkInterfaces[].ipv6AccessConfigs[].externalIpv6PrefixLength

integer

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

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

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

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

sourceInstanceProperties.networkInterfaces[].ipv6AccessConfigs[].kind

string

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

sourceInstanceProperties.networkInterfaces[].aliasIpRanges[]

object

An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.

sourceInstanceProperties.networkInterfaces[].aliasIpRanges[].ipCidrRange

string

The IP alias ranges to allocate for this interface. 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 (such as 10.2.3.4), a netmask (such as /24) or a CIDR-formatted string (such as 10.1.2.0/24).

sourceInstanceProperties.networkInterfaces[].aliasIpRanges[].subnetworkRangeName

string

The name of a subnetwork secondary IP range from which to allocate an IP alias range. If not specified, the primary range of the subnetwork is used.

sourceInstanceProperties.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. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date.

A base64-encoded string.

sourceInstanceProperties.networkInterfaces[].stackType

enum

The stack type for this network interface to identify whether the IPv6 feature is enabled or not. If not specified, IPV4_ONLY will be used.

This field can be both set at instance creation and update network interface operations.

sourceInstanceProperties.networkInterfaces[].ipv6AccessType

enum

[Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork.

Valid only if stackType is IPV4_IPV6.

sourceInstanceProperties.networkInterfaces[].nicType

enum

The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.

sourceInstanceProperties.networkInterfaces[].kind

string

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

sourceInstanceProperties.disks[]

object

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

sourceInstanceProperties.disks[].type

enum

Specifies the type of the attached disk, either SCRATCH or PERSISTENT.

sourceInstanceProperties.disks[].mode

enum

The mode in which this disk is attached to the source instance, either READ_WRITE or READ_ONLY.

sourceInstanceProperties.disks[].source

string

Specifies a URL of the disk attached to the source instance.

sourceInstanceProperties.disks[].deviceName

string

Specifies the name of the disk attached to the source instance.

sourceInstanceProperties.disks[].index

integer

Specifies zero-based index of the disk that is attached to the source instance.

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

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

sourceInstanceProperties.disks[].licenses[]

string

[Output Only] Any valid publicly visible licenses.

sourceInstanceProperties.disks[].interface

enum

Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME.

sourceInstanceProperties.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 to see a list of available options.

sourceInstanceProperties.disks[].guestOsFeatures[].type

enum

The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.

sourceInstanceProperties.disks[].diskEncryptionKey

object

The encryption key for the disk.

sourceInstanceProperties.disks[].diskEncryptionKey.rawKey

string

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

sourceInstanceProperties.disks[].diskEncryptionKey.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.
Gets the RSA public key certificate provided by Google at:
https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

sourceInstanceProperties.disks[].diskEncryptionKey.kmsKeyName

string

The name of the encryption key that is stored in Google Cloud KMS.

sourceInstanceProperties.disks[].diskEncryptionKey.sha256

string

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

sourceInstanceProperties.disks[].diskEncryptionKey.kmsKeyServiceAccount

string

The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.

sourceInstanceProperties.disks[].diskSizeGb

string (int64 format)

The size of the disk in base-2 GB.

sourceInstanceProperties.disks[].storageBytes

string (int64 format)

[Output Only] A size of the storage used by the disk's snapshot by this machine image.

sourceInstanceProperties.disks[].storageBytesStatus

enum

[Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date.

sourceInstanceProperties.disks[].diskType

string

[Output Only] URL of the disk type resource. For example: projects/project/zones/zone/diskTypes/pd-standard or pd-ssd

sourceInstanceProperties.disks[].kind

string

[Output Only] Type of the resource. Always compute#attachedDisk for attached disks.

sourceInstanceProperties.metadata

object

The metadata key/value pairs to assign to instances that are created from this machine image. These pairs can consist of custom metadata or predefined keys. See Project and instance metadata for more information.

sourceInstanceProperties.metadata.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, otherwise the request will fail with error 412 conditionNotMet.

To see the latest fingerprint, make a get() request to retrieve the resource.

A base64-encoded string.

sourceInstanceProperties.metadata.items[]

object

Array of key/value pairs. The total size of all keys and values must be less than 512 KB.

sourceInstanceProperties.metadata.items[].key

string

Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.

sourceInstanceProperties.metadata.items[].value

string

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

sourceInstanceProperties.metadata.kind

string

[Output Only] Type of the resource. Always compute#metadata for metadata.

sourceInstanceProperties.serviceAccounts[]

object

A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from this machine image. Use metadata queries to obtain the access tokens for these instances.

sourceInstanceProperties.serviceAccounts[].email

string

Email address of the service account.

sourceInstanceProperties.serviceAccounts[].scopes[]

string

The list of scopes to be made available for this service account.

sourceInstanceProperties.scheduling

object

Specifies the scheduling options for the instances that are created from this machine image.

sourceInstanceProperties.scheduling.onHostMaintenance

enum

Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.

sourceInstanceProperties.scheduling.automaticRestart

boolean

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 true so an instance is automatically restarted if it is terminated by Compute Engine.

sourceInstanceProperties.scheduling.preemptible

boolean

Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a TERMINATED state. See Instance Life Cycle for more information on the possible instance states.

sourceInstanceProperties.scheduling.nodeAffinities[]

object

A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.

sourceInstanceProperties.scheduling.nodeAffinities[].key

string

Corresponds to the label key of Node resource.

sourceInstanceProperties.scheduling.nodeAffinities[].operator

enum

Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.

sourceInstanceProperties.scheduling.nodeAffinities[].values[]

string

Corresponds to the label values of Node resource.

sourceInstanceProperties.scheduling.minNodeCpus

integer

The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.

sourceInstanceProperties.scheduling.locationHint

string

An opaque location hint used to place the instance close to other resources. This field is for use by internal tools that use the public API.

sourceInstanceProperties.scheduling.maintenanceFreezeDurationHours

integer

Specifies the number of hours after VM instance creation where the VM won't be scheduled for maintenance.

sourceInstanceProperties.scheduling.maintenanceInterval

enum

For more information about maintenance intervals, see Setting maintenance intervals.

sourceInstanceProperties.scheduling.hostErrorTimeoutSeconds

integer

Specify the time in seconds for host error detection, the value must be within the range of [90, 330] with the increment of 30, if unset, the default behavior of host error recovery will be used.

sourceInstanceProperties.labels

map (key: string, value: string)

Labels to apply to instances that are created from this machine image.

An obje