Skip to main content
Version: v0.1.0

Checks API

API for system health checks.

Overview​

The Checks API allows you to perform health checks on the D.Hub system and its connected services.

Endpoints​

GET /api/v1/checks/health​

Performs a system health check.

Response​

200 OK

{
  "status": "healthy",
  "timestamp": "2024-01-20T10:30:00Z"
}

GET /api/v1/checks/prefect​

Checks the Prefect workflow engine status.

Response​

200 OK

{
  "connected": true,
  "version": "3.x.x",
  "api_url": "http://prefect-server:4200/api"
}

GET /api/v1/checks/storage​

Checks the object storage (S3/MinIO) status.

Response​

200 OK

{
  "connected": true,
  "endpoint": "http://minio:9000",
  "buckets": ["manifests", "tables", "objects"]
}

GET /api/v1/checks/clickhouse​

Checks the analytics database status.

Response​

200 OK

{
  "connected": true,
  "version": "24.x.x",
  "host": "clickhouse:8123"
}

GET /api/v1/checks/neo4j​

Checks the graph database status.

Response​

200 OK

{
  "connected": true,
  "version": "5.x.x",
  "database": "neo4j"
}

Usage Examples​

# Full health check
curl https://api.dhub.io/api/v1/checks/health \
  -H "Authorization: Bearer <access_token>"

# Prefect status check
curl https://api.dhub.io/api/v1/checks/prefect \
  -H "Authorization: Bearer <access_token>"
Monitoring Integration

You can integrate the health check endpoints with Kubernetes liveness/readiness probes or external monitoring systems to continuously monitor system health.