Health Reference

Arboris exposes health checks for different purposes. Use the versioned backend health endpoint for public app/API availability checks.

Public Backend Health

GET https://app.arborisanalytics.com/api/v1/health

This endpoint does not require authentication.

Healthy response:

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

The endpoint checks PostgreSQL and Redis. It also reports embedding-model health.

Degraded Responses

If the optional embedding runtime is unavailable, Arboris can report degraded embedding health while keeping the API ready.

{
  "status": "degraded",
  "db": "ok",
  "redis": "ok",
  "embedding_model": "error"
}

If PostgreSQL or Redis is unavailable, the endpoint reports degraded state and returns an unavailable status.

Liveness Health

The backend also has a lightweight liveness check at /health that returns:

{
  "status": "ok"
}

That endpoint is intended for process liveness and does not check database, Redis, or embedding health.

On the public customer-app domain, the /health path can be handled by the SPA shell depending on routing. For public API verification, use /api/v1/health.

When To Use Each Check

Check	Use it for
/api/v1/health	Public API readiness, deploy checks, monitoring, and dependency diagnostics.
/health	Internal liveness where it is routed directly to the backend process.

For a customer-visible issue, the health endpoint is only one signal. Also check whether login, workspace routes, QuickBooks sync, and report export are affected.