This version of the OpenSearch documentation is no longer maintained. For the latest version, see the current documentation. For information about OpenSearch version maintenance, see Release Schedule and Maintenance Policy.
The CAT indices operation lists information related to indices—how much disk space they are using, how many shards they have, their health status, and so on.
To limit the information to a specific index, add the index name after your query.
If you want to get information for more than one index, separate the indices with commas:
Path and HTTP methods
GET _cat/indices/<index> GET _cat/indices
All CAT indices URL parameters are optional.
In addition to the common URL parameters, you can specify the following parameters:
|bytes||Byte size||Specify the units for byte size. For example, |
|health||String||Limit indices based on their health status. Supported values are |
|include_unloaded_segments||Boolean||Whether to include information from segments not loaded into memory. Default is false.|
|cluster_manager_timeout||Time||The amount of time to wait for a connection to the cluster manager node. Default is 30 seconds.|
|pri||Boolean||Whether to return information only from the primary shards. Default is false.|
|time||Time||Specify the units for time. For example, |
|expand_wildcards||Enum||Expands wildcard expressions to concrete indices. Combine multiple values with commas. Supported values are |
health | status | index | uuid | pri | rep | docs.count | docs.deleted | store.size | pri.store.size green | open | movies | UZbpfERBQ1-3GSH2bnM3sg | 1 | 1 | 1 | 0 | 7.7kb | 3.8kb