REST Resource: snapshots

Resource: Snapshot
- JSON representation
Methods

Resource: Snapshot

Represents a Persistent Disk Snapshot resource.

You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots.

JSON representation
{ "kind": string, "id": string, "creationTimestamp": string, "name": string, "description": string, "status": enum, "sourceDisk": string, "sourceDiskId": string, "diskSizeGb": string, "storageBytes": string, "storageBytesStatus": enum, "licenses": [ string ], "snapshotEncryptionKey": { "rawKey": string, "rsaEncryptedKey": string, "kmsKeyName": string, "sha256": string, "kmsKeyServiceAccount": string }, "sourceDiskEncryptionKey": { "rawKey": string, "rsaEncryptedKey": string, "kmsKeyName": string, "sha256": string, "kmsKeyServiceAccount": string }, "selfLink": string, "labels": { string: string, ... }, "labelFingerprint": string, "licenseCodes": [ string ], "storageLocations": [ string ], "autoCreated": boolean, "guestOsFeatures": [ { "type": enum } ], "downloadBytes": string, "chainName": string, "satisfiesPzs": boolean, "guestFlush": boolean, "locationHint": string, "sourceSnapshotSchedulePolicy": string, "sourceSnapshotSchedulePolicyId": string, "sourceInstantSnapshot": string, "sourceInstantSnapshotId": string, "architecture": enum, "userLicenses": [ string ], "snapshotType": enum, "creationSizeBytes": string, "enableConfidentialCompute": boolean, "sourceDiskForRecoveryCheckpoint": string, "sourceInstantSnapshotEncryptionKey": { "rawKey": string, "rsaEncryptedKey": string, "kmsKeyName": string, "sha256": string, "kmsKeyServiceAccount": string }, "satisfiesPzi": boolean }

JSON representation

{
  "kind": string,
  "id": string,
  "creationTimestamp": string,
  "name": string,
  "description": string,
  "status": enum,
  "sourceDisk": string,
  "sourceDiskId": string,
  "diskSizeGb": string,
  "storageBytes": string,
  "storageBytesStatus": enum,
  "licenses": [
    string
  ],
  "snapshotEncryptionKey": {
    "rawKey": string,
    "rsaEncryptedKey": string,
    "kmsKeyName": string,
    "sha256": string,
    "kmsKeyServiceAccount": string
  },
  "sourceDiskEncryptionKey": {
    "rawKey": string,
    "rsaEncryptedKey": string,
    "kmsKeyName": string,
    "sha256": string,
    "kmsKeyServiceAccount": string
  },
  "selfLink": string,
  "labels": {
    string: string,
    ...
  },
  "labelFingerprint": string,
  "licenseCodes": [
    string
  ],
  "storageLocations": [
    string
  ],
  "autoCreated": boolean,
  "guestOsFeatures": [
    {
      "type": enum
    }
  ],
  "downloadBytes": string,
  "chainName": string,
  "satisfiesPzs": boolean,
  "guestFlush": boolean,
  "locationHint": string,
  "sourceSnapshotSchedulePolicy": string,
  "sourceSnapshotSchedulePolicyId": string,
  "sourceInstantSnapshot": string,
  "sourceInstantSnapshotId": string,
  "architecture": enum,
  "userLicenses": [
    string
  ],
  "snapshotType": enum,
  "creationSizeBytes": string,
  "enableConfidentialCompute": boolean,
  "sourceDiskForRecoveryCheckpoint": string,
  "sourceInstantSnapshotEncryptionKey": {
    "rawKey": string,
    "rsaEncryptedKey": string,
    "kmsKeyName": string,
    "sha256": string,
    "kmsKeyServiceAccount": string
  },
  "satisfiesPzi": boolean
}

Fields
`kind`	`string` [Output Only] Type of the resource. Always `compute#snapshot` for Snapshot resources.
`id`	`string (uint64 format)` [Output Only] The unique identifier for the resource. This identifier is defined by the server.
`creationTimestamp`	`string` [Output Only] Creation timestamp in RFC3339 text format.
`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.
`description`	`string` An optional description of this resource. Provide this property when you create the resource.
`status`	`enum` [Output Only] The status of the snapshot. This can be `CREATING`, `DELETING`, `FAILED`, `READY`, or `UPLOADING`.
`sourceDisk`	`string` The source disk used to create this snapshot.
`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.
`diskSizeGb`	`string (int64 format)` [Output Only] Size of the source disk, specified in GB.
`storageBytes`	`string (int64 format)` [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`	`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.
`licenses[]`	`string` [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).
`snapshotEncryptionKey`	`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 snapshot 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 snapshot. 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. You can provide either the `rawKey` or the `rsaEncryptedKey`. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
`snapshotEncryptionKey.rsaEncryptedKey`	`string` Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the `rawKey` or the `rsaEncryptedKey`. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" 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
`snapshotEncryptionKey.kmsKeyName`	`string` The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/ `kms_project_id`/locations/ `region`/keyRings/ `key_region`/cryptoKeys/`key` The fully-qualifed key name may be returned for resource GET requests. For example: "kmsKeyName": "projects/ `kms_project_id`/locations/ `region`/keyRings/ `key_region`/cryptoKeys/`key` /cryptoKeyVersions/1
`snapshotEncryptionKey.sha256`	`string` [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
`snapshotEncryptionKey.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. For example: "kmsKeyServiceAccount": "`name`@ `projectId`.iam.gserviceaccount.com/
`sourceDiskEncryptionKey`	`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. You can provide either the `rawKey` or the `rsaEncryptedKey`. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
`sourceDiskEncryptionKey.rsaEncryptedKey`	`string` Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the `rawKey` or the `rsaEncryptedKey`. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" 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
`sourceDiskEncryptionKey.kmsKeyName`	`string` The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/ `kms_project_id`/locations/ `region`/keyRings/ `key_region`/cryptoKeys/`key` The fully-qualifed key name may be returned for resource GET requests. For example: "kmsKeyName": "projects/ `kms_project_id`/locations/ `region`/keyRings/ `key_region`/cryptoKeys/`key` /cryptoKeyVersions/1
`sourceDiskEncryptionKey.sha256`	`string` [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
`sourceDiskEncryptionKey.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. For example: "kmsKeyServiceAccount": "`name`@ `projectId`.iam.gserviceaccount.com/
`selfLink`	`string` [Output Only] Server-defined URL for the resource.
`labels`	`map (key: string, value: string)` Labels to apply to this snapshot. These can be later modified by the `setLabels` method. Label values may be empty.
`labelFingerprint`	`string (bytes format)` 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, otherwise the request will fail with error `412 conditionNotMet`. To see the latest fingerprint, make a `get()` request to retrieve a snapshot. A base64-encoded string.
`licenseCodes[]`	`string (int64 format)` [Output Only] Integer license codes indicating which licenses are attached to this snapshot.
`storageLocations[]`	`string` Cloud Storage bucket storage location of the snapshot (regional or multi-regional).
`autoCreated`	`boolean` [Output Only] Set to true if snapshots are automatically created by applying resource policy on the target disk.
`guestOsFeatures[]`	`object` [Output Only] 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.
`guestOsFeatures[].type`	`enum` The ID of a supported feature. To add multiple values, use commas to separate values. Set to one or more of the following values: `VIRTIO_SCSI_MULTIQUEUE` `WINDOWS` `MULTI_IP_SUBNET` `UEFI_COMPATIBLE` `GVNIC` `SEV_CAPABLE` `SUSPEND_RESUME_COMPATIBLE` `SEV_LIVE_MIGRATABLE_V2` `SEV_SNP_CAPABLE` `TDX_CAPABLE` `IDPF` For more information, see Enabling guest operating system features.
`downloadBytes`	`string (int64 format)` [Output Only] Number of bytes downloaded to restore a snapshot to a disk.
`chainName`	`string` Creates the new snapshot in the snapshot chain labeled with the specified name. The chain name must be 1-63 characters long and comply with RFC1035. This is an uncommon option only for advanced service owners who needs to create separate snapshot chains, for example, for chargeback tracking. When you describe your snapshot resource, this field is visible only if it has a non-empty value.
`satisfiesPzs`	`boolean` [Output Only] Reserved for future use.
`guestFlush`	`boolean` [Input Only] Whether to attempt an application consistent snapshot by informing the OS to prepare for the snapshot process.
`locationHint`	`string` An opaque location hint used to place the snapshot close to other resources. This field is for use by internal tools that use the public API.
`sourceSnapshotSchedulePolicy`	`string` [Output Only] URL of the resource policy which created this scheduled snapshot.
`sourceSnapshotSchedulePolicyId`	`string` [Output Only] ID of the resource policy which created this scheduled snapshot.
`sourceInstantSnapshot`	`string` The source instant snapshot used to create this snapshot. 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/instantSnapshots/instantSnapshot` `projects/project/zones/zone/instantSnapshots/instantSnapshot` `zones/zone/instantSnapshots/instantSnapshot`
`sourceInstantSnapshotId`	`string` [Output Only] The unique ID of the instant snapshot used to create this snapshot. This value identifies the exact instant snapshot that was used to create this persistent disk. For example, if you created the persistent disk from an instant snapshot that was later deleted and recreated under the same name, the source instant snapshot ID would identify the exact instant snapshot that was used.
`architecture`	`enum` [Output Only] The architecture of the snapshot. Valid values are ARM64 or X86_64.
`userLicenses[]`	`string` [Output Only] A list of user provided licenses represented by a list of URLs to the license resource.
`snapshotType`	`enum` Indicates the type of the snapshot.
`creationSizeBytes`	`string (int64 format)` [Output Only] Size in bytes of the snapshot at creation time.
`enableConfidentialCompute`	`boolean` Whether this snapshot is created from a confidential compute mode disk. [Output Only]: This field is not set by user, but from source disk.
`sourceDiskForRecoveryCheckpoint`	`string` The source disk whose recovery checkpoint will be used to create this snapshot.
`sourceInstantSnapshotEncryptionKey`	`object` Customer provided encryption key when creating Snapshot from Instant Snapshot.
`sourceInstantSnapshotEncryptionKey.rawKey`	`string` Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the `rawKey` or the `rsaEncryptedKey`. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
`sourceInstantSnapshotEncryptionKey.rsaEncryptedKey`	`string` Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the `rawKey` or the `rsaEncryptedKey`. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" 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
`sourceInstantSnapshotEncryptionKey.kmsKeyName`	`string` The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/ `kms_project_id`/locations/ `region`/keyRings/ `key_region`/cryptoKeys/`key` The fully-qualifed key name may be returned for resource GET requests. For example: "kmsKeyName": "projects/ `kms_project_id`/locations/ `region`/keyRings/ `key_region`/cryptoKeys/`key` /cryptoKeyVersions/1
`sourceInstantSnapshotEncryptionKey.sha256`	`string` [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
`sourceInstantSnapshotEncryptionKey.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. For example: "kmsKeyServiceAccount": "`name`@ `projectId`.iam.gserviceaccount.com/
`satisfiesPzi`	`boolean` Output only. Reserved for future use.

Methods
`delete`	Deletes the specified Snapshot resource.
`get`	Returns the specified Snapshot resource.
`getIamPolicy`	Gets the access control policy for a resource.
`insert`	Creates a snapshot in the specified project using the data included in the request.
`list`	Retrieves the list of Snapshot resources contained within the specified project.
`setIamPolicy`	Sets the access control policy on the specified resource.
`setLabels`	Sets the labels on a snapshot.
`testIamPermissions`	Returns permissions that a caller has on the specified resource.

REST Resource: snapshots

Resource: Snapshot

Methods

`delete`

`get`

`getIamPolicy`

`insert`

`list`

`setIamPolicy`

`setLabels`

`testIamPermissions`