CAT indices
Introduced 1.0
The CAT indices operation lists information related to indexes, that is, how much disk space they are using, how many shards they have, their health status, and so on.
Endpoints
GET /_cat/indices
GET /_cat/indices/{index}
Query parameters
The following table lists the available query parameters. All query parameters are optional.
| Parameter | Data type | Description | Default |
|---|---|---|---|
bytes | String | The units used to display byte values. Valid values are: b, kb, k, mb, m, gb, g, tb, t, pb, p | N/A |
cluster_manager_timeout | String | The amount of time allowed to establish a connection to the cluster manager node. | N/A |
expand_wildcards | List or String | Specifies the type of index that wildcard expressions can match. Supports comma-separated values. Valid values are: - all: Match any index, including hidden ones. - closed: Match closed, non-hidden indexes. - hidden: Match hidden indexes. Must be combined with open, closed, or both. - none: Wildcard expressions are not accepted. - open: Match open, non-hidden indexes. | N/A |
format | String | A short version of the Accept header, such as json or yaml. | N/A |
h | List | A comma-separated list of column names to display. | N/A |
health | String | Limits indexes based on their health status. Supported values are green, yellow, and red. Valid values are: green, GREEN, yellow, YELLOW, red, RED | N/A |
help | Boolean | Returns help information. | false |
include_unloaded_segments | Boolean | Whether to include information from segments not loaded into memory. | false |
local | Boolean | Returns local information but does not retrieve the state from the cluster manager node. | false |
pri | Boolean | When true, returns information only from the primary shards. | false |
s | List | A comma-separated list of column names or column aliases to sort by. | N/A |
time | String | Specifies the time units. Valid values are: nanos, micros, ms, s, m, h, d | N/A |
v | Boolean | Enables verbose mode, which displays column headers. | false |
Example requests
GET _cat/indices?v
To limit the information to a specific index, add the index name after your query.
GET _cat/indices/<index>?v
If you want to get information for more than one index, separate the indexes with commas:
GET _cat/indices/index1,index2,index3
Example response
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
Limiting the response size
To limit the number of indexes returned, configure the cat.indices.response.limit.number_of_indices setting. For more information, see Cluster-level CAT response limit settings.