---
type: api
title: Check indices
description: Check if one or more indices, index aliases, or data streams exist.
url: https://www.elastic.co/elastic/docs-builder/docs/4493/api/doc/elasticsearch/operation/operation-indices-exists
resource: https://www.elastic.co/elastic/docs-builder/docs/4493/api/doc/elasticsearch/operation/operation-indices-exists
products:
  - Elasticsearch
---

# Check indices

## Paths

- `HEAD` `/{index}`

#### Path parameters

- `index` (union string | string[]) — required
  Comma-separated list of data streams, indices, and aliases. Supports wildcards (`*`).

## Description

Check if one or more indices, index aliases, or data streams 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/docs/deploy-manage/users-roles/cluster-or-deployment-auth/token-based-authentication-services)

## Query string parameters

- `allow_no_indices` (boolean · default: true) — optional
  A setting that does two separate checks on the index expression.
If `false`, the request returns an error (1) if any wildcard expression
(including `_all` and `*`) resolves to zero matching indices or (2) if the
complete set of resolved indices, aliases or data streams is empty after all
expressions are evaluated. If `true`, index expressions that resolve to no
indices are allowed and the request returns an empty result.
- `expand_wildcards` (string · default: open) — 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`
- `flat_settings` (boolean · default: false) — optional
  If `true`, returns settings in flat format.
- `ignore_unavailable` (boolean · default: false) — optional
  If `false`, the request returns an error if it targets a concrete (non-wildcarded)
index, alias, or data stream that is missing, closed, or otherwise unavailable.
If `true`, unavailable concrete targets are silently ignored.
- `include_defaults` (boolean · default: false) — optional
  If `true`, return all default settings in the response.
- `local` (boolean · default: false) — optional
  If `true`, the request retrieves information from the local node only.

## Response

`application/json`

## Code examples

#### Console

```console
HEAD my-data-stream
```

#### JavaScript

```javascript
const response = await client.indices.exists({
  index: "my-data-stream",
});
```

#### Python

```python
resp = client.indices.exists(
    index="my-data-stream",
)
```

#### curl

```curl
curl "$ELASTICSEARCH_URL/my-data-stream" \
  --head \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"
```

#### Java

```java
client.indices().exists(e -> e
    .index("my-data-stream")
);
```

#### C#

```c#
var response = await client.Indices.ExistsAsync(indices: new[] { "my-data-stream" });
```

#### PHP

```php
$resp = $client->indices()->exists([
    "index" => "my-data-stream",
]);
```

#### Ruby

```ruby
response = client.indices.exists(
  index: "my-data-stream"
)
```