Snapshots

List snapshots

get/snapshots

Get snapshot details

get/snapshots/{snapshotId}

Delete a snapshot

delete/snapshots/{snapshotId}

Fork a new instance from a snapshot

post/snapshots/{snapshotId}/fork

ModelsExpand Collapse

Snapshot = object { id, created_at, kind, 11 more }

id: string

Auto-generated unique snapshot identifier

created_at: string

Snapshot creation timestamp

formatdate-time

kind: SnapshotKind

Snapshot capture kind

Accepts one of the following:

"Standby"

"Stopped"

size_bytes: number

Total payload size in bytes

formatint64

source_hypervisor: "cloud-hypervisor" or "firecracker" or "qemu" or "vz"

Source instance hypervisor at snapshot creation time

Accepts one of the following:

"cloud-hypervisor"

"firecracker"

"qemu"

"vz"

source_instance_id: string

Source instance ID at snapshot creation time

source_instance_name: string

Source instance name at snapshot creation time

compressed_size_bytes: optional number

Compressed memory payload size in bytes

formatint64

compression: optional SnapshotCompressionConfig { enabled, algorithm, level }

enabled: boolean

Enable snapshot memory compression

algorithm: optional "zstd" or "lz4"

Compression algorithm (defaults to zstd when enabled). Ignored when enabled is false.

Accepts one of the following:

"zstd"

"lz4"

level: optional number

Compression level. Allowed ranges are zstd=1-19 and lz4=0-9. When omitted, zstd defaults to 1 and lz4 defaults to 0. Ignored when enabled is false.

minimum0

maximum19

compression_error: optional string

Compression error message when compression_state is error

compression_state: optional "none" or "compressing" or "compressed" or "error"

Compression status of the snapshot payload memory file

Accepts one of the following:

"none"

"compressing"

"compressed"

"error"

name: optional string

Optional human-readable snapshot name (unique per source instance)

tags: optional map[string]

User-defined key-value tags.

uncompressed_size_bytes: optional number

Uncompressed memory payload size in bytes

formatint64

SnapshotKind = "Standby" or "Stopped"

Snapshot capture kind

Accepts one of the following:

"Standby"

"Stopped"