Skip to main content
GET
/
api
/
canary
/
health
Performs a health check on the application and external dependencies.

​
Response

​
Healthy
​
status
string
Status of the system (e.g., “ok”)
​
details
object
Details about individual dependency health

​
Example Response (Healthy)

{
  "status": "ok",
  "details": {
    "nestjs-docs": {
      "status": "up"
    }
  }
}

​
Example Response (Unhealthy)

{
  "status": "error",
  "error": {
    "nestjs-docs": {
      "status": "down",
      "message": "Service unavailable"
    }
  }
}

​
Error Responses

​
Service Unavailable
One or more health checks failed. The application or its dependencies are not healthy.

​
Authentication

This endpoint does not require authentication and can be called by any client.

​
Use Cases

Monitoring

Monitor application health and uptime

Dependency Checks

Verify all external services are operational

Readiness Probes

Use in Kubernetes or container orchestration readiness probes

Uptime Monitoring

Integrate with external monitoring services