Get mapping APIedit

Retrieves mapping definitions for indices in a cluster.

GET /twitter/_mapping

Requestedit

GET /_mapping

GET /<index>/_mapping

Path parametersedit

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

Query parametersedit

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. Valid values are:

all
Expand to open and closed indices.
open
Expand only to open indices.
closed
Expand only to closed indices.
hidden
Expansion of wildcards will include hidden indices.
none
Wildcard expressions are not accepted.

Defaults to open.

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.

Examplesedit

Multiple indicesedit

The get mapping API can be used to get more than one index with a single call. General usage of the API follows the following syntax: host:port/{index}/_mapping where {index} can accept a comma-separated list of names. To get mappings for all indices you can use _all for {index}. The following are some examples:

GET /twitter,kimchy/_mapping

If you want to get mappings of all indices and types then the following two examples are equivalent:

GET /_all/_mapping

GET /_mapping