---
type: api
title: Check aliases
description: **All methods and paths for this operation:**
url: https://www.elastic.co/elastic/docs-builder/docs/4493/api/doc/elasticsearch/v8/operation/operation-indices-exists-alias
resource: https://www.elastic.co/elastic/docs-builder/docs/4493/api/doc/elasticsearch/v8/operation/operation-indices-exists-alias
products:
  - Elasticsearch
---

# Check aliases


## Paths

- `HEAD` `/{index}/_alias/{name}`
- `HEAD` `/_alias/{name}`

#### Path parameters

- `index` (union string | string[]) — optional, leave it out to use `/_alias/{name}`
  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`.
- `name` (union string | string[]) — required
  Comma-separated list of aliases to check. Supports wildcards (`*`).

## Description

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](https://www.elastic.co/guide/en/elasticsearch/reference/current/token-authentication-services.html)

## Query string parameters

- `allow_no_indices` (boolean · default: true) — optional
  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.
- `expand_wildcards` (string · default: all) — optional
  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 with `open`, `closed`, or `both`.
  - `none`: Wildcard expressions are not accepted.
  Values: `all`, `open`, `closed`, `hidden`, `none`
- `ignore_unavailable` (boolean · default: false) — optional
  If `false`, requests that include a missing data stream or index in the target indices or data streams return an error.
- `local` (boolean · default: false) — optional — deprecated
  If `true`, the request retrieves information from the local node only.

## Response

`application/json`

## Code examples

#### Console

```console
HEAD _alias/my-alias
```

#### JavaScript

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

#### Python

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

#### curl

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

#### Java

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

#### C#

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

#### PHP

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

#### Ruby

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