Check aliases

HEAD /{index}/_alias/{name}
HEAD /_alias/{name}

Check if one or more data stream or index aliases exist.

Authentication

Api key

Authorization: <value>

Elasticsearch APIs support key-based authentication. You must create an API key and use the encoded value in the request header. For example:

		curl -X GET "${ES_URL}/_cat/indices?v=true" \
  -H "Authorization: ApiKey ${API_KEY}"

To get API keys, use the /_security/api_key APIs.

Basic

Authorization: Basic <credentials>

Bearer

Authorization: Bearer <token>

Elasticsearch APIs support the use of bearer tokens in the Authorization HTTP header to authenticate with the API. For examples, refer to Token-based authentication services

Path parameters

Query parameters

Response

200 application/json

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

HEAD _alias/my-alias

JavaScript Elasticsearch JavaScript Client

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

Python Elasticsearch Python Client

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

curl Shell

curl "$ELASTICSEARCH_URL/_alias/my-alias" \
  --head \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.indices().existsAlias(e -> e
    .name("my-alias")
);

C# Elasticsearch .NET Client

var response = await client.Indices
    .ExistsAliasAsync(new ExistsAliasRequest()
    {
        Name = new[] { "my-alias" }
    });

PHP Elasticsearch PHP Client

$resp = $client->indices()->existsAlias([
    "name" => "my-alias",
]);

Ruby Elasticsearch Ruby Client

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

Response

No example