Get data stream settings Generally available

GET /_data_stream/{name}/_settings
Api key auth Basic auth Bearer auth

Get setting information for one or more data streams.

Required authorization

  • Index privileges: view_index_metadata

Path parameters

  • name string | array[string] Required

    A comma-separated list of data streams or data stream patterns. Supports wildcards (*).

Query parameters

  • master_timeout string

    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.

    External documentation

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
    • data_streams array[object] Required
      Hide data_streams attributes Show data_streams attributes object
      • name string Required

        The name of the data stream.

      • settings object Required

        The settings specific to this data stream

        Index settings
      • effective_settings object Required

        The settings specific to this data stream merged with the settings from its template. These effective_settings are the settings that will be used when a new index is created for this data stream.

        Index settings
GET /_data_stream/{name}/_settings 
curl \ --request GET 'http://api.example.com/_data_stream/{name}/_settings' \ --header "Authorization: $API_KEY"
Response examples (200)
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" } } } ] }