Provisioning endpoints reference

Host lifecycle states

A host moves through a fixed sequence. Transitions are driven by physical work in a facility, so states advance on their own timeline and cannot be forced.

• allocated. Capacity reserved, no hardware assigned yet.
• baselining. Hardware assigned, firmware being baselined.
• imaging. Operating system being written.
• ready. Available to you. Verify attestation before use.
• decommissioning. Sanitization in progress. Irreversible.
• released. Capacity returned to your allocation.

Endpoints

GET    /v1/hosts                 list hosts in your boundary
POST   /v1/hosts                 provision a host
GET    /v1/hosts/{id}            read host state
PATCH  /v1/hosts/{id}            update mutable fields
DELETE /v1/hosts/{id}            begin decommissioning
GET    /v1/hosts/{id}/attestation retrieve attestation report
GET    /v1/allocations           read allocation and remaining capacity

DELETE is not reversible. It starts media sanitization immediately, and there is no restore path once sanitization begins.

Polling rather than waiting

Provisioning involves physical work and can take hours. Do not hold a request open waiting for ready. Poll host state on a sensible interval, or register a webhook under Access in the Client Portal and let the state change come to you.

# poll until ready, backing off
until [ "$(servlogi host get "$HOST_ID" --field state)" = "ready" ]; do
  sleep 60
done