Get data stream mappings

GET /_data_stream/{name}/_mappings

Get mapping information for one or more data streams.

Path Parameters

name union IndexName | [] IndexName required: A comma-separated list of data streams or data stream patterns. Supports wildcards (*).

Query Parameters

master_timeout string Duration · default: 30s: The period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

This is a response to GET /_data_stream/my-data-stream/_settings where my-data-stream that has two settings set. The effective_settings field shows additional settings that are pulled from its template.

Request Console 1 / 8 languages

Console Kibana Dev Tools

GET /_data_stream/my-data-stream/_mappings

JavaScript Elasticsearch JavaScript Client

const response = await client.indices.getDataStreamMappings({
  name: "my-data-stream",
});

Python Elasticsearch Python Client

resp = client.indices.get_data_stream_mappings(
    name="my-data-stream",
)

curl Shell

curl -X GET "$ELASTICSEARCH_URL/_data_stream/my-data-stream/_mappings" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.indices().getDataStreamMappings(g -> g
    .name("my-data-stream")
);

C# Elasticsearch .NET Client

var response = await client.Indices.GetDataStreamMappingsAsync(name: new[] { "my-data-stream" });

PHP Elasticsearch PHP Client

$resp = $client->indices()->getDataStreamMappings([
    "name" => "my-data-stream",
]);

Ruby Elasticsearch Ruby Client

response = client.indices.get_data_stream_mappings(
  name: "my-data-stream"
)

Response

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

Required authorization

Path Parameters

Query Parameters

Response