Health & Readiness
Reference for the public /health and /ready endpoints, including expected responses, readiness semantics, and how to use them in uptime checks.
Health Check
GET /healthAuthentication: Public (no API key required)
Returns the service liveness status:
curl https://api.vat-engine.app/health{
"status": "ok"
}Readiness Check
GET /readyAuthentication: Public (no API key required)
Returns whether the service is ready to accept traffic (all required dependencies are reachable):
curl https://api.vat-engine.app/ready{
"status": "ready"
}A non-200 response from /ready indicates the service is not ready to handle requests. The public readiness response is intentionally minimal and does not expose which dependency failed.
For the Next.js frontend deployment, /ready succeeds only after the frontend can reach its own PostgreSQL connection and the upstream backend /ready endpoint.