/

Docs
History
Schema
Generate

Filter operations

get/healthHealth check
get/capabilitiesGet host capabilities
get/resourcesGet host resource capacity and allocations
post/resources/memory/reclaimTrigger proactive guest memory reclaim
get/imagesList images
post/imagesPull and convert OCI image
post/images/{name}/tagCreate or update a local image tag
get/images/{name}Get image details
delete/images/{name}Delete image
get/instancesList instances
post/instancesCreate and start instance
get/instances/{id}Get instance details
delete/instances/{id}Stop and delete instance
patch/instances/{id}Update instance properties
post/instances/{id}/standbyPut instance in standby (pause, snapshot, delete VMM)
post/instances/{id}/restoreRestore instance from standby
post/instances/{id}/forkFork an instance from stopped, standby, or running (with from_running=true)
post/instances/{id}/snapshotsCreate a snapshot for an instance
get/instances/{id}/snapshot-scheduleGet snapshot schedule for an instance
put/instances/{id}/snapshot-scheduleCreate or update snapshot schedule for an instance
delete/instances/{id}/snapshot-scheduleDelete snapshot schedule for an instance
post/instances/{id}/snapshots/{snapshotId}/restoreRestore an instance from a snapshot in-place
get/snapshotsList snapshots
get/snapshots/{snapshotId}Get snapshot details
delete/snapshots/{snapshotId}Delete a snapshot
post/snapshots/{snapshotId}/forkFork a new instance from a snapshot
post/instances/{id}/stopStop instance (graceful shutdown)
post/instances/{id}/startStart a stopped instance
get/instances/{id}/logsStream instance logs (SSE)
get/instances/{id}/statGet filesystem path info
get/instances/{id}/waitWait for instance to reach a target state
get/instances/{id}/auto-standby/statusGet auto-standby diagnostic status
post/instances/{id}/auto-standby/holdHold off auto-standby
get/instances/{id}/statsGet instance resource utilization stats
post/instances/{id}/volumes/{volumeId}Attach volume to instance
delete/instances/{id}/volumes/{volumeId}Detach volume from instance
get/volumesList volumes
post/volumesCreate empty volume
post/volumes/from-archiveCreate volume from archive
get/volumes/{id}Get volume details
delete/volumes/{id}Delete volume
get/devicesList registered devices
post/devicesRegister a device for passthrough
get/devices/availableDiscover passthrough-capable devices on host
get/devices/{id}Get device details
delete/devices/{id}Unregister device
get/ingressesList ingresses
post/ingressesCreate ingress
get/ingresses/{id}Get ingress details
delete/ingresses/{id}Delete ingress
get/buildsList builds
post/buildsCreate a new build
get/builds/{id}Get build details
delete/builds/{id}Cancel build
get/builds/{id}/eventsStream build events (SSE)
get/buildersList builders
post/buildersCreate builder
get/builders/{id}Get builder details
delete/builders/{id}Delete builder
post/builders/{id}/prunePrune builder cache
get/pushesList pushes
post/pushesPush an image to a remote registry
get/pushes/{id}Get push details

Changes to Create or update snapshot schedule for an instance

put/instances/{id}/snapshot-schedule

Mar 24, 2026c642f2375b21 Revision changes
- info
  endpoint added