Get index information

GET /{index}

Get information about one or more indices. For data streams, the API returns information about the stream’s backing indices.

Required authorization

Index privileges: view_index_metadata,manage

Path Parameters

index union IndexName | [] IndexName required: Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard expressions (*) are supported.

Query Parameters

allow_no_indices boolean · default: true

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. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar.

expand_wildcards string ExpandWildcards · default: open

Type of index that wildcard expressions 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, requests that target a missing index return an error.

include_defaults boolean · default: false

If true, return all default settings in the response.

local boolean · default: false

If true, the request retrieves information from the local node only. Defaults to false, which means 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.

features Features · default: ['aliases', 'mappings', 'settings']

Return only information on specified index features

Supported values include: aliases, mappings, settings

Values: aliases mappings settings

Response

application/json

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

GET /my-index-000001

JavaScript Elasticsearch JavaScript Client

const response = await client.indices.get({
  index: "my-index-000001",
});

Python Elasticsearch Python Client

resp = client.indices.get(
    index="my-index-000001",
)

curl Shell

curl -X GET "$ELASTICSEARCH_URL/my-index-000001" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.indices().get(g -> g
    .index("my-index-000001")
);

C# Elasticsearch .NET Client

var response = await client.Indices.GetAsync(indices: new[] { "my-index-000001" });

PHP Elasticsearch PHP Client

$resp = $client->indices()->get([
    "index" => "my-index-000001",
]);

Ruby Elasticsearch Ruby Client

response = client.indices.get(
  index: "my-index-000001"
)

Response

No example

Required authorization

Path Parameters

Query Parameters { allow_no_indices , expand_wildcards , flat_settings , ignore_unavailable , include_defaults , local , master_timeout , features , }

Response

Query Parameters