New

The executive guide to generative AI

Read more
About usPartnersSupport|Login
IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Put Mapping Get Field Mapping »
Elastic Docs ›Elasticsearch Guide [7.0] ›Indices APIs

Get Mapping

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

Get Mapping

edit

The get mapping API allows to retrieve mapping definitions for an index or index/type.

GET /twitter/_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.

Multiple Indices

edit

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
« Put Mapping Get Field Mapping »