Get a compact list of indices

  • GET /_cat/indices/{index}
  • GET /_cat/indices
Auth

Get 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.

Note

Storage metrics reported by this API reflect the post-compression size of the indices on disk. Because these values are calculated after Elasticsearch compresses the data and processes deletions, they are typically significantly smaller than the raw, uncompressed data volume ingested.

Important

For Elastic Cloud Serverless, ingest billing is based on the raw, uncompressed data volume, not the post-compression metrics reported here. To learn more, refer to Elasticsearch billing dimensions.

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.

Required authorization

Index privileges monitor
Cluster privileges monitor

Path parameters

index union string | string[] optional

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.

Leave it out to use /_cat/indices.

Query parameters

expand_wildcards union oneOf · default: all

The type of index that wildcard patterns can match.

Supported values include:

  • all: Match any data stream or index, including hidden ones.
  • open: Match open, non-hidden indices. Also matches any non-hidden data stream.
  • closed: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.
  • hidden: Match hidden data streams and hidden indices. Must be combined with open, closed, or both.
  • none: Wildcard expressions are not accepted.
Values: all open closed hidden none
health enum

The health status used to limit returned indices. By default, the response includes indices of any health status.

Supported values include:

  • green (or GREEN): All shards are assigned.
  • yellow (or YELLOW): All primary shards are assigned, but one or more replica shards are unassigned. If a node in the cluster fails, some data could be unavailable until that node is repaired.
  • red (or RED): One or more primary shards are unassigned, so some data is unavailable. This can occur briefly during cluster startup as primary shards are assigned.
  • unknown
  • unavailable
Values: green GREEN yellow YELLOW red RED unknown unavailable
include_unloaded_segments boolean · default: false

If true, the response includes information from segments that are not loaded into memory.

pri boolean · default: false

If true, the response only includes information from primary shards.

master_timeout string · default: 30s

Period to wait for a connection to the master node.

h union oneOf

A comma-separated list of columns names to display. It supports simple wildcards.

Supported values include:

  • health (or h): The current health status.
  • status (or s): The open/close status.
  • index (or i, idx): The index name.
  • uuid (or id, uuid): The index UUID.
  • pri (or p, shards.primary, shardsPrimary): The number of primary shards.
  • rep (or r, shards.replica, shardsReplica): The number of replica shards.
  • docs.count (or dc, docsCount): The number of available documents.
  • docs.deleted (or dd, docsDeleted): The number of deleted documents.
  • creation.date (or cd): The index creation date (millisecond value).
  • creation.date.string (or cds): The index creation date (as string).
  • store.size (or ss, storeSize): The store size of primaries and replicas.
  • pri.store.size: The store size of primaries.
  • dataset.size: The total size of the dataset.
  • completion.size (or cs, completionSize): The size of completion for primaries and replicas.
  • pri.completion.size: The size of completion for primaries.
  • fielddata.memory_size (or fm, fielddataMemory): The used fielddata cache for primaries and replicas.
  • pri.fielddata.memory_size: The used fielddata cache for primaries.
  • fielddata.evictions (or fe, fielddataEvictions): The number of fielddata evictions for primaries and replicas.
  • pri.fielddata.evictions: The number of fielddata evictions for primaries.
  • query_cache.memory_size (or qcm, queryCacheMemory): The used query cache for primaries and replicas.
  • pri.query_cache.memory_size: The used query cache for primaries.
  • query_cache.evictions (or qce, queryCacheEvictions): The number of query cache evictions for primaries and replicas.
  • pri.query_cache.evictions: The number of query cache evictions for primaries.
  • request_cache.memory_size (or rcm, requestCacheMemory): The used request cache for primaries and replicas.
  • pri.request_cache.memory_size: The used request cache for primaries.
  • request_cache.evictions (or rce, requestCacheEvictions): The number of request cache evictions for primaries and replicas.
  • pri.request_cache.evictions: The number of request cache evictions for primaries.
  • request_cache.hit_count (or rchc, requestCacheHitCount): The request cache hit count for primaries and replicas.
  • pri.request_cache.hit_count: The request cache hit count for primaries.
  • request_cache.miss_count (or rcmc, requestCacheMissCount): The request cache miss count for primaries and replicas.
  • pri.request_cache.miss_count: The request cache miss count for primaries.
  • flush.total (or ft, flushTotal): The number of flushes for primaries and replicas.
  • pri.flush.total: The number of flushes for primaries.
  • flush.total_time (or ftt, flushTotalTime): The time spent in flush for primaries and replicas.
  • pri.flush.total_time: The time spent in flush for primaries.
  • get.current (or gc, getCurrent): The number of current get operations for primaries and replicas.
  • pri.get.current: The number of current get operations for primaries.
  • get.time (or gti, getTime): The time spent in get for primaries and replicas.
  • pri.get.time: The time spent in get for primaries.
  • get.total (or gto, getTotal): The number of get operations for primaries and replicas.
  • pri.get.total: The number of get operations for primaries.
  • get.exists_time (or geti, getExistsTime): The time spent in successful gets for primaries and replicas.
  • pri.get.exists_time: The time spent in successful gets for primaries.
  • get.exists_total (or geto, getExistsTotal): The number of successful gets for primaries and replicas.
  • pri.get.exists_total: The number of successful gets for primaries.
  • get.missing_time (or gmti, getMissingTime): The time spent in failed gets for primaries and replicas.
  • pri.get.missing_time: The time spent in failed gets for primaries.
  • get.missing_total (or gmto, getMissingTotal): The number of failed gets for primaries and replicas.
  • pri.get.missing_total: The number of failed gets for primaries.
  • indexing.delete_current (or idc, indexingDeleteCurrent): The number of current deletions for primaries and replicas.
  • pri.indexing.delete_current: The number of current deletions for primaries.
  • indexing.delete_time (or idti, indexingDeleteTime): The time spent in deletions for primaries and replicas.
  • pri.indexing.delete_time: The time spent in deletions for primaries.
  • indexing.delete_total (or idto, indexingDeleteTotal): The number of delete operations for primaries and replicas.
  • pri.indexing.delete_total: The number of delete operations for primaries.
  • indexing.index_current (or iic, indexingIndexCurrent): The number of current indexing operations for primaries and replicas.
  • pri.indexing.index_current: The number of current indexing operations for primaries.
  • indexing.index_time (or iiti, indexingIndexTime): The time spent in indexing for primaries and replicas.
  • pri.indexing.index_time: The time spent in indexing for primaries.
  • indexing.index_total (or iito, indexingIndexTotal): The number of indexing operations for primaries and replicas.
  • pri.indexing.index_total: The number of indexing operations for primaries.
  • indexing.index_failed (or iif, indexingIndexFailed): The number of failed indexing operations for primaries and replicas.
  • pri.indexing.index_failed: The number of failed indexing operations for primaries.
  • indexing.index_failed_due_to_version_conflict (or iifvc, indexingIndexFailedDueToVersionConflict): The number of failed indexing operations due to version conflict for primaries and replicas.
  • pri.indexing.index_failed_due_to_version_conflict: The number of failed indexing operations due to version conflict for primaries.
  • merges.current (or mc, mergesCurrent): The number of current merges for primaries and replicas.
  • pri.merges.current: The number of current merges for primaries.
  • merges.current_docs (or mcd, mergesCurrentDocs): The number of current merging documents for primaries and replicas.
  • pri.merges.current_docs: The number of current merging documents for primaries.
  • merges.current_size (or mcs, mergesCurrentSize): The size of current merges for primaries and replicas.
  • pri.merges.current_size: The size of current merges for primaries.
  • merges.total (or mt, mergesTotal): The number of completed merge operations for primaries and replicas.
  • pri.merges.total: The number of completed merge operations for primaries.
  • merges.total_docs (or mtd, mergesTotalDocs): The number of merged documents for primaries and replicas.
  • pri.merges.total_docs: The number of merged documents for primaries.
  • merges.total_size (or mts, mergesTotalSize): The merged size for primaries and replicas.
  • pri.merges.total_size: The merged size for primaries.
  • merges.total_time (or mtt, mergesTotalTime): The time spent in merges for primaries and replicas.
  • pri.merges.total_time: The time spent in merges for primaries.
  • refresh.total (or rto, refreshTotal): The total refreshes for primaries and replicas.
  • pri.refresh.total: The total refreshes for primaries.
  • refresh.time (or rti, refreshTime): The time spent in refreshes for primaries and replicas.
  • pri.refresh.time: The time spent in refreshes for primaries.
  • refresh.external_total (or rto, refreshTotal): The total external refreshes for primaries and replicas.
  • pri.refresh.external_total: The total external refreshes for primaries.
  • refresh.external_time (or rti, refreshTime): The time spent in external refreshes for primaries and replicas.
  • pri.refresh.external_time: The time spent in external refreshes for primaries.
  • refresh.listeners (or rli, refreshListeners): The number of pending refresh listeners for primaries and replicas.
  • pri.refresh.listeners: The number of pending refresh listeners for primaries.
  • search.fetch_current (or sfc, searchFetchCurrent): The current fetch phase operations for primaries and replicas.
  • pri.search.fetch_current: The current fetch phase operations for primaries.
  • search.fetch_time (or sfti, searchFetchTime): The time spent in fetch phase for primaries and replicas.
  • pri.search.fetch_time: The time spent in fetch phase for primaries.
  • search.fetch_total (or sfto, searchFetchTotal): The total fetch operations for primaries and replicas.
  • pri.search.fetch_total: The total fetch operations for primaries.
  • search.open_contexts (or so, searchOpenContexts): The open search contexts for primaries and replicas.
  • pri.search.open_contexts: The open search contexts for primaries.
  • search.query_current (or sqc, searchQueryCurrent): The current query phase operations for primaries and replicas.
  • pri.search.query_current: The current query phase operations for primaries.
  • search.query_time (or sqti, searchQueryTime): The time spent in query phase for primaries and replicas.
  • pri.search.query_time: The time spent in query phase for primaries.
  • search.query_total (or sqto, searchQueryTotal): The total query phase operations for primaries and replicas.
  • pri.search.query_total: The total query phase operations for primaries.
  • search.scroll_current (or scc, searchScrollCurrent): The open scroll contexts for primaries and replicas.
  • pri.search.scroll_current: The open scroll contexts for primaries.
  • search.scroll_time (or scti, searchScrollTime): The time scroll contexts held open for primaries and replicas.
  • pri.search.scroll_time: The time scroll contexts held open for primaries.
  • search.scroll_total (or scto, searchScrollTotal): The completed scroll contexts for primaries and replicas.
  • pri.search.scroll_total: The completed scroll contexts for primaries.
  • segments.count (or sc, segmentsCount): The number of segments for primaries and replicas.
  • pri.segments.count: The number of segments for primaries.
  • segments.memory (or sm, segmentsMemory): The memory used by segments for primaries and replicas.
  • pri.segments.memory: The memory used by segments for primaries.
  • segments.index_writer_memory (or siwm, segmentsIndexWriterMemory): The memory used by index writer for primaries and replicas.
  • pri.segments.index_writer_memory: The memory used by index writer for primaries.
  • segments.version_map_memory (or svmm, segmentsVersionMapMemory): The memory used by version map for primaries and replicas.
  • pri.segments.version_map_memory: The memory used by version map for primaries.
  • segments.fixed_bitset_memory (or sfbm, fixedBitsetMemory): The memory used by fixed bit sets for nested object field types and type filters for types referred in _parent fields. Applicable for primaries and replicas.
  • pri.segments.fixed_bitset_memory: The memory used by fixed bit sets for nested object field types and type filters for types referred in _parent fields. Applicable for primaries.
  • warmer.current (or wc, warmerCurrent): The current warmer operations for primaries and replicas.
  • pri.warmer.current: The current warmer operations for primaries.
  • warmer.total (or wto, warmerTotal): The total warmer operations for primaries and replicas.
  • pri.warmer.total: The total warmer operations for primaries.
  • warmer.total_time (or wtt, warmerTotalTime): The time spent in warmers for primaries and replicas.
  • pri.warmer.total_time: The time spent in warmers for primaries.
  • suggest.current (or suc, suggestCurrent): The current suggest operations for primaries and replicas.
  • pri.suggest.current: The current suggest operations for primaries.
  • suggest.time (or suti, suggestTime): The time spent in suggest for primaries and replicas.
  • pri.suggest.time: The time spent in suggest for primaries.
  • suggest.total (or suto, suggestTotal): The number of suggest operations for primaries and replicas.
  • pri.suggest.total: The number of suggest operations for primaries.
  • memory.total (or tm, memoryTotal): The total used memory for primaries and replicas.
  • pri.memory.total: The total used memory for primaries.
  • bulk.total_operations (or bto, bulkTotalOperation): The number of bulk shard operations for primaries and replicas.
  • pri.bulk.total_operations: The number of bulk shard operations for primaries.
  • bulk.total_time (or btti, bulkTotalTime): The time spent in shard bulk for primaries and replicas.
  • pri.bulk.total_time: The time spent in shard bulk for primaries.
  • bulk.total_size_in_bytes (or btsi, bulkTotalSizeInBytes): The total size in bytes of shard bulk for primaries and replicas.
  • pri.bulk.total_size_in_bytes: The total size in bytes of shard bulk for primaries.
  • bulk.avg_time (or bati, bulkAvgTime): The average time spent in shard bulk for primaries and replicas.
  • pri.bulk.avg_time: The average time spent in shard bulk for primaries.
  • bulk.avg_size_in_bytes (or basi, bulkAvgSizeInBytes): The average size in bytes of shard bulk for primaries and replicas.
  • pri.bulk.avg_size_in_bytes: The average size in bytes of shard bulk for primaries.
  • dense_vector.value_count (or dvc, denseVectorCount): The total count of indexed dense vectors for primaries and replicas.
  • pri.dense_vector.value_count: The total count of indexed dense vectors for primaries.
  • sparse_vector.value_count (or svc, sparseVectorCount): The total count of indexed sparse vectors for primaries and replicas.
  • pri.sparse_vector.value_count: The total count of indexed sparse vectors for primaries.
Values: health h status s index i idx uuid id pri p shards.primary
s union string | string[]

List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.

format string · default: text

Specifies the format to return the columnar data in, can be set to text, json, cbor, yaml, or smile.

help boolean · default: false

When set to true will output available columns. This option can't be combined with any other query string option.

v boolean · default: false

When set to true will enable verbose output.

bytes enum

Sets the units for columns that contain a byte-size value. Note that byte-size value units work in terms of powers of 1024. For instance 1kb means 1024 bytes, not 1000 bytes. If omitted, byte-size values are rendered with a suffix such as kb, mb, or gb, chosen such that the numeric value of the column is as small as possible whilst still being at least 1.0. If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit. Values that are not an exact multiple of the chosen unit are rounded down.

Values: b kb mb gb tb pb
time enum

Sets the units for columns that contain a time duration. If omitted, time duration values are rendered with a suffix such as ms, s, m or h, chosen such that the numeric value of the column is as small as possible whilst still being at least 1.0. If given, time duration values are rendered as an integer with no suffix. Values that are not an exact multiple of the chosen unit are rounded down.

Values: nanos micros ms s m h d

Response

application/json
<array> object[]
health string

current health status

status string

open/close status

index string

index name

uuid string

index uuid

pri string

number of primary shards

rep string

number of replica shards

docs.count union string nullable

The number of documents in the index, including hidden nested documents. For indices with semantic_text fields or other nested field types, this count includes the internal nested documents. To get the logical document count (excluding nested documents), use the _count API or _cat/count API instead.

One of: string
docs.deleted union string nullable

deleted docs

One of: string
creation.date string

index creation date (millisecond value)

creation.date.string string

index creation date (as string)

store.size union string nullable

store size of primaries & replicas

One of: string
pri.store.size union string nullable

store size of primaries

One of: string
dataset.size union string nullable

total size of dataset (including the cache for partially mounted indices)

One of: string
completion.size string

size of completion

pri.completion.size string

size of completion

fielddata.memory_size string

used fielddata cache

pri.fielddata.memory_size string

used fielddata cache

fielddata.evictions string

fielddata evictions

pri.fielddata.evictions string

fielddata evictions

query_cache.memory_size string

used query cache

pri.query_cache.memory_size string

used query cache

query_cache.evictions string

query cache evictions

pri.query_cache.evictions string

query cache evictions

request_cache.memory_size string

used request cache

pri.request_cache.memory_size string

used request cache

request_cache.evictions string

request cache evictions

pri.request_cache.evictions string

request cache evictions

request_cache.hit_count string

request cache hit count

pri.request_cache.hit_count string

request cache hit count

request_cache.miss_count string

request cache miss count

pri.request_cache.miss_count string

request cache miss count

flush.total string

number of flushes

pri.flush.total string

number of flushes

flush.total_time string

time spent in flush

pri.flush.total_time string

time spent in flush

get.current string

number of current get ops

pri.get.current string

number of current get ops

get.time string

time spent in get

pri.get.time string

time spent in get

get.total string

number of get ops

pri.get.total string

number of get ops

get.exists_time string

time spent in successful gets

pri.get.exists_time string

time spent in successful gets

get.exists_total string

number of successful gets

pri.get.exists_total string

number of successful gets

get.missing_time string

time spent in failed gets

pri.get.missing_time string

time spent in failed gets

get.missing_total string

number of failed gets

pri.get.missing_total string

number of failed gets

indexing.delete_current string

number of current deletions

pri.indexing.delete_current string

number of current deletions

indexing.delete_time string

time spent in deletions

pri.indexing.delete_time string

time spent in deletions

indexing.delete_total string

number of delete ops

pri.indexing.delete_total string

number of delete ops

indexing.index_current string

number of current indexing ops

pri.indexing.index_current string

number of current indexing ops

indexing.index_time string

time spent in indexing

pri.indexing.index_time string

time spent in indexing

indexing.index_total string

number of indexing ops

pri.indexing.index_total string

number of indexing ops

indexing.index_failed string

number of failed indexing ops

pri.indexing.index_failed string

number of failed indexing ops

merges.current string

number of current merges

pri.merges.current string

number of current merges

merges.current_docs string

number of current merging docs

pri.merges.current_docs string

number of current merging docs

merges.current_size string

size of current merges

pri.merges.current_size string

size of current merges

merges.total string

number of completed merge ops

pri.merges.total string

number of completed merge ops

merges.total_docs string

docs merged

pri.merges.total_docs string

docs merged

merges.total_size string

size merged

pri.merges.total_size string

size merged

merges.total_time string

time spent in merges

pri.merges.total_time string

time spent in merges

refresh.total string

total refreshes

pri.refresh.total string

total refreshes

refresh.time string

time spent in refreshes

pri.refresh.time string

time spent in refreshes

refresh.external_total string

total external refreshes

pri.refresh.external_total string

total external refreshes

refresh.external_time string

time spent in external refreshes

pri.refresh.external_time string

time spent in external refreshes

refresh.listeners string

number of pending refresh listeners

pri.refresh.listeners string

number of pending refresh listeners

search.fetch_current string

current fetch phase ops

pri.search.fetch_current string

current fetch phase ops

search.fetch_time string

time spent in fetch phase

pri.search.fetch_time string

time spent in fetch phase

search.fetch_total string

total fetch ops

pri.search.fetch_total string

total fetch ops

search.open_contexts string

open search contexts

pri.search.open_contexts string

open search contexts

search.query_current string

current query phase ops

pri.search.query_current string

current query phase ops

search.query_time string

time spent in query phase

pri.search.query_time string

time spent in query phase

search.query_total string

total query phase ops

pri.search.query_total string

total query phase ops

search.scroll_current string

open scroll contexts

pri.search.scroll_current string

open scroll contexts

search.scroll_time string

time scroll contexts held open

pri.search.scroll_time string

time scroll contexts held open

search.scroll_total string

completed scroll contexts

pri.search.scroll_total string

completed scroll contexts

segments.count string

number of segments

pri.segments.count string

number of segments

segments.memory string

memory used by segments

pri.segments.memory string

memory used by segments

segments.index_writer_memory string

memory used by index writer

pri.segments.index_writer_memory string

memory used by index writer

segments.version_map_memory string

memory used by version map

pri.segments.version_map_memory string

memory used by version map

segments.fixed_bitset_memory string

memory used by fixed bit sets for nested object field types and export type filters for types referred in _parent fields

pri.segments.fixed_bitset_memory string

memory used by fixed bit sets for nested object field types and export type filters for types referred in _parent fields

warmer.current string

current warmer ops

pri.warmer.current string

current warmer ops

warmer.total string

total warmer ops

pri.warmer.total string

total warmer ops

warmer.total_time string

time spent in warmers

pri.warmer.total_time string

time spent in warmers

suggest.current string

number of current suggest ops

pri.suggest.current string

number of current suggest ops

suggest.time string

time spend in suggest

pri.suggest.time string

time spend in suggest

suggest.total string

number of suggest ops

pri.suggest.total string

number of suggest ops

memory.total string

total used memory

pri.memory.total string

total user memory

search.throttled string

indicates if the index is search throttled

bulk.total_operations string

number of bulk shard ops

pri.bulk.total_operations string

number of bulk shard ops

bulk.total_time string

time spend in shard bulk

pri.bulk.total_time string

time spend in shard bulk

bulk.total_size_in_bytes string

total size in bytes of shard bulk

pri.bulk.total_size_in_bytes string

total size in bytes of shard bulk

bulk.avg_time string

average time spend in shard bulk

pri.bulk.avg_time string

average time spend in shard bulk

bulk.avg_size_in_bytes string

average size in bytes of shard bulk

pri.bulk.avg_size_in_bytes string

average size in bytes of shard bulk