IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Index exists API
editIndex exists API
editChecks if an index exists.
HEAD /my-index-000001
Request
editHEAD /<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
200is also returned if an alias exists with that name.
Query parameters
edit-
allow_no_indices -
(Optional, Boolean) If
false, the request returns an error when a wildcard expression, index alias, or_allvalue 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 tofalse. -
include_defaults -
(Optional, string) If
true, return all default settings in the response. Defaults tofalse. -
ignore_unavailable -
(Optional, Boolean) If
false, the request returns an error if it targets a missing or closed index. Defaults tofalse. -
local -
(Optional, Boolean) If
true, the request retrieves information from the local node only. Defaults tofalse, 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.