IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Resolve index API
editResolve index API
editResolves the specified name(s) and/or index patterns for indices, index aliases, and data streams. Multiple patterns and remote clusters are supported.
GET /_resolve/index/my-index-*
Request
editGET /_resolve/index/<name>
Prerequisites
edit-
If the Elasticsearch security features are enabled, you must have the
view_index_metadataormanageindex privilege for the target data stream, index, or index alias.
Path parameters
edit-
<name> -
(Required, string) Comma-separated name(s) or index pattern(s) of the indices, index aliases, and data streams to resolve. Resources on remote clusters can be specified using the
<cluster>:<name>syntax.
Query parameters
edit-
expand_wildcards -
(Optional, string) Controls what kind of indices that wildcard expressions can expand to. Multiple values are accepted when separated by a comma, as in
open,hidden. Valid values are:-
all - Expand to open and closed indices, including hidden indices.
-
open - Expand only to open indices.
-
closed - Expand only to closed indices.
-
hidden -
Expansion of wildcards will include hidden indices.
Must be combined with
open,closed, or both. -
none - Wildcard expressions are not accepted.
Defaults to
open. -
Examples
editGET /_resolve/index/f*,remoteCluster1:bar*?expand_wildcards=all
The API returns the following response:
{
"indices": [
{
"name": "foo_closed",
"attributes": [
"closed"
]
},
{
"name": "freeze-index",
"aliases": [
"f-alias"
],
"attributes": [
"frozen",
"open"
]
},
{
"name": "remoteCluster1:bar-01",
"attributes": [
"open"
]
}
],
"aliases": [
{
"name": "f-alias",
"indices": [
"freeze-index",
"my-index-000001"
]
}
],
"data_streams": [
{
"name": "foo",
"backing_indices": [
".ds-foo-000001"
],
"timestamp_field": "@timestamp"
}
]
}