Index exists APIedit

Checks if an index exists.

HEAD /my-index-000001

Requestedit

HEAD /<target>

Prerequisitesedit

  • If the Elasticsearch security features are enabled, you must have the view_index_metadata or manage index privilege for the target data stream, index, or index alias.

Path parametersedit

<target>
(Optional, string) Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard expressions (*) are supported.

Query parametersedit

allow_no_indices

(Optional, 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.

Defaults to true.

expand_wildcards

(Optional, string) Type of index that wildcard expressions 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
Match any data stream or index, including hidden ones.
open
Match open, non-hidden indices. Also matches any non-hidden data stream.
closed
Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.
hidden
Match hidden data streams and 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.