Skip to content
hypeman
Get started
Overview

API Reference

Libraries

TypeScript
0.1.0
npm install @onkernel/hypeman
Read Docs
Go
0.15.0
go get -u 'github.com/kernel/hypeman-go@v0.0.1'
Read Docs

API Overview

Health

Health check
get/health

Images

List images
get/images
Pull and convert OCI image
post/images
Get image details
get/images/{name}
Delete image
delete/images/{name}

Instances

List instances
get/instances
Create and start instance
post/instances
Get instance details
get/instances/{id}
Update instance properties
patch/instances/{id}
Stop and delete instance
delete/instances/{id}
Put instance in standby (pause, snapshot, delete VMM)
post/instances/{id}/standby
Restore instance from standby
post/instances/{id}/restore
Fork an instance from stopped, standby, or running (with from_running=true)
post/instances/{id}/fork
Start a stopped instance
post/instances/{id}/start
Stop instance (graceful shutdown)
post/instances/{id}/stop
Stream instance logs (SSE)
get/instances/{id}/logs
Get filesystem path info
get/instances/{id}/stat
Get instance resource utilization stats
get/instances/{id}/stats

InstancesVolumes

Attach volume to instance
post/instances/{id}/volumes/{volumeId}
Detach volume from instance
delete/instances/{id}/volumes/{volumeId}

InstancesSnapshots

Create a snapshot for an instance
post/instances/{id}/snapshots
Restore an instance from a snapshot in-place
post/instances/{id}/snapshots/{snapshotId}/restore

Snapshots

List snapshots
get/snapshots
Get snapshot details
get/snapshots/{snapshotId}
Delete a snapshot
delete/snapshots/{snapshotId}
Fork a new instance from a snapshot
post/snapshots/{snapshotId}/fork

Volumes

List volumes
get/volumes
Create empty volume
post/volumes
Create volume from archive
post/volumes/from-archive
Get volume details
get/volumes/{id}
Delete volume
delete/volumes/{id}

Devices

List registered devices
get/devices
Register a device for passthrough
post/devices
Get device details
get/devices/{id}
Unregister device
delete/devices/{id}
Discover passthrough-capable devices on host
get/devices/available

Ingresses

List ingresses
get/ingresses
Create ingress
post/ingresses
Get ingress details
get/ingresses/{id}
Delete ingress
delete/ingresses/{id}

Resources

Get host resource capacity and allocations
get/resources

Builds

List builds
get/builds
Create a new build
post/builds
Get build details
get/builds/{id}
Cancel build
delete/builds/{id}
Stream build events (SSE)
get/builds/{id}/events