Elastic Stack (ELK Stack) Cat API
The cat API from Elastic Stack (ELK Stack) — 45 operation(s) for cat.
Operations 47
Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay
Ask an LLM
“What index aliases exist across my Elasticsearch cluster?”
“Can I see the filter and routing settings for every alias at once?”
Tell an agent
Show me every index alias in the cluster as a table.
List all aliases sorted by {sort_columns}.
Ask an LLM
“Which indices does a particular alias point to?”
“How can I check the routing and filter of one named alias?”
Tell an agent
Show the alias {alias_name} and the indices behind it.
Display only the columns {columns} for aliases matching {alias_name}.
GET
/_cat/allocation
Show shard allocation and disk use per node · Get shard allocation information
#
Ask an LLM
“How many shards are allocated to each data node right now?”
“Which nodes are running low on disk space for shards?”
Tell an agent
Show shard counts and disk usage for all data nodes.
List shard allocation across nodes sorted by {sort_columns}.
GET
/_cat/allocation/{node_id}
Show shard allocation for specific nodes · Get shard allocation information
#
Ask an LLM
“How much disk does one particular node use for its shards?”
“Can I check shard allocation for just a single data node?”
Tell an agent
Show shard allocation and disk space for node {node_id}.
Report the shard count on nodes {node_id} using the local cluster state.
Ask an LLM
“Are any circuit breakers tripping in my cluster?”
“What memory limits are the circuit breakers enforcing on each node?”
Tell an agent
Show circuit breaker stats for every node.
List all circuit breakers with columns {columns}.
GET
/_cat/circuit_breaker/{circuit_breaker_patterns}
Show stats for matching circuit breakers · Get circuit breakers statistics
#
Ask an LLM
“Can I look at only the request or fielddata circuit breaker?”
“How often has a specific circuit breaker tripped?”
Tell an agent
Show statistics for circuit breakers matching {patterns}.
Check the trip count of the {patterns} breaker.
Ask an LLM
“Which component templates are defined in my cluster?”
“What reusable building blocks exist for my index templates?”
Tell an agent
List all component templates.
Show component templates sorted by {sort_columns}.
GET
/_cat/component_templates/{name}
Show component templates matching a name · Get component templates
#
Ask an LLM
“Is there a component template with a particular name?”
“Can I filter component templates by a name pattern?”
Tell an agent
Show the component template {template_name}.
List component templates whose names match {template_name}.
Ask an LLM
“How many live documents are stored in my entire cluster?”
“Does the cluster-wide document count include deleted documents?”
Tell an agent
Give me the total document count for the cluster.
Count every document in the cluster and show columns {columns}.
Ask an LLM
“Can I fetch the cluster-wide document count with a POST instead of a GET?”
“Is there a POST form of the cat count call for the whole cluster?”
Tell an agent
Send a POST to cat count to get the cluster's total documents.
Use the POST cat count call for all indices, showing columns {columns}.
Ask an LLM
“How many documents are in one particular index or data stream?”
“Can I get a quick document count for a set of indices?”
Tell an agent
Count the documents in index {index}.
Show the live document count for data stream {index}.
Ask an LLM
“Is there a POST variant for counting documents in a named index?”
“Can I count one index's documents with POST when GET is blocked?”
Tell an agent
Use a POST request to count documents in {index}.
Send the POST cat count for index {index} with columns {columns}.
Ask an LLM
“How much heap is the field data cache using on each node?”
“Which fields are consuming the most fielddata memory?”
Tell an agent
Show field data cache usage across all data nodes.
Report fielddata heap usage for the fields {fields}.
GET
/_cat/fielddata/{fields}
Show field data cache for named fields · Get field data cache information
#
Ask an LLM
“How much fielddata memory does a single field take?”
“Can I check the fielddata cache for only a few specific fields?”
Tell an agent
Show fielddata memory used by field {fields}.
Report heap used by fielddata for {fields}, sorted by {sort_columns}.
Ask an LLM
“Is my Elasticsearch cluster green, yellow or red?”
“Can I see cluster health without the timestamp columns?”
Tell an agent
Show the cluster health status.
Check cluster health and include timestamps set to {ts}.
Ask an LLM
“What cat endpoints are available to call?”
“Where can I find a list of all the compact cat commands?”
Tell an agent
Show the cat API help listing.
List every available cat endpoint.
Ask an LLM
“Which indices in my cluster are in red or yellow health?”
“How many documents and how much storage does each index use?”
Tell an agent
List every index with its health, doc count and size.
Show all indices with health status {health}.
Ask an LLM
“What is the document count and store size of a specific index?”
“Is one particular index healthy?”
Tell an agent
Show health, docs and size for index {index}.
Show index {index} with primary-shard stats only set to {pri}.
Ask an LLM
“Which node is currently the elected master?”
“What is the IP address of my cluster's master node?”
Tell an agent
Tell me which node is the master.
Show the master node's ID, host and IP.
Ask an LLM
“What data frame analytics jobs are configured in my cluster?”
“Which of my data frame analytics jobs are running or stopped?”
Tell an agent
List all data frame analytics jobs.
Show data frame analytics jobs sorted by {sort_columns}.
GET
/_cat/ml/data_frame/analytics/{id}
Show a specific data frame analytics job · Get data frame analytics jobs
#
Ask an LLM
“What is the state of one particular data frame analytics job?”
“Can I check the memory usage of a single analytics job?”
Tell an agent
Show the data frame analytics job {job_id}.
Display columns {columns} for analytics job {job_id}.
Ask an LLM
“Which machine learning datafeeds exist and what state are they in?”
“Is there a cap on how many datafeeds the cat listing returns?”
Tell an agent
List all ML datafeeds.
Show datafeeds sorted by {sort_columns}.
Ask an LLM
“Is a particular datafeed started or stopped?”
“How many searches has one datafeed run?”
Tell an agent
Show the datafeed {datafeed_id}.
Check the state of datafeed {datafeed_id} without failing if it's missing ({allow_no_match}).
Ask an LLM
“What anomaly detection jobs are configured in my cluster?”
“Which anomaly detection jobs are open and processing data?”
Tell an agent
List all anomaly detection jobs.
Show anomaly detection jobs sorted by {sort_columns}.
GET
/_cat/ml/anomaly_detectors/{job_id}
Show a specific anomaly detection job · Get anomaly detection jobs
#
Ask an LLM
“How much memory is a particular anomaly detection job using?”
“What state is one anomaly detection job in?”
Tell an agent
Show anomaly detection job {job_id}.
Display columns {columns} for anomaly job {job_id}.
Ask an LLM
“Which trained inference models are deployed in my cluster?”
“Can I page through trained models in a compact table?”
Tell an agent
List all trained models.
Show {size} trained models starting at {from}.
Ask an LLM
“What is the configuration of one particular trained model?”
“How heavily is a single trained model being used?”
Tell an agent
Show trained model {model_id}.
Display columns {columns} for trained model {model_id}.
Ask an LLM
“What custom attributes are set on my cluster's nodes?”
“Which nodes are tagged with a hot or warm attribute?”
Tell an agent
List custom attributes on every node.
Show node attributes sorted by {sort_columns}.
Ask an LLM
“Which nodes are in my cluster and what roles do they have?”
“How much heap and CPU is each node using?”
Tell an agent
List all nodes in the cluster.
Show nodes with full node IDs set to {full_id}.
Ask an LLM
“Are there cluster state changes waiting to be applied?”
“Why is my cluster slow to apply mapping updates?”
Tell an agent
Show pending cluster tasks.
List pending tasks sorted by {sort_columns}.
Ask an LLM
“Which plugins are running on each node of my cluster?”
“Can I include bootstrap plugins in the plugin list?”
Tell an agent
List the plugins on every node.
Show plugins including bootstrap ones: {include_bootstrap}.
Ask an LLM
“Which shards are currently recovering or relocating?”
“Can I see only active shard recoveries?”
Tell an agent
Show all shard recoveries in the cluster.
Show only active recoveries: {active_only}.
GET
/_cat/recovery/{index}
Show shard recoveries for specific indices · Get shard recovery information
#
Ask an LLM
“How is the shard recovery going for one particular index?”
“Is a replica of a specific index still syncing?”
Tell an agent
Show shard recovery progress for index {index}.
Show detailed recovery info for {index}.
Ask an LLM
“Which snapshot repositories are registered in my cluster?”
“What type of storage does each snapshot repository use?”
Tell an agent
List all snapshot repositories.
Show snapshot repositories sorted by {sort_columns}.
Ask an LLM
“How many Lucene segments do my indices have?”
“Could too many small segments be slowing my searches?”
Tell an agent
Show segment information for all indices.
List segments across indices sorted by {sort_columns}.
Ask an LLM
“How many segments does one index have after a force merge?”
“What is the segment size breakdown for a particular data stream?”
Tell an agent
Show segments for index {index}.
List segments of {index}, ignoring unavailable indices ({ignore_unavailable}).
Ask an LLM
“Which shards are unassigned in my cluster?”
“Where is each primary and replica shard located?”
Tell an agent
List every shard with its state and node.
Show all shards sorted by {sort_columns}.
Ask an LLM
“On which nodes do the shards of one index live?”
“Are any shards of a particular index unassigned?”
Tell an agent
Show the shards of index {index}.
List shards for {index} with columns {columns}.
Ask an LLM
“What snapshots have been taken of my cluster?”
“When did my most recent snapshot succeed?”
Tell an agent
List all snapshots across repositories.
Show snapshots sorted by {sort_columns}.
GET
/_cat/snapshots/{repository}
List snapshots in a specific repository · Get snapshot information
#
Ask an LLM
“Which backups are stored in one particular snapshot repository?”
“Did any snapshots in a given repository fail?”
Tell an agent
List snapshots in repository {repository}.
Show snapshots from {repository} ignoring unavailable ones ({ignore_unavailable}).
Ask an LLM
“What tasks are running on my cluster right now?”
“Can I filter running tasks by action type or node?”
Tell an agent
List all currently running tasks.
Show running tasks for actions {actions}.
Ask an LLM
“Which index templates are defined in my cluster?”
“What index patterns do my index templates apply to?”
Tell an agent
List all index templates.
Show index templates sorted by {sort_columns}.
Ask an LLM
“Does an index template with a certain name exist?”
“What priority and patterns does a specific index template have?”
Tell an agent
Show the index template {template_name}.
List index templates matching {template_name}.
Ask an LLM
“Are any thread pools rejecting requests on my nodes?”
“How busy are the search and write thread pools?”
Tell an agent
Show thread pool stats for all nodes.
List thread pools sorted by {sort_columns}.
GET
/_cat/thread_pool/{thread_pool_patterns}
Show stats for specific thread pools · Get thread pool statistics
#
Ask an LLM
“How many queued tasks does the write thread pool have?”
“Can I watch just the search thread pool for rejections?”
Tell an agent
Show thread pool stats for {pools}.
Check active, queued and rejected counts for the {pools} pool.
Ask an LLM
“Which transforms are configured in my cluster?”
“Can I page through my transforms in a compact table?”
Tell an agent
List all transforms.
Show {size} transforms starting at {from}.
Ask an LLM
“Is a particular transform started, stopped or failed?”
“How many documents has one transform processed?”
Tell an agent
Show transform {transform_id}.
Display columns {columns} for transform {transform_id}.