Compact and aligned text (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 a compact list of aliases
- GET /_cat/aliases/{name}
-
Get shard allocation information
- GET /_cat/allocation/{node_id}
-
Get a compact list of component templates
- GET /_cat/component_templates/{name}
-
Get a document count
- GET /_cat/count/{index}
-
Get field data cache information
- GET /_cat/fielddata/{fields}
-
Get a compact cluster health summary
- GET /_cat/health
-
Get CAT help
- GET /_cat
-
Get a compact list of indices
- GET /_cat/indices/{index}
-
Get master node information
- GET /_cat/master
-
Get data frame analytics jobs
- GET /_cat/ml/data_frame/analytics/{id}
-
Get datafeeds
- GET /_cat/ml/datafeeds/{datafeed_id}
-
Get anomaly detection jobs
- GET /_cat/ml/anomaly_detectors/{job_id}
-
Get trained models
- GET /_cat/ml/trained_models/{model_id}
-
Get node attribute information
- GET /_cat/nodeattrs
-
Get a compact list of nodes
- GET /_cat/nodes
-
Get pending task information
- GET /_cat/pending_tasks
-
Get plugin information
- GET /_cat/plugins
-
Get shard recovery information
- GET /_cat/recovery/{index}
-
Get a compact list of snapshot repositories
- GET /_cat/repositories
-
Get segment information
- GET /_cat/segments/{index}
-
Get shard information
- GET /_cat/shards/{index}
-
Get a compact list of snapshots
- GET /_cat/snapshots/{repository}
-
Get a compact list of running tasks
- GET /_cat/tasks
-
Get index template information
- GET /_cat/templates/{name}
-
Get thread pool statistics
- GET /_cat/thread_pool/{thread_pool_patterns}
-
Get transform information
- GET /_cat/transforms/{transform_id}