2021-06-22 02:13:40 -04:00
---
layout: default
2022-10-31 12:21:32 -04:00
title: CAT segments
parent: CAT API
2022-10-27 12:50:39 -04:00
2021-06-22 02:13:40 -04:00
nav_order: 55
has_children: false
2023-05-04 14:22:52 -04:00
redirect_from:
- /opensearch/rest-api/cat/cat-segments/
2021-06-22 02:13:40 -04:00
---
2022-10-31 12:21:32 -04:00
# CAT segments
2021-07-26 19:14:22 -04:00
Introduced 1.0
{: .label .label-purple }
2021-06-22 02:13:40 -04:00
The cat segments operation lists Lucene segment-level information for each index.
## Example
```
GET _cat/segments?v
```
2023-01-30 17:09:38 -05:00
{% include copy-curl.html %}
2021-06-22 02:13:40 -04:00
To see only the information about segments of a specific index, add the index name after your query.
```
GET _cat/segments/< index > ?v
```
2023-01-30 17:09:38 -05:00
{% include copy-curl.html %}
2021-06-22 02:13:40 -04:00
If you want to get information for more than one index, separate the indices with commas:
```
GET _cat/segments/index1,index2,index3
```
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/segments
```
## URL parameters
2022-10-31 12:21:32 -04:00
All CAT segments URL parameters are optional.
2021-06-22 02:13:40 -04:00
2023-05-04 14:22:52 -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/ )..
2022-06-02 13:24:20 -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
## Response
```json
index | shard | prirep | ip | segment | generation | docs.count | docs.deleted | size | size.memory | committed | searchable | version | compound
movies | 0 | p | 172.18.0.4 | _0 | 0 | 1 | 0 | 3.5kb | 1364 | true | true | 8.7.0 | true
movies | 0 | r | 172.18.0.3 | _0 | 0 | 1 | 0 | 3.5kb | 1364 | true | true | 8.7.0 | true
```