Skip to main content
GET
/
health
Health Check
curl --request GET \
  --url https://api.example.com/health
{
  "status": "<string>"
}

Endpoint

GET /health

Authentication

No authentication required.

Response

status
string
required
Service status indicator. Returns "ok" when healthy.

Success Response (200)

{
  "status": "ok"
}

Example Request

cURL
curl https://your-api-domain.com/health
JavaScript
const response = await fetch('https://your-api-domain.com/health');
const data = await response.json();
console.log(data.status); // "ok"

Notes

  • This endpoint is useful for monitoring and uptime checks
  • Returns Cache-Control: no-store to prevent caching
  • No rate limiting applied to this endpoint

Build docs developers (and LLMs) love