Dock Docs
API reference

Hosts

List hosts and replace a host's fleet credential. Instance admins only.

A Host is a machine that runs Docks through a docklet; see Runtimes and images. Hosts are shared by the whole instance, so these routes are for instance admins only. The caller's verified email must be listed in INSTANCE_ADMIN_EMAILS. Others get instance_admin_required (403), and an admin with an unverified email gets email_verification_required (403).

The docklet's own fleet API (/v1/fleet/*) is not part of the public API. Shared rules are in Conventions.

GET /v1/hosts

List every registered host, ordered by id.

Response: an array of Host summary objects. Errors: instance_admin_required, email_verification_required.

GET /v1/hosts/:id

Read one host with every non-archived Dock placed on it, across all organizations.

Response: the Host detail object. Errors: host_not_found, instance_admin_required, email_verification_required.

POST /v1/hosts/:id/reset-credential

Replace the host's fleet credential. The new credential is shown once and must be installed on the host; the old one stops working. Session only.

No body. Response: { "hostId": "...", "credential": "..." }. Errors: session_required, host_not_found, instance_admin_required, email_verification_required.

On this page