Resolve indices Added in 7.9.0

GET /_resolve/index/{name}

Resolve the names and/or index patterns for indices, aliases, and data streams. Multiple patterns and remote clusters are supported.

Path parameters

  • name string | array[string] Required

    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 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.

  • If false, the request returns an error if it targets a missing or closed index.

  • 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. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar.

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
GET /_resolve/index/{name}
curl \
 -X GET http://api.example.com/_resolve/index/{name}
Response examples (200)
{
  "indices": [
    {
      "name": "string",
      "aliases": [
        "string"
      ],
      "attributes": [
        "string"
      ],
      "data_stream": "string"
    }
  ],
  "aliases": [
    {
      "name": "string",
      "indices": "string"
    }
  ],
  "data_streams": [
    {
      "name": "string",
      "timestamp_field": "string",
      "backing_indices": "string"
    }
  ]
}