Skip to content

Health

GET /health

Check API service health and database connectivity.

bash
curl https://mainnet.api.ryze.pro/api/health

Response 200

json
{
  "ok": true,
  "status": "healthy",
  "service": "ryze-api",
  "timestamp": "2026-04-15T12:00:00.000Z",
  "uptime": 86400,
  "version": "0.0.1",
  "database": {
    "status": "connected",
    "message": "Elasticsearch cluster is healthy"
  }
}

Response 503

json
{
  "ok": false,
  "status": "unhealthy",
  "service": "ryze-api",
  "timestamp": "2026-04-15T12:00:00.000Z",
  "uptime": 86400,
  "version": "0.0.1",
  "database": {
    "status": "disconnected",
    "error": "Connection refused"
  }
}

Fields

FieldTypeDescription
okbooleanOverall health status
statusstring"healthy" or "unhealthy"
servicestringAlways "ryze-api"
timestampstringISO 8601 timestamp
uptimenumberSeconds since service start
versionstringAPI version
database.statusstring"connected" or "disconnected"
database.messagestringStatus details (healthy)
database.errorstringError details (unhealthy)