Get index segments
Get low-level information about the Lucene segments in index shards. For data streams, the API returns information about the stream's backing indices.
Query parameters
-
allow_no_indices boolean
If
false
, the request returns an error if any wildcard expression, index alias, or_all
value targets only missing or closed indices. This behavior applies even if the request targets other open indices. -
expand_wildcards string | array[string]
Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as
open,hidden
. Valid values are:all
,open
,closed
,hidden
,none
. -
verbose boolean
If
true
, the request returns a verbose response.
GET
/_segments
curl \
-X GET http://api.example.com/_segments
Response examples (200)
{
"indices": {
"additionalProperty1": {
"shards": {}
},
"additionalProperty2": {
"shards": {}
}
},
"_shards": {
"failed": 42.0,
"successful": 42.0,
"total": 42.0,
"failures": [
{
"index": "string",
"node": "string",
"reason": {
"type": "string",
"reason": "string",
"stack_trace": "string",
"caused_by": {},
"root_cause": [
{}
],
"suppressed": [
{}
]
},
"shard": 42.0,
"status": "string"
}
],
"skipped": 42.0
}
}