Index exists APIedit

Checks if an index exists.

HEAD /my-index-000001

Requestedit

HEAD /<index>

Path parametersedit

<index>

(Optional, string) Comma-separated list or wildcard expression of index names used to limit the request.

This parameter does not distinguish between an index name and alias, i.e. status code 200 is also returned if an alias exists with that name.

Query parametersedit

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.

Defaults to true.

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.

Defaults to open.

flat_settings
(Optional, boolean) If true, returns settings in flat format. Defaults to false.
include_defaults
(Optional, string) If true, return all default settings in the response. Defaults to false.
ignore_unavailable
(Optional, boolean) If true, missing or closed indices are not included in the response. Defaults to false.
local
(Optional, boolean) If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node.

Response codesedit

200
Indicates all specified indices or index aliases exist.
404
Indicates one or more specified indices or index aliases do not exist.