v4

latestOpenAPI 3.1.0Apache-2.0raw.githubusercontent.com2026-05-09283767.7 KB

snapshots

Create a snapshot from a VM

Captures a VM's state into a customer-visible snapshot. Supported on running and paused VMs; returns 201 Created with the new snapshot in both cases. On a paused VM, repeated calls within the same pause cycle are idempotent: the second call returns the same snapshot record without modification.

post/v1/snapshots

Request body

vmIdstring required

namestring

Snapshot name (trimmed + whitespace-collapsed, max 64 runes; longer values are truncated server-side). Auto-generated as snapshot-<8-char-vmId-prefix> if empty.

Response

Snapshot created

idstring required

namestring required

orgIdstring required

vmIdstring required

metadataMetadata

Free-form string→string map. Server-enforced limits: up to 256 keys, key length 1–256 bytes, value length ≤4096 bytes, total JSON encoding ≤65536 bytes.

envVarsEnvVars

Environment variable string→string map injected into the VM at boot. Keys must be 1–256 bytes and match shell-variable name ([A-Za-z_][A-Za-z0-9_]*); values may not contain newline, carriage return, or null bytes. Total JSON encoding ≤65536 bytes.

statusstring required

Snapshot lifecycle status. Known values: creating, ready, error. Additional values may be introduced in future server versions.

createdAtstring date-time required