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 alias 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 indexes.

GET /my-index-000001

Before 7.0.0, the mappings definition used to include a type name. Although mappings in responses no longer contain a type name by default, you can still request the old format through the parameter include_type_name. For more details, please see Removal of mapping types.

Request

edit

GET /<index>

Path parameters

edit

<index>

(Required, string) Comma-separated list or wildcard expression of index names used to limit the request.

Use a value of _all to retrieve information for all indices in the cluster.

Query parameters

edit

allow_no_indices

(Optional, boolean) If true, the request does not return an error if a wildcard expression or _all value retrieves only missing or closed indices.

This parameter also applies to index aliases that point to a missing or closed index.

Defaults to true.

expand_wildcards

(Optional, string) Controls what kind of indices that wildcard expressions can expand to. Multiple values are accepted when separated by a comma, as in open,hidden. Valid values are:

all: Expand to open and closed indices, including hidden indices.
open: Expand only to open indices.
closed: Expand only to closed indices.
hidden: Expansion of wildcards will include hidden indices. Must be combined with open, closed, or both.
none: Wildcard expressions are not accepted.

Defaults to open.

flat_settings

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

include_defaults

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

include_type_name

[7.0.0] Deprecated in 7.0.0. Mapping types have been deprecated. See Removal of mapping types. (Optional, boolean) If true, a mapping type is expected in the body of mappings. Defaults to false.

ignore_unavailable

(Optional, boolean) If true, missing or closed indices are not included in the response. 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) Specifies the period of time 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. Defaults to 30s.

« Get field mapping API Get index alias API »