Resolve index API

Resolve index API

Resolves the specified name(s) and/or index patterns for indices, aliases, and data streams. Multiple patterns and remote clusters are supported.

  1. GET /_resolve/index/my-index-*

Request

GET /_resolve/index/<name>

Prerequisites

  • If the Elasticsearch security features are enabled, you must have the view_index_metadata or manage index privilege for the target data stream, index, or index alias.

Path parameters

<name>

(Required, string) Comma-separated name(s) or index pattern(s) of the indices, aliases, and data streams to resolve. Resources on remote clusters can be specified using the <cluster>:<name> syntax.

Query parameters

expand_wildcards

(Optional, 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

    Match any data stream or index, including hidden ones.

    open

    Match open, non-hidden indices. Also matches any non-hidden data stream.

    closed

    Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.

    hidden

    Match hidden data streams and hidden indices. Must be combined with open, closed, or both.

    none

    Wildcard patterns are not accepted.

Defaults to open.

Examples

  1. GET /_resolve/index/f*,remoteCluster1:bar*?expand_wildcards=all

The API returns the following response:

  1. {
  2.   "indices": [                                 
  3.     {
  4.       "name": "foo_closed",
  5.       "attributes": [
  6.         "closed"
  7.       ]
  8.     },
  9.     {
  10.       "name": "freeze-index",
  11.       "aliases": [
  12.         "f-alias"
  13.       ],
  14.       "attributes": [
  15.         "frozen",
  16.         "open"
  17.       ]
  18.     },
  19.     {
  20.       "name": "remoteCluster1:bar-01",
  21.       "attributes": [
  22.         "open"
  23.       ]
  24.     }
  25.   ],
  26.   "aliases": [                                 
  27.     {
  28.       "name": "f-alias",
  29.       "indices": [
  30.         "freeze-index",
  31.         "my-index-000001"
  32.       ]
  33.     }
  34.   ],
  35.   "data_streams": [                            
  36.     {
  37.       "name": "foo",
  38.       "backing_indices": [
  39.         ".ds-foo-2099.03.07-000001"
  40.       ],
  41.       "timestamp_field": "@timestamp"
  42.     }
  43.   ]
  44. }

All indices matching the supplied names or expressions

All aliases matching the supplied names or expressions

All data streams matching the supplied names or expressions