Get mapping definitions

GET /{index}/_mapping/field/{fields}
GET /_mapping/field/{fields}

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

This API is useful if you don't need a complete mapping or if an index mapping contains a large number of fields.

Required authorization

Authentication

Api key

Authorization: <value>

Elasticsearch APIs support key-based authentication. You must create an API key and use the encoded value in the request header. For example:

		curl -X GET "${ES_URL}/_cat/indices?v=true" \
  -H "Authorization: ApiKey ${API_KEY}"

To get API keys, use the /_security/api_key APIs.

Basic

Authorization: Basic <credentials>

Bearer

Authorization: Bearer <token>

Elasticsearch APIs support the use of bearer tokens in the Authorization HTTP header to authenticate with the API. For examples, refer to Token-based authentication services

Path parameters

Query parameters

Response

application/json

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

GET publications/_mapping/field/title

JavaScript Elasticsearch JavaScript Client

const response = await client.indices.getFieldMapping({
  index: "publications",
  fields: "title",
});

Python Elasticsearch Python Client

resp = client.indices.get_field_mapping(
    index="publications",
    fields="title",
)

curl Shell

curl -X GET "$ELASTICSEARCH_URL/publications/_mapping/field/title" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.indices().getFieldMapping(g -> g
    .fields("title")
    .index("publications")
);

C# Elasticsearch .NET Client

var response = await client.Indices
    .GetFieldMappingAsync(new GetFieldMappingRequest()
    {
        Fields = global::Elastic.Clients.Elasticsearch.Infer.Fields<MyDocument>(x => x.Title),
        Indices = new[] { "publications" }
    });

PHP Elasticsearch PHP Client

$resp = $client->indices()->getFieldMapping([
    "index" => "publications",
    "fields" => "title",
]);

Ruby Elasticsearch Ruby Client

response = client.indices.get_field_mapping(
  index: "publications",
  fields: "title"
)

Response

A sucessful response from GET publications/_mapping/field/title, which returns the mapping of a field called title.

{
   "publications": {
      "mappings": {
          "title": {
             "full_name": "title",
             "mapping": {
                "title": {
                   "type": "text"
                }
             }
          }
       }
   }
}