Get data stream settings

  • GET /_data_stream/{name}/_settings
Auth

Get setting information for one or more data streams.

Required authorization

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.

Response

application/json
data_streams object[] required
name string required

The name of the data stream.

settings object required

The settings specific to this data stream

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.