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

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

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

• ignore_throttled boolean

  If true, concrete, expanded or aliased indices are ignored when frozen. Defaults to false.

• ignore_unavailable boolean

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

Responses

• 200 application/json
  Hide response attribute Show response attribute object

  • * object Additional properties

    Additional properties are allowed.

    Hide * attributes Show * attributes object

    • connected boolean Required

      Whether the remote cluster is connected to the local (querying) cluster.

    • skip_unavailable boolean Required

      The skip_unavailable setting for a remote cluster.

    • matching_indices boolean

      Whether the index expression provided in the request matches any indices, aliases or data streams on the cluster.

    • error string

      Provides error messages that are likely to occur if you do a search with this index expression on the specified cluster (e.g., lack of security privileges to query an index).

    • version object

      Additional properties are allowed.

      Hide version attributes Show version attributes object

      • build_flavor string Required
      • minimum_index_compatibility_version string Required
      • minimum_wire_compatibility_version string Required
      • number string Required