Health

Service health check endpoint

Health Check

GET /api/v1/health

Returns the health status of the Tracera backend and its dependencies.

Request

curl http://localhost:8080/api/v1/health

Response

200 OK — Healthy

{
  "status": "ok",
  "timescaledb": "up",
  "redis": "up"
}

503 — Degraded

{
  "status": "ok",
  "timescaledb": "up",
  "redis": "down"
}

The HTTP status code is 503 Service Unavailable when any dependency is unreachable, even though the status field remains "ok" (indicating the API server itself is running).

Fields

Field	Type	Values	Description
status	string	ok	API server status — always ok if the server is responding
timescaledb	string	up / down	TimescaleDB connection status
redis	string	up / down	Redis connection status

Notes

• This endpoint is used by Docker health checks (every 10 seconds)
• Returns 503 Service Unavailable if any dependency is down
• No authentication required
• Used by load balancers to determine backend readiness