IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« Get field mapping API Get index settings API »

› › ›

Get index API

edit

IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

Get index API

edit

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

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

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

GET /my-index-000001

Request

edit

GET /<target>

Prerequisites

edit

If the Elasticsearch security features are enabled, you must have the view_index_metadata or manage index privilege for the target data stream, index, or alias.

Path parameters

edit

<target>: (Required, string) 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.

Query parameters

edit

allow_no_indices

(Optional, Boolean) 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.

Defaults to true.

expand_wildcards

(Optional, string) 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. Valid values are:

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 patterns are not accepted.

Defaults to open.

features

(Optional, string) Return information about specific index features. Supports comma- separated values. Valid values are aliases, mappings, and settings. Defaults to aliases,mappings,settings.

flat_settings

(Optional, Boolean) If true, returns settings in flat format. Defaults to false.

include_defaults

(Optional, Boolean) If true, return all default settings in the response. Defaults to false.

ignore_unavailable

(Optional, Boolean) If false, requests that target a missing index return an error. Defaults to false.

local

(Optional, Boolean) 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

(Optional, time units) Period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. Defaults to 30s. Can also be set to -1 to indicate that the request should never timeout.

« Get field mapping API Get index settings API »