Search + K

Command Palette

Search for a command to run...

Sign In

Check indices

HEAD /{index}
Copy endpoint

Check if one or more indices, index aliases, or data streams exist.

Parameters

path Path Parameters

Name Type
index required

Comma-separated list of data streams, indices, and aliases. Supports wildcards (*).

type TypesIndices = type TypesIndexName = string | type TypesIndexName = string[]

query Query Parameters

Name Type
allow_no_indices

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.

boolean
expand_wildcards

Type of index that wildcard patterns 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.

type TypesExpandWildcards = type TypesExpandWildcard = "all" | "open" | "closed" | "hidden" | "none" | type TypesExpandWildcard = "all" | "open" | "closed" | "hidden" | "none"[]
flat_settings

If true, returns settings in flat format.

boolean
ignore_unavailable

If false, the request returns an error if it targets a missing or closed index.

boolean
include_defaults

If true, return all default settings in the response.

boolean
local

If true, the request retrieves information from the local node only.

boolean

Responses

200 application/json
unknown