Get circuit breakers statistics

GET /_cat/circuit_breaker/{circuit_breaker_patterns}
GET /_cat/circuit_breaker

IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.

Required authorization

Cluster privileges: monitor

Path Parameters

circuit_breaker_patterns union string | [] string optional

A comma-separated list of regular-expressions to filter the circuit breakers in the output

Leave it out to use /_cat/circuit_breaker.

Query Parameters

Response

application/json

Examples

A successful response from GET /_cat/circuit_breaker?v=true&format=json. It shows two circuit breakers are active on one node.

Request Console 1 / 6 languages

Console Kibana Dev Tools

GET /_cat/circuit_breaker?v=true&format=json

JavaScript Elasticsearch JavaScript Client

const response = await client.cat.circuitBreaker({
  v: "true",
  format: "json",
});

Python Elasticsearch Python Client

resp = client.cat.circuit_breaker(
    v=True,
    format="json",
)

curl Shell

curl -X GET "$ELASTICSEARCH_URL/_cat/circuit_breaker?v=true&format=json" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

PHP Elasticsearch PHP Client

$resp = $client->cat()->circuitBreaker([
    "v" => "true",
    "format" => "json",
]);

Ruby Elasticsearch Ruby Client

response = client.cat.circuit_breaker(
  v: "true",
  format: "json"
)

Response

[
  {
    "breaker": "request",
    "estimated": "0b",
    "limit": "614.3mb",
    "node_id": "ozKxpP9oS3SL0Sp-Mfxc6w",
    "tripped": "0"
  },
  {
    "breaker": "fielddata",
    "estimated": "0b",
    "limit": "409.5mb",
    "node_id": "ozKxpP9oS3SL0Sp-Mfxc6w",
    "tripped": "0"
  }
]

Required authorization

Path Parameters

Query Parameters { h , s , local , master_timeout , }

Response

Query Parameters