Snapshots

See the Creating Persistent Disk Snapshots documentation for more information.

For a list of methods for this resource, see the end of this page.

Resource representations

A Persistent Disk snapshot resource.

{
  "kind": "compute#snapshot",
  "id": unsigned long,
  "creationTimestamp": string,
  "name": string,
  "description": string,
  "status": string,
  "sourceDisk": string,
  "sourceDiskId": string,
  "diskSizeGb": long,
  "storageBytes": long,
  "storageBytesStatus": string,
  "licenses": [
    string
  ],
  "snapshotEncryptionKey": {
    "rawKey": string,
    "rsaEncryptedKey": string,
    "sha256": string
  },
  "sourceDiskEncryptionKey": {
    "rawKey": string,
    "rsaEncryptedKey": string,
    "sha256": string
  },
  "selfLink": string,
  "labels": {
    (key): string
  },
  "labelFingerprint": bytes
}
Property name Value Description Notes
creationTimestamp string [Output Only] Creation timestamp in RFC3339 text format.
description string An optional description of this resource. Provide this property when you create the resource.
diskSizeGb long [Output Only] Size of the snapshot, specified in GB.
id unsigned long [Output Only] The unique identifier for the resource. This identifier is defined by the server.
kind string [Output Only] Type of the resource. Always compute#snapshot for Snapshot resources.
labelFingerprint bytes A fingerprint for the labels being applied to this snapshot, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.

To see the latest fingerprint, make a get() request to retrieve a snapshot.
labels object Labels to apply to this snapshot. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
labels.(key) string The key of a label.
licenses[] list [Output Only] A list of public visible licenses that apply to this snapshot. This can be because the original image had licenses attached (such as a Windows image).
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.
snapshotEncryptionKey nested object Encrypts the snapshot using a customer-supplied encryption key.

After you encrypt a snapshot using a customer-supplied key, you must provide the same key if you use the image later For example, you must provide the encryption key when you create a disk from the encrypted snapshot in a future request.

Customer-supplied encryption keys do not protect access to metadata of the disk.

If you do not provide an encryption key when creating the snapshot, then the snapshot will be encrypted using an automatically generated key and you do not need to provide a key to use the snapshot later.
snapshotEncryptionKey.rawKey string Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
snapshotEncryptionKey.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.
Get the RSA public key certificate provided by Google at:
https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
snapshotEncryptionKey.sha256 string [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
sourceDisk string [Output Only] The source disk used to create this snapshot.
sourceDiskEncryptionKey nested object The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.
sourceDiskEncryptionKey.rawKey string Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
sourceDiskEncryptionKey.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.
Get the RSA public key certificate provided by Google at:
https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
sourceDiskEncryptionKey.sha256 string [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
sourceDiskId string [Output Only] The ID value of the disk used to create this snapshot. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given disk name.
status string [Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING.
storageBytes long [Output Only] A size of the storage used by the snapshot. As snapshots share storage, this number is expected to change with snapshot creation/deletion.
storageBytesStatus string [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.

Methods

The following are valid Snapshot resource methods:

delete
Deletes the specified Snapshot resource. Keep in mind that deleting a single snapshot might not necessarily delete all the data on that snapshot. If any data on the snapshot that is marked for deletion is needed for subsequent snapshots, the data will be moved to the next corresponding snapshot.

For more information, see Deleting snaphots.
get
Returns the specified Snapshot resource. Get a list of available snapshots by making a list() request.
list
Retrieves the list of Snapshot resources contained within the specified project.
setLabels
Sets the labels on a snapshot. To learn more about labels, read the Labeling or Tagging Resources documentation.
testIamPermissions
Returns permissions that a caller has on the specified resource.

Monitor your resources on the go

Get the Google Cloud Console app to help you manage your projects.

Send feedback about...

Compute Engine