TEtether
Health

Deep health check endpoint

Checks internal dependencies and blockchain indexer sync status. Returns HTTP 200 only when the overall status is healthy. Returns HTTP 503 for any non-healthy overall status (degraded or unhealthy), so readiness probes and load balancers can rely on the HTTP status code alone.

get/api/v1/health

Request

Response

Default Response

status'healthy' | 'degraded' | 'unhealthy'
timestampstring date-time
deployEnvironmentstring
deployedVersionstring

Example response

{
  "status": "healthy",
  "deployEnvironment": "production",
  "deployedVersion": "1.1.2",
  "summary": {
    "healthy": 10,
    "unhealthy": 2,
    "total": 12
  },
  "checks": {
    "dependencies": {
      "status": "healthy"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.