v1

latestOpenAPI 3.1.0Apache-2.02026-08-04584075.9 KB
nodes

post/v1/nodes/register

Request body

addressstring required
availableCpusinteger required
availableDiskGbinteger required
availableMemoryMbinteger required
idstring required
labelsobject required
lastHeartbeatAtstring nullable
registeredAtstring required
runtimestring

The runtime this node speaks (e.g. "smolvm"). The control plane resolves a driver from this name; smolvm_address is that runtime's endpoint. Defaults to "smolvm" so a node that doesn't report a runtime (the only runtime today) is handled transparently.

smolvmAddressstring required

The runtime endpoint (HTTP address) on this node.

statusstring required
totalCpusinteger required
totalDiskGbinteger required
totalMemoryMbinteger required
usedCpusnumber double

Real CPU usage as fractional CPUs (e.g., 2.5 = 2.5 CPUs worth of load). Reported by the node from hypervisor/process stats. Separate from available_cpus (which is allocation-based bookkeeping).

usedDiskGbinteger

Real disk space consumed by VM overlay/storage files in GB. Reported from filesystem stat of VM disk images. Separate from available_disk_gb (which reflects the entire host filesystem).

usedMemoryMbinteger

Real memory usage in MB. Reported by the node from RSS of VM processes. Separate from available_memory_mb (which is allocation-based bookkeeping).

Response

Node registered

addressstring required
availableCpusinteger required
availableDiskGbinteger required
availableMemoryMbinteger required
idstring required
labelsobject required
lastHeartbeatAtstring nullable
registeredAtstring required
runtimestring

The runtime this node speaks (e.g. "smolvm"). The control plane resolves a driver from this name; smolvm_address is that runtime's endpoint. Defaults to "smolvm" so a node that doesn't report a runtime (the only runtime today) is handled transparently.

smolvmAddressstring required

The runtime endpoint (HTTP address) on this node.

statusstring required
totalCpusinteger required
totalDiskGbinteger required
totalMemoryMbinteger required
usedCpusnumber double

Real CPU usage as fractional CPUs (e.g., 2.5 = 2.5 CPUs worth of load). Reported by the node from hypervisor/process stats. Separate from available_cpus (which is allocation-based bookkeeping).

usedDiskGbinteger

Real disk space consumed by VM overlay/storage files in GB. Reported from filesystem stat of VM disk images. Separate from available_disk_gb (which reflects the entire host filesystem).

usedMemoryMbinteger

Real memory usage in MB. Reported by the node from RSS of VM processes. Separate from available_memory_mb (which is allocation-based bookkeeping).