Snapshot

A VM snapshot.

uuidstring<uuid>required

namestringrequired

Example: pre-upgrade

instancestring<uuid>nullablerequired

Source instance UUID, or null if unavailable.

createdinteger<int64>required

Unix timestamp when the snapshot was created.

statusintegernullablerequired

Progress code: 0 or null means not started; 190 means creation completed, 191 means downloaded, and 192 means restored. Codes 200–207 indicate progress and 230–239 indicate a failed stage. Use provisioned and failed to determine whether the snapshot is ready to use.

Example: 190

status_descriptionstringrequired

Human-readable progress label, or "Not started" when no label is available. Use the status code and flags for programmatic checks.

Example: Snapshot complete

provisionedbooleanrequired

Whether snapshot creation completed. Check failed as well before use.

failedbooleanrequired

Whether the snapshot has been marked as failed.

size_bytesinteger<int64>nullablerequired

Stored snapshot size in bytes; may be zero or null until creation completes.

disk_size_gbintegerrequired

Source instance disk size in GB when the snapshot was created.

Snapshot

{
  "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "pre-upgrade",
  "instance": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "created": 0,
  "status": 190,
  "status_description": "Snapshot complete",
  "provisioned": true,
  "failed": true,
  "size_bytes": 0,
  "disk_size_gb": 0
}