List snapshots

client.snapshots.list(?, ?): SnapshotListResponse { id, created_at, kind, 11 more }

get/snapshots

List snapshots

ParametersExpand Collapse

query: SnapshotListParams { kind, name, source_instance_id, tags }

kind?: SnapshotKind

Filter snapshots by kind

Accepts one of the following:

"Standby"

"Stopped"

name?: string

Filter snapshots by snapshot name

source_instance_id?: string

Filter snapshots by source instance ID

tags?: Record<string, string>

Filter snapshots by tag key-value pairs.

ReturnsExpand Collapse

SnapshotListResponse = Array<Snapshot { 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" | "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

compressed_size_bytes?: number | null

Compressed memory payload size in bytes

formatint64

compression?: SnapshotCompressionConfig { enabled, algorithm, level }

enabled: boolean

Enable snapshot memory compression

algorithm?: "zstd" | "lz4"

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

Accepts one of the following:

"zstd"

"lz4"

level?: 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?: string | null

Compression error message when compression_state is error

compression_state?: "none" | "compressing" | "compressed" | "error"

Compression status of the snapshot payload memory file

Accepts one of the following:

"none"

"compressing"

"compressed"

"error"

name?: string | null

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

tags?: Record<string, string>

User-defined key-value tags.

uncompressed_size_bytes?: number | null

Uncompressed memory payload size in bytes

formatint64

List snapshots

import Hypeman from '@onkernel/hypeman';

const client = new Hypeman({
  apiKey: 'My API Key',
});

const snapshots = await client.snapshots.list();

console.log(snapshots);

[
  {
    "id": "q7z1w7l2af4l8y7q1h7g2m3s",
    "created_at": "2026-03-06T13:56:11Z",
    "kind": "Standby",
    "size_bytes": 104857600,
    "source_hypervisor": "cloud-hypervisor",
    "source_instance_id": "qilviffnqzck2jrim1x6s2b1",
    "source_instance_name": "nginx1",
    "compressed_size_bytes": 73400320,
    "compression": {
      "enabled": true,
      "algorithm": "zstd",
      "level": 1
    },
    "compression_error": "write compressed stream: no space left on device",
    "compression_state": "compressed",
    "name": "baseline-standby",
    "tags": {
      "team": "backend",
      "env": "staging"
    },
    "uncompressed_size_bytes": 4294967296
  }
]

Returns Examples

[
  {
    "id": "q7z1w7l2af4l8y7q1h7g2m3s",
    "created_at": "2026-03-06T13:56:11Z",
    "kind": "Standby",
    "size_bytes": 104857600,
    "source_hypervisor": "cloud-hypervisor",
    "source_instance_id": "qilviffnqzck2jrim1x6s2b1",
    "source_instance_name": "nginx1",
    "compressed_size_bytes": 73400320,
    "compression": {
      "enabled": true,
      "algorithm": "zstd",
      "level": 1
    },
    "compression_error": "write compressed stream: no space left on device",
    "compression_state": "compressed",
    "name": "baseline-standby",
    "tags": {
      "team": "backend",
      "env": "staging"
    },
    "uncompressed_size_bytes": 4294967296
  }
]