Skip to content

Reference: Operations

Health of the instance.

Method Path Summary
GET /api/health Check the health of the instance

GET /api/health

Operation id: getHealth

Public route, no API key needed. Reports whether database, job queue and file storage work, and which version runs.

Answers 200 when everything is fine. When a check fails the answer is 503 with a body of the same shape. Meant for monitoring.

Authentication: None. This endpoint needs no credentials.

Responses

Status Meaning Body
200 The instance is healthy. Health
503 A check failed (database, queue or file storage). Health