VoidnetVoid Docs
OpenapiHealth

Health check

Check the health status of the gateway and its dependencies (database, redis). Returns 200 only when all critical dependencies are reachable, 503 otherwise.

GET/health

Check the health status of the gateway and its dependencies (database, redis). Returns 200 only when all critical dependencies are reachable, 503 otherwise.

Response Body

application/json

application/json

curl -X GET "https://example.com/health"
{
  "components": {
    "property1": "string",
    "property2": "string"
  },
  "env": "string",
  "status": "string",
  "time": "string",
  "uptime": "string",
  "version": "string"
}
{
  "error": {
    "code": "string",
    "message": "string",
    "status": 0
  }
}