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.

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

Query parameters

h union oneOf

A comma-separated list of columns names to display. It supports simple wildcards.

Supported values include:

node_id (or id): Persistent node ID
node_name (or nn): Node name
breaker (or br): Breaker name
limit (or l): Limit size
limit_bytes (or lb): Limit size in bytes
estimated (or e): Estimated size
estimated_bytes (or eb): Estimated size in bytes
tripped (or t): Tripped count
overhead (or o): Overhead

Values: node_id id node_name nn breaker br limit l limit_bytes lb estimated e estimated_bytes eb tripped t overhead o

s union oneOf

List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.

One of: string[] or string

local boolean · default: false

If true, the request computes the list of selected nodes from the local cluster state. If false the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node.

master_timeout string · default: 30s

Period to wait for a connection to the master node.

format string · default: text

Specifies the format to return the columnar data in, can be set to text, json, cbor, yaml, or smile.

help boolean · default: false

When set to true will output available columns. This option can't be combined with any other query string option.

v boolean · default: false

When set to true will enable verbose output.

bytes enum

Sets the units for columns that contain a byte-size value. Note that byte-size value units work in terms of powers of 1024. For instance 1kb means 1024 bytes, not 1000 bytes. If omitted, byte-size values are rendered with a suffix such as kb, mb, or gb, chosen such that the numeric value of the column is as small as possible whilst still being at least 1.0. If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit. Values that are not an exact multiple of the chosen unit are rounded down.

Values: b kb mb gb tb pb

time enum

Sets the units for columns that contain a time duration. If omitted, time duration values are rendered with a suffix such as ms, s, m or h, chosen such that the numeric value of the column is as small as possible whilst still being at least 1.0. If given, time duration values are rendered as an integer with no suffix. Values that are not an exact multiple of the chosen unit are rounded down.

Values: nanos micros ms s m h d

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

Get circuit breakers statistics

Required authorization

Authentication

Path parameters

Query parameters

Response