IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« API conventions Date math support in index names »

› › ›

Multiple indices

edit

Multiple indices

edit

Most APIs that refer to an index parameter support execution across multiple indices, using simple test1,test2,test3 notation (or _all for all indices). It also supports wildcards, for example: test* or *test or te*t or *test*, and the ability to "exclude" (-), for example: test*,-test3.

All multi index APIs support the following url query string parameters:

ignore_unavailable

(Optional, boolean) If true, missing or closed indices are not included in the response. Defaults to false.

allow_no_indices

(Optional, boolean) If true, the request does not return an error if a wildcard expression or _all value retrieves only missing or closed indices.

This parameter also applies to index aliases that point to a missing or closed index.

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.

The defaults settings for the above parameters depend on the API being used.

Some multi index APIs also support the following url query string parameter:

ignore_throttled: (Optional, boolean) If true, concrete, expanded or aliased indices are ignored when throttled.

Single index APIs such as the Document APIs and the single-index alias APIs do not support multiple indices.

« API conventions Date math support in index names »