Provisioning endpoints reference

Host lifecycle states

Each server progresses through a fixed sequence of states. Because transitions involve physical work in a facility, they proceed on their own schedule and cannot be accelerated.

• 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 cannot be reversed. It begins secure erasure immediately, and data cannot be restored once erasure starts.

Checking status

Provisioning involves physical work and can take several hours. Rather than holding a request open until the state is ready, check the server status at regular intervals, or register a webhook under Access in the Client Portal to receive notifications.

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