ChangeVault
API Reference

Health check

Verify that the ChangeVault API is reachable from external systems.

Health check

GET /api/health

Public endpoint — no API key required. Returns the current status of the API and database connectivity. Use this from uptime monitors, load balancers, or CI pipelines to verify the service is reachable.

Example

curl https://app.changevault.dev/api/health

Response — healthy

{
  "status": "ok",
  "db": "reachable",
  "latency_ms": 12,
  "timestamp": "2025-04-07T10:00:00.000Z"
}

HTTP status: 200

Response — degraded

{
  "status": "degraded",
  "db": "unreachable",
  "error": "..."
}

HTTP status: 503


Usage examples

curl with exit code check

curl -sf https://app.changevault.dev/api/health || echo "ChangeVault is down"

GitHub Actions step

- name: Check ChangeVault health
  run: |
    curl -sf https://app.changevault.dev/api/health

On this page