Health And Readiness

Docs/Developer & Operations/Health and readiness

Developer & Operations

Health and readiness

Production deployments expose two backend health endpoints under the API prefix.

GET /api/health

Liveness check. It confirms the CollabOS API process is running and reports safe process metadata such as timestamp and uptime.

GET /api/health/ready

Readiness check. It verifies the database is reachable before reporting ready.

Use liveness for process/container health and readiness for load-balancer or deployment traffic decisions.

The health response never returns database credentials, API keys, JWT secrets, or provider credentials.