ProxyWhirl Docs
OpenapiMonitoring

API health check

GET
/api/health

Check API health status.

Returns 200 if healthy, 503 if unhealthy.

Args: rotator: ProxyWhirl dependency

Returns: Health status response

Response Body

application/json

curl -X GET "https://example.com/api/health"
{
  "data": {
    "message": "Operation completed successfully"
  },
  "meta": {
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "timestamp": "2025-10-27T12:00:00Z",
    "version": "1.0.0"
  },
  "status": "success"
}