Getting the circuit breaker status of a gateway¶

Note

The Admin API requires no token. The Admin API is typically protected at the network level.

Send the request as GET to the path /admin/v1/gateways/{gateway_id}/circuit-breaker.

Description¶

Returns the current circuit breaker state for each provider that has been seen by this gateway. Each entry includes state (closed, open, or half-open), failure count, and the timestamp when the circuit opened (if applicable).

Request¶

The following parameters are available:

Parameter	In	Type	Required	Description
`gateway_id`	path	`string`	yes	ID of the gateway.

Example¶

Example of the response body:

{
  "key": {
    "state": "closed",
    "failures": 0,
    "opened_at": 0
  }
}

Responses¶

The endpoint answers the request with the following status codes:

Status code	Description
`200`	Circuit breaker state per provider.