Sign in
providers

Get circuit breaker status for a specific provider.

Returns the current state and failure count for the specified provider's circuit breaker.

get/admin/v1/providers/{provider_name}/circuit-breaker

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}/circuit-breaker
  • Auth: HTTP bearer

Path parameters

provider_namestring required

Provider name

Response

Circuit breaker status for the provider

failure_countinteger required

Number of consecutive failures (only relevant in Closed state).

providerstring required

Provider name.

statestring required

Circuit breaker state (closed, open, half_open).

Changes

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