Health

Health monitoring and system status operations

Health check

get

https://api.example.com/v1https://staging-api.example.com/v1

/health

Basic health check endpoint to verify the API is running

Responses

200

Service is healthy

text/plain

ResponsestringExample: OK

500

Service is unhealthy

text/plain

get

/health

HTTPcURLJavaScriptPython

GET /v1/health HTTP/1.1
Host: api.example.com
Accept: */*

OK

Database health check

get

https://api.example.com/v1https://staging-api.example.com/v1

/health/db

Check database connectivity and return test data

Responses

200

Database is healthy

application/json

500

Database connection error

application/json

get

/health/db

HTTPcURLJavaScriptPython

GET /v1/health/db HTTP/1.1
Host: api.example.com
Accept: */*

[
  {
    "id": 1,
    "name": "text",
    "created_at": "2025-12-16T02:57:22.027Z"
  }
]