Sign in
providers

Get health status for a specific provider.

Returns the current health status for the specified provider. Only works for providers that have health checks enabled.

get/admin/v1/providers/{provider_name}/health

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /admin/v1/providers/{provider_name}/health
  • Auth: HTTP bearer

Path parameters

provider_namestring required

Provider name

Response

Health status for the provider

consecutive_failuresinteger required

Number of consecutive failures.

consecutive_successesinteger required

Number of consecutive successes.

errorstring nullable

Error message from the last failed health check.

last_checkstring date-time required

Time of the last health check.

latency_msinteger required

Latency of the last health check in milliseconds.

providerstring required

Provider name.

status'healthy' | 'unhealthy' | 'unknown' required

Status of a provider's health.

status_codeinteger nullable

HTTP status code from the last health check.

Changes

No recorded changes to this operation across all 1 revision of this API.