/

/Hypeman API

APIs
Generators
Stacks
Projects

Docs
History
Schema
Sources

v33

latestOpenAPI 3.1.0raw.githubusercontent.com2026-04-175267122.5 KB

Health check

get/health

Response

Service is healthy

status'ok' required

Example response

{
  "status": "ok"
}

All 52 operations

get Health check
get Get host resource capacity and allocations
post Trigger proactive guest memory reclaim
get List images
post Pull and convert OCI image
get Get image details
delete Delete image
get List instances
post Create and start instance
get Get instance details
delete Stop and delete instance
patch Update instance properties
post Put instance in standby (pause, snapshot, delete VMM)
post Restore instance from standby
post Fork an instance from stopped, standby, or running (with from_running=true)
post Create a snapshot for an instance
get Get snapshot schedule for an instance
put Create or update snapshot schedule for an instance
delete Delete snapshot schedule for an instance
post Restore an instance from a snapshot in-place
get List snapshots
get Get snapshot details
delete Delete a snapshot
post Fork a new instance from a snapshot
post Stop instance (graceful shutdown)
post Start a stopped instance
get Stream instance logs (SSE)
get Get filesystem path info
get Wait for instance to reach a target state
get Get auto-standby diagnostic status
get Get instance resource utilization stats
post Attach volume to instance
delete Detach volume from instance
get List volumes
post Create empty volume
post Create volume from archive
get Get volume details
delete Delete volume
get List registered devices
post Register a device for passthrough
get Discover passthrough-capable devices on host
get Get device details
delete Unregister device
get List ingresses
post Create ingress
get Get ingress details
delete Delete ingress
get List builds
post Create a new build
get Get build details
delete Cancel build
get Stream build events (SSE)