List Provider Health Records — GET /v1/health/providers

Retrieve health metrics for all providers including online status, latency, and success/failure counts derived from invocation history.

Returns a health record for every known provider, aggregated from invocation history across all their agents. Use this endpoint to assess overall provider reliability.

Response

Returns { "items": [ProviderHealthRecord] }.

items · array

Array of ProviderHealthRecord objects, one per known provider.

Show ProviderHealthRecord

provider_id · string · required

The unique identifier of the provider.

status · string · required

Current health status. One of unknown, online, degraded, or offline.

last_seen_at · string (ISO 8601)

UTC timestamp of the most recent successful invocation across any of this provider’s agents. Absent if no successful invocation has occurred.

last_latency_ms · integer

Round-trip latency in milliseconds for the provider’s most recent invocation. Absent if unavailable.

success_count · integer · required

Total number of successful invocations recorded across all agents under this provider.

failure_count · integer · required

Total number of failed invocations recorded across all agents under this provider.

success_rate · number (float) · required

Ratio of successful invocations to total invocations, in the range [0.0, 1.0].

updated_at · string (ISO 8601) · required

UTC timestamp when this health record was last updated.

Example

curl http://your-node:8042/v1/health/providers

Example response

{
  "items": [
    {
      "provider_id": "acme-labs",
      "status": "online",
      "last_seen_at": "2025-01-15T10:30:02Z",
      "last_latency_ms": 298,
      "success_count": 1204,
      "failure_count": 11,
      "success_rate": 0.9909,
      "updated_at": "2025-01-15T10:30:02Z"
    },
    {
      "provider_id": "beta-provider",
      "status": "degraded",
      "last_seen_at": "2025-01-15T09:45:00Z",
      "last_latency_ms": 4200,
      "success_count": 88,
      "failure_count": 32,
      "success_rate": 0.7333,
      "updated_at": "2025-01-15T09:45:00Z"
    }
  ]
}