Health Check API

The Health Check API provides system status monitoring for operational health verification and load balancer health probes.

Overview

Data Border exposes health check endpoints that verify connectivity to critical system components:

Database: Core data store connectivity
Object Storage: Storage for labels and files

Endpoints

Basic Health Check

Returns operational status of core Data Border components.

GET /health-check

Authentication

None required. This endpoint is public for load balancer probes.

Query Parameters

Parameter	Type	Default	Description
`skipStorage`	string	`"false"`	Set to `"true"` to skip storage connectivity check

Response

All systems healthy:

{
  "success": true,
  "database": "connected",
  "storage": "connected",
  "timestamp": 1704067200000
}

Health check failed:

{
  "success": false,
  "error": "Health check failed"
}

Status: 500 Internal Server Error

Example Request

curl https://adb.example.com/health-check

Extended Health Check

Extended health check that includes backup system status verification.

GET /health-check/litestream

Authentication

None required.

Response

All systems healthy with backup:

{
  "success": true,
  "database": "connected",
  "storage": "connected",
  "litestream": "backup-found",
  "timestamp": 1704067200000
}

Backup Status Values

Value	Description
`backup-found`	Backups exist in storage (healthy)
`no-backup`	No backups found; may indicate new deployment or replication issue
`check-failed`	Unable to verify backup status; storage may be inaccessible
`skipped`	Check skipped (test environment)

Example Request

curl https://adb.example.com/health-check/litestream

Response Times

Expected response times under normal conditions:

Endpoint	Expected Time
`/health-check`	< 100ms
`/health-check?skipStorage=true`	< 10ms
`/health-check/litestream`	< 500ms

If health checks consistently exceed these times, contact your Data Border administrator to investigate storage connectivity or database performance issues.

Deployment Security - Deployment configuration