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 »

› › ›

Multi-target syntax

edit

Multi-target syntax

edit

Most APIs that accept a <data-stream>, <index>, or <target> request path parameter also support multi-target syntax.

In multi-target syntax, you can use a comma-separated list to run a request on multiple resources, such as data streams, indices, or index aliases: test1,test2,test3. You can also use glob-like wildcard (*) expressions to target resources that match a pattern: test* or *test or te*t or *test*.

You can exclude targets using the - character: test*,-test3.

Index aliases are resolved after wildcard expressions. This can result in a request that targets an excluded alias. For example, if test3 is an index alias, the pattern test*,-test3 still targets the indices for test3. To avoid this, exclude the concrete indices for the alias instead.

Multi-target APIs that can target indices support the following query string parameters:

ignore_unavailable

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

allow_no_indices

(Optional, Boolean) If false, the request returns an error when a wildcard expression, index alias, or _all value targets only missing or closed indices.

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-target APIs that can target indices also support the following query string parameter:

ignore_throttled: (Optional, Boolean) If true, concrete, expanded or aliased indices are ignored when frozen. Defaults to true.

Single index APIs, such as the Document APIs and single-index alias APIs, do not support multi-target syntax.

« API conventions Date math support in index names »