System

Health

Changed on

Return admin service health status.

get/admin/health

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /admin/health
  • Auth: none required

Response

Successful Response

next_stepstring nullable

Next setup step to perform, e.g. create_admin; null when setup is complete.

setup_requiredboolean required

Whether first-run setup is still needed because no user exists yet.

statusstring required

Health status of the surface; ok when it is serving.

surfacestring required

Name of the surface reporting health; always admin.

Example response

{
  "next_step": "create_admin",
  "setup_required": true,
  "status": "ok",
  "surface": "admin"
}

Changes