Health Checks

GET /api/ping

API health check endpoint

Example request:

GET /api/ping HTTP/1.1
Content-Type: application/json

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "message": "pong!",
  "status": "success"
}
Status Codes:
GET /api/check-db

Database health check endpoint

Example request:

GET /api/check-db HTTP/1.1
Content-Type: application/json

Example responses:

  • when database is available

HTTP/1.1 200 OK
Content-Type: application/json

{
  "message": "db available",
  "status": "success"
}

  • when database is not available

HTTP/1.1 500 Internal Server Error
Content-Type: application/json

{
  "message": "db unavailable",
  "status": "error"
}
Status Codes: