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

Index privileges: view_index_metadata

Path Parameters

Query Parameters

Response

application/json

Examples

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

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

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

Required authorization

Path Parameters { index , fields , }

Query Parameters { allow_no_indices , expand_wildcards , ignore_unavailable , include_defaults , local , }

Response

Path Parameters

Query Parameters