This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.

« Index APIs Aliases API »

› › ›

Alias exists API

edit

Alias exists API

edit

Checks if an alias exists.

resp = client.indices.exists_alias(
    name="my-alias",
)
print(resp)

response = client.indices.exists_alias(
  name: 'my-alias'
)
puts response

const response = await client.indices.existsAlias({
  name: "my-alias",
});
console.log(response);

HEAD _alias/my-alias

Request

edit

HEAD _alias/<alias>

HEAD <target>/_alias/<alias>

Prerequisites

edit

If the Elasticsearch security features are enabled, you must have the view_index_metadata or manage index privilege for the alias. If you specify a target, you must also have the view_index_metadata or manage index privilege for the target.

Path parameters

edit

<alias>: (Optional, string) Comma-separated list of aliases to check. Supports wildcards (*).
<target>: (Optional, string) Comma-separated list of data streams or indices used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all.

Query parameters

edit

expand_wildcards

(Optional, string) 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. 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 patterns are not accepted.

Defaults to all.

ignore_unavailable

(Optional, Boolean) If false, requests that include a missing data stream or index in the <target> return an error. Defaults to false.

master_timeout

(Optional, time units) Period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. Defaults to 30s. Can also be set to -1 to indicate that the request should never timeout.

Response codes

edit

200: All specified aliases exist.
404: One or more of the specified aliases don’t exist.

« Index APIs Aliases API »