Health Check
Reports whether the service and its dependencies are up. Public — no
Api-Token header is needed.
GET
/api/healthAuth: Not RequiredParameters
None.
Response
Always HTTP 200. The outcome is in the body:
| Body | Meaning |
|---|---|
{"status": true} | Service, database and cache are up |
{"status": false, "mes": "Redis error"} | The cache is unavailable |
{"status": false, "mes": "Database error"} | The database is unavailable |
This endpoint also does not use the API's
error format — a failure is reported through status, not
through a code.
When to use it
It needs no token, which makes it the right first call when setting up or debugging an integration: it separates "can I reach the service at all" from every question about credentials and request shape.
Check the body, not the status code
This endpoint answers 200 even when the service is unhealthy — the difference is
status in the body. A monitor that only looks at the HTTP status will report
everything as fine through an outage.