Skip to content
Cratebase

Health & setup

GET /health — unauthenticated

Section titled “GET /health — unauthenticated”

Liveness check. 200 { "status": "ok" }, always, with no request body.

GET /setup/status — unauthenticated

Section titled “GET /setup/status — unauthenticated”

Whether the instance still needs its first superuser. 200 { "needsSetup": boolean }. The dashboard polls this to decide whether to render the inline setup form or the normal login screen (see First run).

POST /setup — unauthenticated

Section titled “POST /setup — unauthenticated”

Creates the first _superusers record. Body: email, password (min length 8), passwordConfirm. 200 with the created record on success. Permanently closed once any superuser exists — a second call is 403 even if the first superuser was later deleted through other means, since the check is “does at least one exist now,” not “did setup ever run.” cratebase superuser create is the headless equivalent for scripted deployments; see CLI.