Type to search.

Update data stream settings

  • PUT /_data_stream/{name}/_settings
Auth The Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats. Availability Generally available since 9.1 This functionality is generally available and ready for production usage. Unless stated otherwise on the page, this functionality is available when your Elastic Stack is deployed on Elastic Cloud Hosted, Elastic Cloud Enterprise, Elastic Cloud on Kubernetes, and self-managed environments. This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.
Note

Available in 8.19. Not available in earlier versions.

This API can be used to override settings on specific data streams. These overrides will take precedence over what is specified in the template that the data stream matches. To prevent your data stream from getting into an invalid state, only certain settings are allowed. If possible, the setting change is applied to all backing indices. Otherwise, it will be applied when the data stream is next rolled over.

Required privileges

Index privileges manage

Path parameters

name union string | string[] required

A comma-separated list of data streams or data stream patterns.

Query parameters

dry_run boolean · default: false

If true, the request does not actually change the settings on any data streams or indices. Instead, it simulates changing the settings and reports back to the user what would have happened had these settings actually been applied.

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.

timeout string · default: 30s

The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

Request body

Type: object

Response

application/json
data_streams object[] required
name string required

The data stream name.

applied_to_data_stream boolean required

If the settings were successfully applied to the data stream (or would have been, if running in dry_run mode), it is true. If an error occurred, it is false.

error string

A message explaining why the settings could not be applied to the data stream.

settings object required

The settings that are specfic to this data stream that will override any settings from the matching index template.

effective_settings object required

The settings that are effective on this data stream, taking into account the settings from the matching index template and the settings specific to this data stream.

index_settings_results object required

Information about whether and where each setting was applied.

applied_to_data_stream_only string[] required

The list of settings that were applied to the data stream but not to backing indices. These will be applied to the write index the next time the data stream is rolled over.

applied_to_data_stream_and_backing_indices string[] required

The list of settings that were applied to the data stream and to all of its backing indices. These settings will also be applied to the write index the next time the data stream is rolled over.