Create a snapshot for an instance

post/instances/{id}/snapshots

Path ParametersExpand Collapse

id: string

Body ParametersExpand Collapse

kind: SnapshotKind

Snapshot capture kind

Accepts one of the following:

"Standby"

"Stopped"

name: optional string

Optional snapshot name (lowercase letters, digits, and dashes only; cannot start or end with a dash)

maxLength63

tags: optional map[string]

User-defined key-value tags.

ReturnsExpand 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.

Create a snapshot for an instance

curl http://localhost:8080/instances/$ID/snapshots \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $HYPEMAN_API_KEY" \
    -d '{
          "kind": "Standby",
          "name": "pre-upgrade",
          "tags": {
            "team": "backend",
            "env": "staging"
          }
        }'

{
  "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",
  "name": "baseline-standby",
  "tags": {
    "team": "backend",
    "env": "staging"
  }
}

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",
  "name": "baseline-standby",
  "tags": {
    "team": "backend",
    "env": "staging"
  }
}