Get data stream settings

GET /_data_stream/{name}/_settings

Auth

Get setting information for one or more data streams.

Required privileges

Index privileges view_index_metadata

Path parameters

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

Query parameters

master_timeout string · 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.

{
  "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 privileges

Path parameters

Query parameters

Response