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

Authentication

Api key

Authorization: <value>

Elasticsearch APIs support key-based authentication. You must create an API key and use the encoded value in the request header. For example:

		curl -X GET "${ES_URL}/_cat/indices?v=true" \
  -H "Authorization: ApiKey ${API_KEY}"

To get API keys, use the /_security/api_key APIs.

Basic

Authorization: Basic <credentials>

Bearer

Authorization: Bearer <token>

Elasticsearch APIs support the use of bearer tokens in the Authorization HTTP header to authenticate with the API. For examples, refer to Token-based authentication services

Path parameters

Query parameters

Response

application/json

Examples

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

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

[
  {
    "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"
  }
]