Update field mappings

POST also PUT /{index}/_mapping

Add new fields to an existing data stream or index. You can also use this API to change the search settings of existing fields and add new properties to existing object fields. For data streams, these changes are applied to all backing indices by default.

Add multi-fields to an existing field

Multi-fields let you index the same field in different ways. You can use this API to update the fields mapping parameter and enable multi-fields for an existing field. WARNING: If an index (or data stream) contains documents when you add a multi-field, those documents will not have values for the new multi-field. You can populate the new multi-field with the update by query API.

Change supported mapping parameters for an existing field

The documentation for each mapping parameter indicates whether you can update it for an existing field using this API. For example, you can use the update mapping API to update the ignore_above parameter.

Change the mapping of an existing field

Except for supported mapping parameters, you can't change the mapping or field type of an existing field. Changing an existing field could invalidate data that's already indexed.

If you need to change the mapping of a field in a data stream's backing indices, refer to documentation about modifying data streams. If you need to change the mapping of a field in other indices, create a new index with the correct mapping and reindex your data into that index.

Rename a field

Renaming a field would invalidate data already indexed under the old field name. Instead, add an alias field to create an alternate field name.

Required authorization

Index privileges: manage

Read the reference documentation

Path Parameters

index union IndexName | [] IndexName required: A comma-separated list of index names the mapping should be added to (supports wildcards). Use _all or omit to add the mapping on all indices.

Query Parameters

Request

date_detection boolean: Controls whether dynamic date detection is enabled.
dynamic enum DynamicMapping: Controls whether new fields are added dynamically.; Values: strict runtime true false
dynamic_date_formats [] string: If date detection is enabled then new string fields are checked against 'dynamic_date_formats' and if the value matches then a new date field is added instead of string.
dynamic_templates [] string to DynamicTemplate: Specify dynamic templates for the mapping.
_field_names {} FieldNamesField: Control whether field names are enabled for the index.
_meta Metadata: A mapping type can have custom meta data associated with it. These are not used at all by Elasticsearch, but can be used to store application-specific metadata.
numeric_detection boolean · default: false: Automatically map strings into numeric data types for all fields.
properties map string to Property: Mapping for a field. For new fields, this mapping can include:

Field name

Field data type

Mapping parameters
_routing {} RoutingField: Enable making a routing value required on indexed documents.
_source {} SourceField: Control whether the _source field is enabled on the index.
runtime RuntimeFields: Mapping of runtime fields for the index.

Response

application/json

Examples

The update mapping API can be applied to multiple data streams or indices with a single request. For example, run PUT /my-index-000001,my-index-000002/_mapping to update mappings for the my-index-000001 and my-index-000002 indices at the same time.

Request Console 1 / 8 languages

Console Kibana Dev Tools

POST /my-index-000001/_mapping
{
  "properties": {
    "user": {
      "properties": {
        "name": {
          "type": "keyword"
        }
      }
    }
  }
}

JavaScript Elasticsearch JavaScript Client

const response = await client.indices.putMapping({
  index: "my-index-000001",
  properties: {
    user: {
      properties: {
        name: {
          type: "keyword",
        },
      },
    },
  },
});

Python Elasticsearch Python Client

resp = client.indices.put_mapping(
    index="my-index-000001",
    properties={
        "user": {
            "properties": {
                "name": {
                    "type": "keyword"
                }
            }
        }
    },
)

curl Shell

curl -X POST "$ELASTICSEARCH_URL/my-index-000001/_mapping" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "properties": {
      "user": {
        "properties": {
          "name": {
            "type": "keyword"
          }
        }
      }
    }
  }'

Java Elasticsearch Java Client

client.indices().putMapping(p -> p
    .index("my-index-000001")
    .properties("user", pr -> pr
        .object(o -> o
            .properties("name", pro -> pro
                .keyword(k -> k)
            )
        )
    )
);

C# Elasticsearch .NET Client

var response = await client.Indices
    .PutMappingAsync(indices: new[] { "my-index-000001" }, d1 => d1
        .Properties(d2 => d2
            .Object(x => x.User, d3 => d3
                .Properties(d4 => d4
                    .Keyword(x => x.Name)
                )
            )
        )
    );

PHP Elasticsearch PHP Client

$resp = $client->indices()->putMapping([
    "index" => "my-index-000001",
    "body" => [
        "properties" => [
            "user" => [
                "properties" => [
                    "name" => [
                        "type" => "keyword",
                    ],
                ],
            ],
        ],
    ],
]);

Ruby Elasticsearch Ruby Client

response = client.indices.put_mapping(
  index: "my-index-000001",
  body: {
    "properties": {
      "user": {
        "properties": {
          "name": {
            "type": "keyword"
          }
        }
      }
    }
  }
)

Response

No example

Required authorization

Path Parameters

Query Parameters { allow_no_indices , expand_wildcards , ignore_unavailable , master_timeout , timeout , write_index_only , }

Request { date_detection , dynamic , dynamic_date_formats , dynamic_templates , _field_names , _meta , numeric_detection , properties , _routing , _source , runtime , }

Response

Query Parameters

Request