edubridge learning management system
GET /api/v1/health

Check the overall health status of the application including database connectivity

Responses

  • 200 application/json

    Health check result

    Hide response attributes Show response attributes object
    • status string Required

      Overall health status of the application

      Values are healthy or unhealthy.

    • timestamp string Required

      Timestamp when the health check was performed

    • database string Required

      Database connection status

      Values are connected or disconnected.

    • uptime string Required

      Application uptime in human readable format

    • error string

      Error message if health check fails
  • 400 application/json

    Default bad request error 400 response

    Hide response attributes Show response attributes object
    • message string Required

      Response message

    • error string Required
    • statusCode number Required
GET /api/v1/health 
curl \
 --request GET 'http://localhost:3500/api/v1/health'
Response examples (200) 
{
  "status": "healthy",
  "timestamp": "2025-09-25T10:30:00.000Z",
  "database": "connected",
  "uptime": "2d 5h 30m 45s",
  "error": "Database connection timeout"
}
Response examples (400) 
{
  "message": "string",
  "error": "string",
  "statusCode": 42.0
}