API reference

Build storage tiers and instant copy-on-write machines

Inspect disks and ZFS pools, create golden images and spawn clones while respecting destructive boundaries.

Storage inventory

GET /v1/host/storage

Returns disks classified as local, SAN, hardware RAID, USB or NVMe, plus ZFS pool health, capacity and use.

Pool lifecycle

POST /v1/host/storage/pools
{ "name":"fast", "tier":"fast", "layout":"mirror", "disks":["..."] }

Layouts include single, mirror, raidz and raidz2. Pool detail and operations cover scrub, trim, spares, attach, detach, replace, vdevs, cache, log, online and offline.

Ephemeral RAM pool

POST /v1/host/storage/rampool

A RAM pool is ZFS on zram. It is fast and disappears on restart; place only disposable or reproducible workloads there.

Golden images

/v1/host/storage/golden lists, imports and removes immutable bases. A golden can serve many copy-on-write clones, each consuming only its changes.

Instant machine

POST /v1/host/spawn
{ "golden":"fast/debian", "pool":"fast", "vm":"runner-01", "mem_mb":4096, "vcpu":4 }

The call creates a clone and a bootable machine. QEMU is the default VMM; Cloud Hypervisor is explicitly preview.

Destructive boundary

Pool creation erases the selected disks

Resolve disk identity out of band, require the storage permission and keep independent recovery data. Destroying a pool is different from exporting it; the boot pool is refused.