Get index information
Returns high-level information about indices in a cluster, including backing indices for data streams.
Use this request to get the following information for each index in a cluster:
- shard count
- document count
- deleted document count
- primary store size
- total store size of all shards, including shard replicas
These metrics are retrieved directly from Lucene, which Elasticsearch uses internally to power indexing and search. As a result, all document counts include hidden nested documents. To get an accurate count of Elasticsearch documents, use the cat count or count APIs.
CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use an index endpoint.
Path parameters
-
Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (
*). To target all data streams and indices, omit this parameter or use*or_all.
Query parameters
-
bytes string
The unit used to display byte values.
Values are
b,kb,mb,gb,tb, orpb. -
expand_wildcards string | array[string]
The type of index that wildcard patterns can match.
-
health string
The health status used to limit returned indices. By default, the response includes indices of any health status.
Values are
green,GREEN,yellow,YELLOW,red, orRED. -
include_unloaded_segments boolean
If true, the response includes information from segments that are not loaded into memory.
-
pri boolean
If true, the response only includes information from primary shards.
-
time string
The unit used to display time values.
Values are
nanos,micros,ms,s,m,h, ord.
curl \
-X GET http://api.example.com/_cat/indices/{index}[
{
"health": "string",
"status": "string",
"index": "string",
"uuid": "string",
"pri": "string",
"rep": "string",
"docs.count": "string",
"docs.deleted": "string",
"creation.date": "string",
"creation.date.string": "string",
"store.size": "string",
"pri.store.size": "string",
"dataset.size": "string",
"completion.size": "string",
"pri.completion.size": "string",
"fielddata.memory_size": "string",
"pri.fielddata.memory_size": "string",
"fielddata.evictions": "string",
"pri.fielddata.evictions": "string",
"query_cache.memory_size": "string",
"pri.query_cache.memory_size": "string",
"query_cache.evictions": "string",
"pri.query_cache.evictions": "string",
"request_cache.memory_size": "string",
"pri.request_cache.memory_size": "string",
"request_cache.evictions": "string",
"pri.request_cache.evictions": "string",
"request_cache.hit_count": "string",
"pri.request_cache.hit_count": "string",
"request_cache.miss_count": "string",
"pri.request_cache.miss_count": "string",
"flush.total": "string",
"pri.flush.total": "string",
"flush.total_time": "string",
"pri.flush.total_time": "string",
"get.current": "string",
"pri.get.current": "string",
"get.time": "string",
"pri.get.time": "string",
"get.total": "string",
"pri.get.total": "string",
"get.exists_time": "string",
"pri.get.exists_time": "string",
"get.exists_total": "string",
"pri.get.exists_total": "string",
"get.missing_time": "string",
"pri.get.missing_time": "string",
"get.missing_total": "string",
"pri.get.missing_total": "string",
"indexing.delete_current": "string",
"pri.indexing.delete_current": "string",
"indexing.delete_time": "string",
"pri.indexing.delete_time": "string",
"indexing.delete_total": "string",
"pri.indexing.delete_total": "string",
"indexing.index_current": "string",
"pri.indexing.index_current": "string",
"indexing.index_time": "string",
"pri.indexing.index_time": "string",
"indexing.index_total": "string",
"pri.indexing.index_total": "string",
"indexing.index_failed": "string",
"pri.indexing.index_failed": "string",
"merges.current": "string",
"pri.merges.current": "string",
"merges.current_docs": "string",
"pri.merges.current_docs": "string",
"merges.current_size": "string",
"pri.merges.current_size": "string",
"merges.total": "string",
"pri.merges.total": "string",
"merges.total_docs": "string",
"pri.merges.total_docs": "string",
"merges.total_size": "string",
"pri.merges.total_size": "string",
"merges.total_time": "string",
"pri.merges.total_time": "string",
"refresh.total": "string",
"pri.refresh.total": "string",
"refresh.time": "string",
"pri.refresh.time": "string",
"refresh.external_total": "string",
"pri.refresh.external_total": "string",
"refresh.external_time": "string",
"pri.refresh.external_time": "string",
"refresh.listeners": "string",
"pri.refresh.listeners": "string",
"search.fetch_current": "string",
"pri.search.fetch_current": "string",
"search.fetch_time": "string",
"pri.search.fetch_time": "string",
"search.fetch_total": "string",
"pri.search.fetch_total": "string",
"search.open_contexts": "string",
"pri.search.open_contexts": "string",
"search.query_current": "string",
"pri.search.query_current": "string",
"search.query_time": "string",
"pri.search.query_time": "string",
"search.query_total": "string",
"pri.search.query_total": "string",
"search.scroll_current": "string",
"pri.search.scroll_current": "string",
"search.scroll_time": "string",
"pri.search.scroll_time": "string",
"search.scroll_total": "string",
"pri.search.scroll_total": "string",
"segments.count": "string",
"pri.segments.count": "string",
"segments.memory": "string",
"pri.segments.memory": "string",
"segments.index_writer_memory": "string",
"pri.segments.index_writer_memory": "string",
"segments.version_map_memory": "string",
"pri.segments.version_map_memory": "string",
"segments.fixed_bitset_memory": "string",
"pri.segments.fixed_bitset_memory": "string",
"warmer.current": "string",
"pri.warmer.current": "string",
"warmer.total": "string",
"pri.warmer.total": "string",
"warmer.total_time": "string",
"pri.warmer.total_time": "string",
"suggest.current": "string",
"pri.suggest.current": "string",
"suggest.time": "string",
"pri.suggest.time": "string",
"suggest.total": "string",
"pri.suggest.total": "string",
"memory.total": "string",
"pri.memory.total": "string",
"search.throttled": "string",
"bulk.total_operations": "string",
"pri.bulk.total_operations": "string",
"bulk.total_time": "string",
"pri.bulk.total_time": "string",
"bulk.total_size_in_bytes": "string",
"pri.bulk.total_size_in_bytes": "string",
"bulk.avg_time": "string",
"pri.bulk.avg_time": "string",
"bulk.avg_size_in_bytes": "string",
"pri.bulk.avg_size_in_bytes": "string"
}
]