---
type: api
title: Get index settings
description: **All methods and paths for this operation:**
url: https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-indices-get-settings
resource: https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/operation/operation-indices-get-settings
products:
  - Elasticsearch
---

# Get index settings


Availability:

## Paths

- `GET` `/{index}/_settings/{name}`
- `GET` `/{index}/_settings`
- `GET` `/_settings/{name}`
- `GET` `/_settings`

- [Api key auth](/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/authentication#apikeyauth)
- [Basic auth](/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/authentication#basicauth)
- [Bearer auth](/elastic/docs-builder/docs/4371/api/doc/elasticsearch/v9/authentication#bearerauth)

#### Path Parameters

- `index` (union IndexName | [] IndexName) — optional, leave it out to use `/_settings`
  Comma-separated list of data streams, indices, and aliases used to limit
the request. Supports wildcards (`*`). To target all data streams and
indices, omit this parameter or use `*` or `_all`.
- `name` (union Name | [] Name) — optional, leave it out to use `/_settings`
  Comma-separated list or wildcard expression of settings to retrieve.

## Description

Get setting information for one or more indices.
For data streams, it returns setting information for the stream's backing indices.

## Required authorization

* Index privileges: `view_index_metadata`

## Query String Parameters

- `allow_no_indices` (boolean · default: true)
  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 ExpandWildcards · default: open)
  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)
  If `true`, returns settings in flat format.
- `ignore_unavailable` (boolean · default: false)
  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)
  If `true`, return all default settings in the response.
- `local` (boolean · default: false) — deprecated
  If `true`, the request retrieves information from the local node only. If
`false`, information is retrieved from the master node.
- `master_timeout` (string Duration · default: 30s)
  Period to wait for a connection to the master node. If no response is
received before the timeout expires, the request fails and returns an
error.

## Response

`application/json`

Type: `map string to IndexState`

## Code Examples

#### Console

```console
GET _all/_settings?expand_wildcards=all&filter_path=*.settings.index.*.slowlog
```

#### JavaScript

```javascript
const response = await client.indices.getSettings({
  index: "_all",
  expand_wildcards: "all",
  filter_path: "*.settings.index.*.slowlog",
});
```

#### Python

```python
resp = client.indices.get_settings(
    index="_all",
    expand_wildcards="all",
    filter_path="*.settings.index.*.slowlog",
)
```

#### curl

```curl
curl -X GET "$ELASTICSEARCH_URL/_all/_settings?expand_wildcards=all&filter_path=*.settings.index.*.slowlog" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"
```

#### Java

```java
client.indices().getSettings(g -> g
    .expandWildcards(ExpandWildcard.All)
    .index("_all")
);
```

#### C#

```c#
var response = await client.Indices
    .GetSettingsAsync(d1 => d1
        .Indices(new[] { "_all" })
        .ExpandWildcards(ExpandWildcard.All)
    );
```

#### PHP

```php
$resp = $client->indices()->getSettings([
    "index" => "_all",
    "expand_wildcards" => "all",
    "filter_path" => "*.settings.index.*.slowlog",
]);
```

#### Ruby

```ruby
response = client.indices.get_settings(
  index: "_all",
  expand_wildcards: "all",
  filter_path: "*.settings.index.*.slowlog"
)
```