2021-06-22 02:13:40 -04:00
---
layout: default
2022-10-31 12:21:32 -04:00
title: CAT indices operation
parent: CAT API
2021-06-22 02:13:40 -04:00
nav_order: 25
has_children: false
2023-05-04 14:22:52 -04:00
redirect_from:
- /opensearch/rest-api/cat/cat-indices/
2021-06-22 02:13:40 -04:00
---
2022-10-31 12:21:32 -04:00
# CAT indices
2021-07-26 19:14:22 -04:00
Introduced 1.0
{: .label .label-purple }
2021-06-22 02:13:40 -04:00
2023-05-04 14:22:52 -04:00
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.
2021-06-22 02:13:40 -04:00
## Example
```
GET _cat/indices?v
```
2023-01-30 17:09:38 -05:00
{% include copy-curl.html %}
2021-06-22 02:13:40 -04:00
To limit the information to a specific index, add the index name after your query.
```
GET _cat/indices/< index > ?v
```
2023-01-30 17:09:38 -05:00
{% include copy-curl.html %}
2021-06-22 02:13:40 -04:00
2023-05-15 17:59:57 -04:00
If you want to get information for more than one index, separate the indexes with commas:
2021-06-22 02:13:40 -04:00
```json
2022-12-13 12:52:53 -05:00
GET _cat/indices/index1,index2,index3
2021-06-22 02:13:40 -04:00
```
2023-01-30 17:09:38 -05:00
{% include copy-curl.html %}
2021-06-22 02:13:40 -04:00
## Path and HTTP methods
```
GET _cat/indices/< index >
GET _cat/indices
```
## URL parameters
2022-10-31 12:21:32 -04:00
All CAT indices URL parameters are optional.
2021-06-22 02:13:40 -04:00
2022-10-27 12:50:39 -04:00
In addition to the [common URL parameters ]({{site.url}}{{site.baseurl}}/api-reference/cat/index ), you can specify the following parameters:
2021-06-22 02:13:40 -04:00
Parameter | Type | Description
:--- | :--- | :---
bytes | Byte size | Specify the units for byte size. For example, `7kb` or `6gb` . For more information, see [Supported units ]({{site.url}}{{site.baseurl}}/opensearch/units/ ).
2023-05-15 17:59:57 -04:00
health | String | Limit indexes based on their health status. Supported values are `green` , `yellow` , and `red` .
2021-06-22 02:13:40 -04:00
include_unloaded_segments | Boolean | Whether to include information from segments not loaded into memory. Default is false.
2022-10-31 12:21:32 -04:00
cluster_manager_timeout | Time | The amount of time to wait for a connection to the cluster manager node. Default is 30 seconds.
2021-06-22 02:13:40 -04:00
pri | Boolean | Whether to return information only from the primary shards. Default is false.
time | Time | Specify the units for time. For example, `5d` or `7h` . For more information, see [Supported units ]({{site.url}}{{site.baseurl}}/opensearch/units/ ).
2023-05-15 17:59:57 -04:00
expand_wildcards | Enum | Expands wildcard expressions to concrete indexes. Combine multiple values with commas. Supported values are `all` , `open` , `closed` , `hidden` , and `none` . Default is `open` .
2021-06-22 02:13:40 -04:00
## Response
```json
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
```