API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

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, 6 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

name: optional string

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

tags: optional map[string]

User-defined key-value tags.

SnapshotKind = "Standby" or "Stopped"

Snapshot capture kind

Accepts one of the following:

"Standby"

"Stopped"