Check indices Generally available
Check if one or more indices, index aliases, or data streams exist.
Query parameters
-
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. -
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
.Supported values include:
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 withopen
,closed
, orboth
.none
: Wildcard expressions are not accepted.
Values are
all
,open
,closed
,hidden
, ornone
. -
If
true
, returns settings in flat format. -
If
true
, return all default settings in the response. -
If
true
, the request retrieves information from the local node only.
HEAD /{index}
Console
HEAD my-data-stream
resp = client.indices.exists( index="my-data-stream", )
const response = await client.indices.exists({ index: "my-data-stream", });
response = client.indices.exists( index: "my-data-stream" )
$resp = $client->indices()->exists([ "index" => "my-data-stream", ]);
curl --head -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/my-data-stream"
client.indices().exists(e -> e .index("my-data-stream") );