/

/Hypeman API

APIs
Generators
Stacks
Projects

Docs
History
Schema

Checked 2m ago · Updated 1mo ago

Filter operations

getHealth check
getGet host resource capacity and allocations
postTrigger proactive guest memory reclaim
getList images
postPull and convert OCI image
getGet image details
deleteDelete image
getList instances
postCreate and start instance
getGet instance details
deleteStop and delete instance
patchUpdate instance properties
postPut instance in standby (pause, snapshot, delete VMM)
postRestore instance from standby
postFork an instance from stopped, standby, or running (with from_running=true)
postCreate a snapshot for an instance
getGet snapshot schedule for an instance
putCreate or update snapshot schedule for an instance
deleteDelete snapshot schedule for an instance
postRestore an instance from a snapshot in-place
getList snapshots
getGet snapshot details
deleteDelete a snapshot
postFork a new instance from a snapshot
postStop instance (graceful shutdown)
postStart a stopped instance
getStream instance logs (SSE)
getGet filesystem path info
getWait for instance to reach a target state
getGet auto-standby diagnostic status
postHold off auto-standby
getGet instance resource utilization stats
postAttach volume to instance
deleteDetach volume from instance
getList volumes
postCreate empty volume
postCreate volume from archive
getGet volume details
deleteDelete volume
getList registered devices
postRegister a device for passthrough
getDiscover passthrough-capable devices on host
getGet device details
deleteUnregister device
getList ingresses
postCreate ingress
getGet ingress details
deleteDelete ingress
getList builds
postCreate a new build
getGet build details
deleteCancel build
getStream build events (SSE)

Health check

get/health

Response

Service is healthy

status'ok' required

Example response

{
  "status": "ok"
}

Changes