Skip to content
Authrim

Get tenant database health

GET
/api/admin/logging-policies/runtime/tenant-db-health
Code sample: Shell / cURL 
curl --request GET \
  --url 'https://auth.example.com/api/admin/logging-policies/runtime/tenant-db-health?role=tenant_core' \
  --header 'Authorization: Bearer <token>'

Inspect tenant database routing pointers, registry rows, binding availability, and derived health state.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
tenant_id
string

Tenant id filter. Platform admins can supply another tenant; tenant-scoped admins are constrained to their current tenant.

filter[tenant_id]
string

Alternative tenant id filter syntax.

role
string
Allowed values: tenant_core tenant_pii tenant_audit tenant_custom

Tenant database role filter.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful JSON response.

Media type application/json
object
item
required
object
key
additional properties
key
additional properties
Example 
{
  "item": {
    "tenant_id": "tenant_123",
    "role": null,
    "items": [
      {
        "tenant_id": "tenant_123",
        "role": "tenant_core",
        "shard_group": "default",
        "generation": 1,
        "registry_status": "active",
        "binding_ref": "DB",
        "binding_configured": {},
        "health_state": "healthy"
      }
    ],
    "summary": {
      "healthy": 1,
      "degraded": 0,
      "failed": 0,
      "missing_registry": 0,
      "missing_binding": 0
    },
    "checked_at": 1770000000
  }
}

default

Section titled “default ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}