Service health check
Changed onHealth check for the API. Returns 200 only when every dependency the service cannot work without (today, its database) has been proven reachable within the last few seconds; otherwise 503 with the same payload, status of degraded, and a dependencies.checks entry naming what failed and which category of failure it was. Public, with no authentication required, so agents, uptime monitors, and load balancers can reach it without a credential. Treat any non-200 as the API being unable to serve authenticated requests. The result is cached briefly and shared across callers, so polling it frequently costs the service nothing.
Request
- Base URLhttps://api.primitive.dev/v1
- URLhttps://api.primitive.dev/v1/health
- Authnone required
Response
The service is healthy: every required dependency was proven reachable.
Changes
- info
added the non-success response with the status
- info
added the required property
to the response with the status
- info
- info
added the required property
to the response with the status
- info