Get mapping definitions

GET /{index}/_mapping
GET /_mapping

For data streams, the API retrieves mappings for the stream’s backing indices.

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 /books/_mapping

JavaScript Elasticsearch JavaScript Client

const response = await client.indices.getMapping({
  index: "books",
});

Python Elasticsearch Python Client

resp = client.indices.get_mapping(
    index="books",
)

curl Shell

curl -X GET "$ELASTICSEARCH_URL/books/_mapping" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.indices().getMapping(g -> g
    .index("books")
);

C# Elasticsearch .NET Client

var response = await client.Indices
    .GetMappingAsync(d1 => d1
        .Indices(new[] { "books" })
    );

PHP Elasticsearch PHP Client

$resp = $client->indices()->getMapping([
    "index" => "books",
]);

Ruby Elasticsearch Ruby Client

response = client.indices.get_mapping(
  index: "books"
)

Response

No example