---
type: api
title: Compact and aligned text (CAT)
description: 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.
url: https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/group/endpoint-cat
resource: https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/group/endpoint-cat
products:
  - Elasticsearch
---

# Compact and aligned text (CAT)

`cat`

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.

- [Get aliases
](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-cat-aliases): `GET` `/_cat/aliases/{name}`, `GET` `/_cat/aliases`
- [Get shard allocation information
](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-cat-allocation): `GET` `/_cat/allocation/{node_id}`, `GET` `/_cat/allocation`
- [Get circuit breakers statistics
](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-cat-circuit-breaker): `GET` `/_cat/circuit_breaker/{circuit_breaker_patterns}`, `GET` `/_cat/circuit_breaker`
- [Get component templates
](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-cat-component-templates): `GET` `/_cat/component_templates/{name}`, `GET` `/_cat/component_templates`
- [Get a document count
](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-cat-count): `POST` (also `GET`) `/_cat/count/{index}`, `POST` (also `GET`) `/_cat/count`
- [Get field data cache information
](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-cat-fielddata): `GET` `/_cat/fielddata/{fields}`, `GET` `/_cat/fielddata`
- [Get the cluster health status](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-cat-health): `GET` `/_cat/health`
- [Get CAT help](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-cat-help): `GET` `/_cat`
- [Get index information
](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-cat-indices): `GET` `/_cat/indices/{index}`, `GET` `/_cat/indices`
- [Get master node information](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-cat-master): `GET` `/_cat/master`
- [Get data frame analytics jobs
](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-cat-ml-data-frame-analytics): `GET` `/_cat/ml/data_frame/analytics/{id}`, `GET` `/_cat/ml/data_frame/analytics`
- [Get datafeeds
](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-cat-ml-datafeeds): `GET` `/_cat/ml/datafeeds/{datafeed_id}`, `GET` `/_cat/ml/datafeeds`
- [Get anomaly detection jobs
](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-cat-ml-jobs): `GET` `/_cat/ml/anomaly_detectors/{job_id}`, `GET` `/_cat/ml/anomaly_detectors`
- [Get trained models
](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-cat-ml-trained-models): `GET` `/_cat/ml/trained_models/{model_id}`, `GET` `/_cat/ml/trained_models`
- [Get node attribute information](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-cat-nodeattrs): `GET` `/_cat/nodeattrs`
- [Get node information](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-cat-nodes): `GET` `/_cat/nodes`
- [Get pending task information](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-cat-pending-tasks): `GET` `/_cat/pending_tasks`
- [Get plugin information](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-cat-plugins): `GET` `/_cat/plugins`
- [Get shard recovery information
](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-cat-recovery): `GET` `/_cat/recovery/{index}`, `GET` `/_cat/recovery`
- [Get snapshot repository information](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-cat-repositories): `GET` `/_cat/repositories`
- [Get segment information
](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-cat-segments): `GET` `/_cat/segments/{index}`, `GET` `/_cat/segments`
- [Get shard information
](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-cat-shards): `GET` `/_cat/shards/{index}`, `GET` `/_cat/shards`
- [Get snapshot information
](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-cat-snapshots): `GET` `/_cat/snapshots/{repository}`, `GET` `/_cat/snapshots`
- [Get task information](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-cat-tasks): `GET` `/_cat/tasks`
- [Get index template information
](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-cat-templates): `GET` `/_cat/templates/{name}`, `GET` `/_cat/templates`
- [Get thread pool statistics
](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-cat-thread-pool): `GET` `/_cat/thread_pool/{thread_pool_patterns}`, `GET` `/_cat/thread_pool`
- [Get transform information
](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-cat-transforms): `GET` `/_cat/transforms/{transform_id}`, `GET` `/_cat/transforms`
