GET /health
Purpose
GET /health is the simplest probe in the service. It does not read MongoDB,
CRM, Notify Triggers, Spark Bonus, or Lumio data. It only reports whether the
main HTTP listener is up and serving requests.
Where it runs
- Served by the main API server on the same listener as
/api/v1/*,/ready, and/metrics - Local default port:
8086 - Response body: plain text
ok
Data source
There is no upstream data source for this endpoint.
| Response piece | Comes from | Notes |
|---|---|---|
HTTP 200 OK | Main HTTP listener state | Returned when the service listener can answer the request |
Body ok | Static handler response | Not derived from Mongo or any downstream system |
What it does not prove
- It does not prove Mongo connectivity.
- It does not prove CRM, Notify Triggers, Spark Bonus, or Lumio data can be read.
- It does not prove the bearer-protected API routes are working.
Use GET /health as a liveness probe only.
For read-model freshness and failure visibility, use /metrics. That endpoint
exports per-tenant, per-slice sync_state gauges for last-success age,
fresh-until age, lag seconds, and consecutive failure count.