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.

  Supported values include:

  • 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 expressions are not accepted.

  Values are all, open, closed, hidden, or none.

• ignore_unavailable boolean

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

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

  • indices array[object] Required
    Hide indices attributes Show indices attributes object

    • name string Required
    • aliases array[string]
    • attributes array[string] Required
    • data_stream string
  • aliases array[object] Required
    Hide aliases attributes Show aliases attributes object

    • name string Required
    • indices string | array[string] Required
  • data_streams array[object] Required
    Hide data_streams attributes Show data_streams attributes object

    • name string Required
    • timestamp_field string Required

      Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

    • backing_indices string | array[string] Required