Skip to content

Health checks ​

EndpointAccessUse
GET /health/livePublicLiveness: the process answers. Never touches the database.
GET /healthPublicReadiness: only the overall status.
GET /health/detailsAccess Token with authora.admin and Permission health.readFull report for monitoring.

Status ​

StatusHTTPMeaning
Healthy200Everything works.
Degraded200Authora works, but needs attention (see below).
Unhealthy503Authora cannot serve requests correctly.

/health and /health/live return only {"status": "Healthy"}. The details are not public, because they reveal e.g. the schema version.

Checks ​

NameUnhealthy whenDegraded when
databaseThe database cannot be reached.–
migrationsMigrations are pending: the database is older than this version.The database has migrations this version does not know: it is newer, e.g. after a rollback.
signing-keys–Changed key files could not be loaded; the previous keys stay in use. See Rotate signing keys.

Details ​

json
{
  "status": "Healthy",
  "durationMs": 12.4,
  "checks": [
    { "name": "database", "status": "Healthy", "description": null, "durationMs": 8.1, "data": {} },
    { "name": "migrations", "status": "Healthy", "description": "The database schema is up to date.", "durationMs": 3.2,
      "data": { "current": "20261102…", "latest": "20261102…", "pending": [], "unknown": [] } },
    { "name": "signing-keys", "status": "Healthy", "description": "ID Tokens are signed with key Iz6V….", "durationMs": 0.1, "data": {} }
  ]
}

Released under the MIT License.