Method: machineImages.insert

HTTP request
Path parameters
Query parameters
Request body
- JSON representation
Response body
- JSON representation
  - JSON representation
  - JSON representation
Authorization Scopes
IAM Permissions

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

Parameters
`project`	`string` Project ID for this request.

project

string

Project ID for this request.

Query parameters

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 Google IAM permission on the specified resource `sourceInstance`: `compute.instances.useReadOnly`

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 Google 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, "setPublicPtr": boolean, "publicPtrDomainName": string, "networkTier": enum, "kind": string } ], "aliasIpRanges": [ { "ipCidrRange": string, "subnetworkRangeName": string } ], "fingerprint": string, "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 }, "labels": { object }, "guestAccelerators": [ { "acceleratorType": string, "acceleratorCount": integer } ], "minCpuPlatform": string, "deletionProtection": boolean }, "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, "kind": string }

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,
            "setPublicPtr": boolean,
            "publicPtrDomainName": string,
            "networkTier": enum,
            "kind": string
          }
        ],
        "aliasIpRanges": [
          {
            "ipCidrRange": string,
            "subnetworkRangeName": string
          }
        ],
        "fingerprint": string,
        "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
    },
    "labels": {
      object
    },
    "guestAccelerators": [
      {
        "acceleratorType": string,
        "acceleratorCount": integer
      }
    ],
    "minCpuPlatform": string,
    "deletionProtection": boolean
  },
  "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,
  "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.
`selfLink`	`string` [Output Only] The URL for this machine image. The server defines this URL.
`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: `https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance` `projects/project/zones/zone/instances/instance` Authorization requires the following Google 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: `https://www.googleapis.com/compute/v1/projects/project/global/networks/network` `projects/project/global/networks/network` `global/networks/default`
`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: `https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork` `regions/region/subnetworks/subnetwork`
`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[].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[].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`, otherwise the request will fail with error `412 conditionNotMet`. A base64-encoded string.
`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: The key is wrapped using a RSA public key certificate provided by Google. 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, it cannot be set or changed after the instance has been created.
`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.labels`	`map (key: string, value: string)` Labels to apply to instances that are created from this machine image. An object containing a list of `"key": value` pairs. Example: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`.
`sourceInstanceProperties.guestAccelerators[]`	`object` A list of guest accelerator cards' type and count to use for instances created from this machine image.
`sourceInstanceProperties.guestAccelerators[].acceleratorType`	`string` Full or partial URL of the accelerator type resource to attach to this instance. For example: `projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100` If you are creating an instance template, specify only the accelerator name. See GPUs on Compute Engine for a full list of accelerator types.
`sourceInstanceProperties.guestAccelerators[].acceleratorCount`	`integer` The number of the guest accelerator cards exposed to this instance.
`sourceInstanceProperties.minCpuPlatform`	`string` Minimum cpu/platform to be used by instances created from this machine image. The instance may be scheduled on the specified or newer cpu/platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read Specifying a Minimum CPU Platform.
`sourceInstanceProperties.deletionProtection`	`boolean` Whether the instance created from this machine image should be protected against deletion.
`storageLocations[]`	`string` GCS bucket storage location of the machine image (regional or multi-regional).
`machineImageEncryptionKey`	`object` Encrypts the machine image using a customer-supplied encryption key. After you encrypt a machine image using a customer-supplied key, you must provide the same key if you use the machine image later. For example, you must provide the encryption key when you create an instance from the encrypted machine image in a future request. Customer-supplied encryption keys do not protect access to metadata of the machine image. If you do not provide an encryption key when creating the machine image, then the machine image will be encrypted using an automatically generated key and you do not need to provide a key to use the machine image later.
`machineImageEncryptionKey.rawKey`	`string` Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
`machineImageEncryptionKey.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: The key is wrapped using a RSA public key certificate provided by Google. 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
`machineImageEncryptionKey.kmsKeyName`	`string` The name of the encryption key that is stored in Google Cloud KMS.
`machineImageEncryptionKey.sha256`	`string` [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
`machineImageEncryptionKey.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.
`guestFlush`	`boolean` [Input Only] Specifies to create an application consistent machine image by informing the OS to prepare for the snapshot process. Currently only supported on Windows instances using the Volume Shadow Copy Service (VSS).
`sourceDiskEncryptionKeys[]`	`object` [Input Only] The customer-supplied encryption key of the disks attached to the source instance. Required if the source disk is protected by a customer-supplied encryption key.
`sourceDiskEncryptionKeys[].sourceDisk`	`string` URL of the disk attached to the source instance. This can be a full or valid partial URL. For example, the following are valid values: `https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk` `projects/project/zones/zone/disks/disk` `zones/zone/disks/disk`
`sourceDiskEncryptionKeys[].diskEncryptionKey`	`object` The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.
`sourceDiskEncryptionKeys[].diskEncryptionKey.rawKey`	`string` Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
`sourceDiskEncryptionKeys[].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: The key is wrapped using a RSA public key certificate provided by Google. 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
`sourceDiskEncryptionKeys[].diskEncryptionKey.kmsKeyName`	`string` The name of the encryption key that is stored in Google Cloud KMS.
`sourceDiskEncryptionKeys[].diskEncryptionKey.sha256`	`string` [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
`sourceDiskEncryptionKeys[].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.
`totalStorageBytes`	`string (int64 format)` [Output Only] Total size of the storage used by the machine image.
`kind`	`string` [Output Only] The resource type, which is always `compute#machineImage` for machine image.

Response body

If successful, the response body contains data with the following structure:

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": integer, "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": integer, "httpErrorMessage": string, "selfLink": string, "region": string, "description": string, "kind": string }

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": integer,
  "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": integer,
  "httpErrorMessage": string,
  "selfLink": string,
  "region": string,
  "description": string,
  "kind": string
}

Fields
`id`	`string (fixed64 format)` [Output Only] The unique identifier for the operation. This identifier is defined by the server.
`creationTimestamp`	`string` [Deprecated] This field is deprecated.
`name`	`string` [Output Only] Name of the operation.
`zone`	`string` [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
`clientOperationId`	`string` [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
`operationType`	`string` [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
`targetLink`	`string` [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`	`string (fixed64 format)` [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
`status`	`enum` [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: `user@example.com`.
`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[]`	`object` [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[]`	`object` [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
`warnings[].code`	`enum` [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[]`	`object` [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`.
`selfLink`	`string` [Output Only] Server-defined URL for the resource.
`region`	`string` [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
`description`	`string` [Output Only] A textual description of the operation, which is set when the operation is created.
`kind`	`string` [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

Authorization Scopes

Requires one of the following OAuth scopes:

https://www.googleapis.com/auth/compute
https://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.disks.createSnapshot
compute.machineImages.create

To find predefined roles that contain those permissions, see Compute Engine IAM Roles.