Skip to main content
GET
/
api
/
v1
/
health
Global platform health
curl --request GET \
  --url https://handauncle-backend-prod-205012263523.asia-south1.run.app/api/v1/health
{
  "data": {
    "timestamp": "2023-11-07T05:31:56Z",
    "uptime": 123,
    "services": {},
    "environment": "<string>",
    "response_time_ms": 123
  },
  "meta": {
    "timestamp": "2023-11-07T05:31:56Z",
    "requestId": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.handauncle.com/llms.txt

Use this file to discover all available pages before exploring further.

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

curl https://api.handauncle.com/api/v1/health

​
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