Skip to main content
GET
/
health
Health Check
curl --request GET \
  --url https://api.example.com/health

​
GET /health

Verify that the API is running and inspect the health of its backing components. Use this for uptime monitoring, load balancer probes, and operational dashboards.

​
Notes

  • No authentication required.
  • Returns a top-level status field: healthy when all components are operational, or degraded when one or more components report issues.
  • Component checks include:
    • database — PostgreSQL connectivity (healthy or unhealthy).
    • queue — SQS queue reachability with per-queue status (general, energy_model, shading), approximate message counts, and in-flight counts. Reported as not_configured if queue URLs are not set.
    • monitoring — Sentry integration (configured or not_configured).
  • The response also includes version and environment fields.
  • The health check does not fail the HTTP response on degraded components; it always returns 200 with the component statuses embedded in the body.