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

« Get index template API Index alias exists API »

› › ›

Get mapping API

edit

Get mapping API

edit

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

edit

GET /_mapping

GET /<target>/_mapping

Path parameters

edit

<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

edit

allow_no_indices

(Optional, Boolean) If false, the request returns an error when a wildcard expression, index alias, or _all value targets only missing or closed indices.

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 false, the request returns an error if it targets a missing or closed index. 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

edit

Multiple data streams and indices

edit

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

« Get index template API Index alias exists API »