# Elastic Cat API

**Canonical:** https://apis.io/apis/elastic/elastic-cat-api/  
**Provider:** Elastic — https://apis.io/providers/elastic/  
**Base URL:** https://api.elastic-cloud.com  
**Documentation:** https://www.elastic.co/docs/api/doc/elasticsearch

Elastic Cat API is one of 50 APIs that [Elastic](https://apis.io/providers/elastic/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 1 JSON Schema definition. Tagged areas include Cat. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 1 JSON Schema.

The compact and aligned text (CAT) APIs aim are intended only for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, it's recommend to use a corresponding JSON API. All the cat commands accept a query string parameter `help` to see all the headers and info they provide, and the `/_cat` command alone lists all the available commands.

## Operations (47)

| Method | Path | Summary |
|---|---|---|
| GET | `/_cat/aliases` | Get aliases |
| GET | `/_cat/aliases/{name}` | Get aliases |
| GET | `/_cat/allocation` | Get shard allocation information |
| GET | `/_cat/allocation/{node_id}` | Get shard allocation information |
| GET | `/_cat/circuit_breaker` | Get circuit breakers statistics |
| GET | `/_cat/circuit_breaker/{circuit_breaker_patterns}` | Get circuit breakers statistics |
| GET | `/_cat/component_templates` | Get component templates |
| GET | `/_cat/component_templates/{name}` | Get component templates |
| GET | `/_cat/count` | Get a document count |
| POST | `/_cat/count` | Get a document count |
| GET | `/_cat/count/{index}` | Get a document count |
| POST | `/_cat/count/{index}` | Get a document count |
| GET | `/_cat/fielddata` | Get field data cache information |
| GET | `/_cat/fielddata/{fields}` | Get field data cache information |
| GET | `/_cat/health` | Get the cluster health status |
| GET | `/_cat` | Get CAT help |
| GET | `/_cat/indices` | Get index information |
| GET | `/_cat/indices/{index}` | Get index information |
| GET | `/_cat/master` | Get master node information |
| GET | `/_cat/ml/data_frame/analytics` | Get data frame analytics jobs |
| GET | `/_cat/ml/data_frame/analytics/{id}` | Get data frame analytics jobs |
| GET | `/_cat/ml/datafeeds` | Get datafeeds |
| GET | `/_cat/ml/datafeeds/{datafeed_id}` | Get datafeeds |
| GET | `/_cat/ml/anomaly_detectors` | Get anomaly detection jobs |
| GET | `/_cat/ml/anomaly_detectors/{job_id}` | Get anomaly detection jobs |
| GET | `/_cat/ml/trained_models` | Get trained models |
| GET | `/_cat/ml/trained_models/{model_id}` | Get trained models |
| GET | `/_cat/nodeattrs` | Get node attribute information |
| GET | `/_cat/nodes` | Get node information |
| GET | `/_cat/pending_tasks` | Get pending task information |
| GET | `/_cat/plugins` | Get plugin information |
| GET | `/_cat/recovery` | Get shard recovery information |
| GET | `/_cat/recovery/{index}` | Get shard recovery information |
| GET | `/_cat/repositories` | Get snapshot repository information |
| GET | `/_cat/segments` | Get segment information |
| GET | `/_cat/segments/{index}` | Get segment information |
| GET | `/_cat/shards` | Get shard information |
| GET | `/_cat/shards/{index}` | Get shard information |
| GET | `/_cat/snapshots` | Get snapshot information |
| GET | `/_cat/snapshots/{repository}` | Get snapshot information |
| GET | `/_cat/tasks` | Get task information |
| GET | `/_cat/templates` | Get index template information |
| GET | `/_cat/templates/{name}` | Get index template information |
| GET | `/_cat/thread_pool` | Get thread pool statistics |
| GET | `/_cat/thread_pool/{thread_pool_patterns}` | Get thread pool statistics |
| GET | `/_cat/transforms` | Get transform information |
| GET | `/_cat/transforms/{transform_id}` | Get transform information |

## Machine-readable artifacts (5)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/elastic/refs/heads/main/openapi/elastic-cat-api-openapi.yml
- **Documentation** — https://www.elastic.co/docs/api/doc/elasticsearch
- **Documentation** — https://www.elastic.co/docs/api/doc/kibana
- **Documentation** — https://www.elastic.co/docs/api/doc/cloud
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/elastic/refs/heads/main/json-schema/elastic-saved-object-schema.json

## Other Elastic APIs (12)

- [Elastic Account API](https://apis.io/apis/elastic/elastic-account-api/)
- [Elastic Cluster API](https://apis.io/apis/elastic/elastic-cluster-api/)
- [Elastic Deployments API](https://apis.io/apis/elastic/elastic-deployments-api/)
- [Elastic Documents API](https://apis.io/apis/elastic/elastic-documents-api/)
- [Elastic Indices API](https://apis.io/apis/elastic/elastic-indices-api/)
- [Elastic Search API](https://apis.io/apis/elastic/elastic-search-api/)
- [Elastic Security API](https://apis.io/apis/elastic/elastic-security-api/)
- [Elastic Spaces API](https://apis.io/apis/elastic/elastic-spaces-api/)
- [Elastic Status API](https://apis.io/apis/elastic/elastic-status-api/)
- [Elastic TrafficFilters API](https://apis.io/apis/elastic/elastic-trafficfilters-api/)
- [Elastic Analytics API](https://apis.io/apis/elastic/elastic-analytics-api/)
- [Elastic Ccr API](https://apis.io/apis/elastic/elastic-ccr-api/)

## Tags

Cat

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/elastic/elastic-cat-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/elastic/.