API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Snapshots

List snapshots

client.Snapshots.List(ctx, query) (*[]Snapshot, error)

get/snapshots

Get snapshot details

client.Snapshots.Get(ctx, snapshotID) (*Snapshot, error)

get/snapshots/{snapshotId}

Delete a snapshot

client.Snapshots.Delete(ctx, snapshotID) error

delete/snapshots/{snapshotId}

Fork a new instance from a snapshot

client.Snapshots.Fork(ctx, snapshotID, body) (*Instance, error)

post/snapshots/{snapshotId}/fork

ModelsExpand Collapse

type Snapshot struct{…}

ID string

Auto-generated unique snapshot identifier

CreatedAt Time

Snapshot creation timestamp

formatdate-time

Kind SnapshotKind

Snapshot capture kind

Accepts one of the following:

const SnapshotKindStandby SnapshotKind = "Standby"

const SnapshotKindStopped SnapshotKind = "Stopped"

SizeBytes int64

Total payload size in bytes

formatint64

SourceHypervisor SnapshotSourceHypervisor

Source instance hypervisor at snapshot creation time

Accepts one of the following:

const SnapshotSourceHypervisorCloudHypervisor SnapshotSourceHypervisor = "cloud-hypervisor"

const SnapshotSourceHypervisorFirecracker SnapshotSourceHypervisor = "firecracker"

const SnapshotSourceHypervisorQemu SnapshotSourceHypervisor = "qemu"

const SnapshotSourceHypervisorVz SnapshotSourceHypervisor = "vz"

SourceInstanceID string

Source instance ID at snapshot creation time

SourceInstanceName string

Source instance name at snapshot creation time

Name stringoptional

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

Tags map[string, string]optional

User-defined key-value tags.

type SnapshotKind string

Snapshot capture kind

Accepts one of the following:

const SnapshotKindStandby SnapshotKind = "Standby"

const SnapshotKindStopped SnapshotKind = "Stopped"