Get mapping API

Retrieves mapping definitions for one or more indices. For data streams, the API retrieves mappings for the stream’s backing indices.

GET /my-index-000001/_mapping

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

GET /_mapping

GET /<target>/_mapping

Path parameters

<target>

(Optional, string) Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard expressions (*) are supported.

To target all data streams and indices in a cluster, omit this parameter or use _all or *.

Query parameters

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.

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.

Examples

Multiple data streams and indices

The get mapping API can be used to get more than one data stream or index with a single call. General usage of the API follows the following syntax: host:port/<target>/_mapping where <target> can accept a comma-separated list of names. To get mappings for all data streams and indices in a cluster, use _all or * for <target> or omit the <target> parameter. The following are some examples:

GET /my-index-000001,my-index-000002/_mapping

If you want to get mappings of all indices in a cluster, the following examples are equivalent:

GET /*/_mapping
GET /_all/_mapping
GET /_mapping