Skip to content
hypeman
Get started
Overview

API Reference

Libraries

Go
0.7.0
go get -u 'github.com/onkernel/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}
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
Start a stopped instance
post/instances/{id}/start
Stop instance (graceful shutdown)
post/instances/{id}/stop
Stream instance logs (SSE)
get/instances/{id}/logs

InstancesVolumes

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

Volumes

List volumes
get/volumes
Create volume
post/volumes
Get volume details
get/volumes/{id}
Delete volume
delete/volumes/{id}

Ingresses

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