Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.herodotus.cloud/llms.txt

Use this file to discover all available pages before exploring further.

​
Health Check

Returns the health status of the HDP server, including database and message queue connectivity. This endpoint does not require authentication.

​
Endpoint

GET /is-alive

​
Example Request

curl -X GET https://staging.hdp.api.herodotus.cloud/is-alive \
  -H "Content-Type: application/json"

​
Response

​
Success Response (200 OK) - Healthy

{
  "status": "healthy",
  "database": "operational",
  "queues": "operational"
}

​
Service Unavailable Response (503) - Unhealthy

{
  "status": "unhealthy",
  "database": "unavailable",
  "queues": "operational"
}

​
Response Fields

FieldTypeDescription
statusstringOverall health status: “healthy” or “unhealthy”
databasestringDatabase status: “operational” or “unavailable”
queuesstringMessage queue status: “operational” or “unavailable”

​
Health Status Logic

  • The service is considered healthy only if both database and queues are operational
  • If either database or queues are unavailable, the service returns a 503 status code
  • This endpoint is useful for load balancer health checks and monitoring

​
Notes

  • No authentication is required for this endpoint
  • Returns 200 OK if all systems are operational
  • Returns 503 Service Unavailable if any system is down
  • Useful for monitoring and automated health checks