---
type: api
title: Get circuit breakers statistics
description: **All methods and paths for this operation:**
url: https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-cat-circuit-breaker
resource: https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-cat-circuit-breaker
products:
  - Elasticsearch
---

# Get circuit breakers statistics


Availability:

## Paths

- `GET` `/_cat/circuit_breaker/{circuit_breaker_patterns}`
- `GET` `/_cat/circuit_breaker`

- [Api key auth](/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/authentication#apikeyauth)
- [Basic auth](/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/authentication#basicauth)
- [Bearer auth](/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/authentication#bearerauth)

#### Path Parameters

- `circuit_breaker_patterns` (union string | [] string) — optional, leave it out to use `/_cat/circuit_breaker`
  A comma-separated list of regular-expressions to filter the circuit breakers in the output

## Description

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`

## Query String Parameters

- `h` (union CatCircuitBreakerColumns)
  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 Names)
  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: `Name` or `Name[]`
- `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 Duration · default: 30s)
  Period to wait for a connection to the master node.

## Response

`application/json`

Type: `[] CircuitBreakerRecord`

- `node_id` (string)
  Persistent node ID
- `node_name` (string)
  Node name
- `breaker` (string)
  Breaker name
- `limit` (string)
  Limit size
- `limit_bytes` (number | string ByteSize)
  Limit size in bytes
- `estimated` (string)
  Estimated size
- `estimated_bytes` (number | string ByteSize)
  Estimated size in bytes
- `tripped` (string)
  Tripped count
- `overhead` (string)
  Overhead
## Code Examples

#### Console

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

#### JavaScript

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

#### Python

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

#### curl

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

#### PHP

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

#### Ruby

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

## Response Examples

#### Cat circuit breaker response example1

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

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