Skip to content
hypeman
Get started
API Reference

Snapshots

List snapshots
client.snapshots.list(SnapshotListParams { kind, name, source_instance_id, tags } query?, RequestOptionsoptions?): SnapshotListResponse { id, created_at, kind, 6 more }
get/snapshots
Get snapshot details
client.snapshots.get(stringsnapshotID, RequestOptionsoptions?): Snapshot { id, created_at, kind, 6 more }
get/snapshots/{snapshotId}
Delete a snapshot
client.snapshots.delete(stringsnapshotID, RequestOptionsoptions?): void
delete/snapshots/{snapshotId}
Fork a new instance from a snapshot
client.snapshots.fork(stringsnapshotID, SnapshotForkParams { name, target_hypervisor, target_state } body, RequestOptionsoptions?): Instance { id, created_at, image, 19 more }
post/snapshots/{snapshotId}/fork
ModelsExpand Collapse
Snapshot { 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" | "firecracker" | "qemu" | "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?: string | null

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

tags?: Record<string, string>

User-defined key-value tags.

SnapshotKind = "Standby" | "Stopped"

Snapshot capture kind

Accepts one of the following:
"Standby"
"Stopped"