Status

One public answer about the control plane, its database, Redis, the worker, the last backup and the last restore test.

Generated from packages/api/src/status.controller.ts by packages/docs/tools/generate-reference.mjs. Every example is a real exchange recorded against the control plane by packages/api/src/testing/reference-examples.spec.ts, with ids from that run. Credentials in the formats this product issues (kr_, krsk_, krses_, JWTs) and values under credential-named fields (password, *_secret, *_token, *_key, lookup_hash) are elided at record time; the recorded file and every page of this site are swept for credential shapes (kr_, krsk_, krses_, JWTs, URLs carrying a password, password fields) before either is accepted. Do not edit by hand: src/reference.spec.ts regenerates it and fails on a difference.

GET /status

Answers 200 on success.

Authentication.

No credential.

Example.

Request

curl https://keyring-api.belghalem.fr/status

Response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": "ok",
  "components": {
    "api": "ok",
    "database": "ok",
    "redis": "ok",
    "worker": "ok",
    "backup": "ok"
  },
  "restoreTest": {
    "lastRunAt": "2026-09-17T05:47:19.465Z",
    "pass": true,
    "backupId": "bk-2026-09-16T02-00-00-000Z"
  }
}

GET /status

On this page