Skip to content

Fetch tenant health diagnostics snapshot

GET/tenants/{tenant_id}/health

Returns the most recent health diagnostics snapshot for the tenant, including module SLO status, connector health, provisioning sync run status, and evidence package readiness. Use to triage production incidents or generate tenant health reports.

Request

Path parameters

NameTypeRequiredDescription
tenant_idstringYes

The tenant identifier.

Responses

200 Tenant health diagnostics snapshot

Content type application/json, object · TenantHealthSnapshotV1.

FieldTypeRequiredDescription
tenant_idstringNo
health_scoreintegerNo

Aggregate health score from 0 (critical) to 100 (fully healthy).

Minimum: 0 · Maximum: 100

captured_atstring (date-time)No
module_slosarray of objectNo

Per-module SLO status rows.

module_slos[].modulestringNo

Module slug.

module_slos[].namestringNo
module_slos[].enabledbooleanNo
module_slos[].target_availability_pctnumberNo

SLA availability target (99.9 for critical modules, 99.5 for standard).

module_slos[].current_health_scoreintegerNo
module_slos[].statusstringNo

"meeting_slo" — health >= 95%. "watch" — health between 80-95%. "breach" — health below 80%. "disabled" — module is not active for this tenant.

One of: "meeting_slo", "watch", "breach", "disabled"

connector_healthobjectNo

Integration connector health summary and per-connector status.

evidence_packagesarray of objectNo

Compliance evidence package readiness (used for SOC 2 and access reviews).

evidence_packages[].keystringNo
evidence_packages[].labelstringNo
evidence_packages[].statusstringNo

One of: "ready", "attention_required", "empty", "missing"

evidence_packages[].countinteger, nullableNo

Example

{
  "tenant_id": "acme",
  "health_score": 97,
  "captured_at": "2026-04-08T09:00:00Z",
  "module_slos": [
    {
      "module": "sales",
      "enabled": true,
      "target_availability_pct": 99.9,
      "current_health_score": 97,
      "status": "meeting_slo"
    }
  ],
  "connector_health": {
    "summary": {
      "connector_count": 3,
      "active_connectors": 3,
      "error_connectors": 0,
      "deliveries_total": 1842,
      "failed_deliveries_last_24h": 0
    }
  },
  "evidence_packages": [
    {
      "key": "audit_chain",
      "label": "Audit chain verification",
      "status": "ready",
      "count": 4820
    }
  ]
}

404 Tenant not found

Example request

Paths are relative to the control-plane API base URL ($BASE_URL below).

curl -X GET "$BASE_URL/tenants/{tenant_id}/health" \
  -H "Accept: application/json"
Loading