Skip to main content

System Health

The System Health endpoint provides an authenticated, tenant-scoped operational summary for rapid diagnosis.

Get system health​

GET /api/system-health

The caller must have permission to view alerts.

The response reports:

  • Tenant API availability;
  • worker startup and readiness state;
  • depth and oldest-item age for the evaluation, fleet evaluation, notification, and external-alert durable queues;
  • an overall healthy, degraded, or unhealthy status.

Example:

{
  "observedAt": "2026-06-14T12:00:00Z",
  "overallStatus": "healthy",
  "traceId": "f2a37bcb6f8c0da8b1c9c21057b67f16",
  "components": [
    {
      "name": "tenant-api",
      "status": "healthy",
      "detail": "Tenant API is serving requests."
    }
  ],
  "queues": [
    {
      "jobType": "rule_evaluation",
      "status": "healthy",
      "depth": 0,
      "oldestAgeSeconds": 0,
      "error": null
    }
  ]
}

This endpoint is a concise troubleshooting surface. Use the deployment's metrics, traces, logs, dashboards, and alert rules for retained operational analysis.