Get data stream settings

GET /_data_stream/{name}/_settings

Get setting 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 / 2 languages

Console Kibana Dev Tools

GET /_data_stream/{name}/_settings

curl Shell

curl -X GET "/_data_stream/{name}/_settings"

Response

{
  "data_streams": [
    {
      "name": "my-data-stream",
      "settings": {
        "index": {
          "lifecycle": {
            "name": "new-test-policy"
          },
          "number_of_shards": "11"
        }
      },
      "effective_settings": {
        "index": {
          "lifecycle": {
            "name": "new-test-policy"
          },
          "mode": "standard",
          "number_of_shards": "11",
          "number_of_replicas": "0"
        }
      }
    }
  ]
}

Required authorization

Path Parameters

Query Parameters

Response