Update data stream mappings

PUT /_data_stream/{name}/_mappings

This API can be used to override mappings on specific data streams. These overrides will take precedence over what is specified in the template that the data stream matches. The mapping change is only applied to new write indices that are created during rollover after this API is called. No indices are changed by this API.

Required authorization

Authentication

Authorization: <value>

Elasticsearch APIs use 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}"

For more information about where to find API keys for the Elasticsearch endpoint (${ES_URL}) for a project, go to Get started with Elasticsearch Serverless.

Path parameters

Query parameters

Request body

all_field object
date_detection boolean
dynamic enum: Values: strict runtime true false
dynamic_date_formats string[]
dynamic_templates string to object[]
_field_names object
index_field object
_meta object
numeric_detection boolean
properties map string to oneOf
_routing object
_size object
_source object
runtime map string to object
enabled boolean
subobjects enum: Values: true false
_data_stream_timestamp object

Response

application/json

Examples

Request Console 1 / 8 languages

This is a request to add or modify two fields in a mapping on a data stream.

Console Kibana Dev Tools

PUT /_data_stream/my-data-stream/_mappings
{
   "properties":{
      "field1":{
         "type":"ip"
      },
      "field3":{
         "type":"text"
      }
   }
}

JavaScript Elasticsearch JavaScript Client

const response = await client.indices.putDataStreamMappings({
  name: "my-data-stream",
  mappings: {
    properties: {
      field1: {
        type: "ip",
      },
      field3: {
        type: "text",
      },
    },
  },
});

Python Elasticsearch Python Client

resp = client.indices.put_data_stream_mappings(
    name="my-data-stream",
    mappings={
        "properties": {
            "field1": {
                "type": "ip"
            },
            "field3": {
                "type": "text"
            }
        }
    },
)

curl Shell

curl -X PUT "$ELASTICSEARCH_URL/_data_stream/my-data-stream/_mappings" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "properties": {
      "field1": {
        "type": "ip"
      },
      "field3": {
        "type": "text"
      }
    }
  }'

Java Elasticsearch Java Client

client.indices().putDataStreamMappings(p -> p
    .name("my-data-stream")
    .mappings(m -> m
        .properties(Map.of("field1", Property.of(pr -> pr
                .ip(i -> i)
            ),"field3", Property.of(pro -> pro
                .text(t -> t)
            )))
    )
);

C# Elasticsearch .NET Client

var response = await client.Indices
    .PutDataStreamMappingsAsync(name: new[] { "my-data-stream" }, d1 => d1
        .Mappings(d2 => d2
            .Properties(d3 => d3
                .Ip(x => x.Field1)
                .Text(x => x.Field3)
            )
        )
    );

PHP Elasticsearch PHP Client

$resp = $client->indices()->putDataStreamMappings([
    "name" => "my-data-stream",
    "body" => [
        "properties" => [
            "field1" => [
                "type" => "ip",
            ],
            "field3" => [
                "type" => "text",
            ],
        ],
    ],
]);

Ruby Elasticsearch Ruby Client

response = client.indices.put_data_stream_mappings(
  name: "my-data-stream",
  body: {
    "properties": {
      "field1": {
        "type": "ip"
      },
      "field3": {
        "type": "text"
      }
    }
  }
)

Response

This shows a response to PUT /_data_stream/my-data-stream/_settings when two settings are successfully updated on the data stream. In this case, index.number_of_shards is only applied to the data stream -- it will be applied to the write index on rollover. The setting index.lifecycle.name is applied to the data stream and all backing indices.

{
  "data_streams": [
    {
      "name": "my-data-stream",
      "applied_to_data_stream": true,
      "mappings": {
        "properties": {
          "field1": {
            "type": "ip"
          },
          "field3": {
            "type": "text"
          }
        }
      },
      "effective_mappings": {
        "properties": {
          "field1": {
            "type": "ip"
          },
          "field3": {
            "type": "text"
          }
        }
      }
    }
  ]
}

Required authorization

Authentication

Path parameters

Query parameters

Request body { }

Response

Request body