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

« Index alias exists API Index recovery API »

› › ›

Index exists API

edit

Index exists API

edit

Checks if an index exists.

HEAD /twitter

Request

edit

HEAD /<index>

Path parameters

edit

<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 parameters

edit

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.

Defaults to true.

expand_wildcards

(Optional, string) Controls what kind of indices that wildcard expressions can expand to. Valid values are:

all: Expand to open and closed indices.
open: Expand only to open indices.
closed: Expand only to closed indices.
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 codes

edit

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

« Index alias exists API Index recovery API »