Skip to main content
GET
Global platform health
Returns the aggregated health for the entire Handa Uncle backend: API uptime, MongoDB, Redis, and any subsystems registered in startup.config.ts. Use this endpoint for synthetic checks and during incident response to understand which dependency is degraded.

Example request

Response fields

  • data.status: healthy, degraded, or unhealthy
  • data.services: Map of service name to status (up / down)
  • data.uptime: Process uptime in seconds
  • data.environment: Deployment environment (e.g., production, staging)
  • data.response_time_ms: Server-side computation time for the health route

Response

Health payload returned.

success
enum<boolean>
required
Available options:
true
data
object
required
meta
object
required