Skip to content
engage-ai

API reference

Health

Liveness and readiness probes

Liveness probe

GET/health

Never touches a dependency. A liveness probe that fails when Postgres blips would restart every healthy replica in the middle of an outage.

Auth
None
Response fields 200
  • statusstring
  • uptimeSecondsinteger

Responses

  • 200
Request
curl "https://api.getengageai.app/health"
Response · 200
{
  "status": "string",
  "uptimeSeconds": 0
}

Readiness probe

GET/health/ready

Checks Postgres and Redis. A replica with a dead connection pool is removed from the load balancer instead of black-holing requests.

Auth
None
Response fields 200
  • statusenum

    One of ok

  • checksobject

Responses

  • 200Ready to serve traffic.
  • 503A dependency is unreachable. `checks` names which one. The status code is what an orchestrator acts on, so this must not be a 200.
Request
curl "https://api.getengageai.app/health/ready"
Response · 200
{
  "status": "ok",
  "checks": {}
}