Public docs

GET /health · GET /version

Service availability and version checks.

Phase 1 shell: this docs surface is wired to the existing backend and repo documentation, and will be expanded as the private dashboard comes online.

GET /health

Confirms the API is running and the database is reachable. Use this for connectivity checks, startup verification, and health monitoring.

Public — no API key required.

curl https://api.opsentry.ai/health

Response:

{ "status": "ok", "db": "ok" }

---

GET /version

Returns the currently deployed API version string.

Requires: X-API-Key

curl https://api.opsentry.ai/version -H "X-API-Key: YOUR_API_KEY"

Response:

{ "version": "0.1.0" }

---

Usage notes

These endpoints are useful for:

  • CI/CD pipeline health checks
  • Environment validation before running integration tests
  • Confirming which release version is deployed