Skip to main content

SnapshotRetrieve

statusboolean

Whether the request succeeded.

Example: 200
messagestring

Human-readable description of the result.

Example: Retrieved snapshot 1783
snapshot object

Snapshot of a volume.

created_atstring<date-time>

ISO 8601 UTC timestamp marking when the snapshot was created.

Example: 2026-05-06T16:04:09Z
descriptionstring

Description of the snapshot.

Example: example
idinteger

Unique numeric identifier for the snapshot.

Example: 1402
is_imageboolean

Whether the snapshot is intended to be used as an image.

Example: true
namestring

Name of the snapshot.

Example: example-snapshot
region_idinteger

Identifier of the region the snapshot is in.

Example: 1129
sizeinteger

Size of the snapshot in GB.

Example: 0
statusstring

Current status of the snapshot.

Example: CREATING
updated_atstring<date-time>

ISO 8601 UTC timestamp marking when the snapshot was last updated.

Example: 2026-05-06T16:04:09Z
vm_idinteger

Identifier of the virtual machine the snapshot was created from.

Example: 2058
has_floating_ipboolean

Whether the virtual machine had a floating IP when the snapshot was created.

Example: false
labelsstring

Labels applied to the snapshot.

regionstring

Region the snapshot is in: CANADA-1, NORWAY-1, or US-1.

Example: NORWAY-1
vm_namestring

Name of the source virtual machine.

Example: example-vm
vm_statusstring

Status of the source virtual machine.

Example: ACTIVE
vm_environmentstring

Environment the source virtual machine was running in.

vm_flavorstring

Flavor (hardware configuration) of the source virtual machine.

vm_imagestring

Operating system image of the source virtual machine.

vm_keypairstring

SSH key pair associated with the source virtual machine.

volume_idstringnullable

Identifier of the volume the snapshot was created from, or null if none.

volume_namestringnullable

Name of the volume the snapshot was created from, or null if none.

custom_imagestringnullable

Custom image created from the snapshot, or null if none.

SnapshotRetrieve
{
  "status": 200,
  "message": "Retrieved snapshot 1783",
  "snapshot": {
    "created_at": "2026-05-06T16:04:09Z",
    "description": "example",
    "id": 1402,
    "is_image": true,
    "name": "example-snapshot",
    "region_id": 1129,
    "size": 0,
    "status": "CREATING",
    "updated_at": "2026-05-06T16:04:09Z",
    "vm_id": 2058,
    "has_floating_ip": false,
    "labels": "string",
    "region": "NORWAY-1",
    "vm_name": "example-vm",
    "vm_status": "ACTIVE",
    "vm_environment": "string",
    "vm_flavor": "string",
    "vm_image": "string",
    "vm_keypair": "string",
    "volume_id": "string",
    "volume_name": "string",
    "custom_image": "string"
  }
}