Health

Get process health

Reports process liveness and the current database and index-runtime state. Liveness returns 200 even when ready is false.

get/healthz

Request

  • Base URL: http://localhost:6969
  • URL: http://localhost:6969/healthz
  • Auth: none required

Response

The server process is alive.

readyboolean required
modestring required

Configured database mode.

index_runtimestring required

Stable index-runtime readiness code.

blocked_index_entity_countinteger required

Nodes and edges whose queued vector or text index work the index worker holds back: either it can never fit a publication under the current limits, typically after the limits were lowered, or applying it fails the same way every time, for example on damaged index data. Only the count: the writer logs an error naming each one when it is held back. Always 0 on a reader. Rebuilt after a restart as publication reaches them again.

Example response

{
  "ready": true,
  "mode": "writer",
  "index_runtime": "ready",
  "blocked_index_entity_count": 0
}

Changes

No recorded changes to this operation across all 1 revision of this API.