Update data stream options

Auth

Update the data stream options of the specified data streams.

Required privileges

name union string | string[] required: Comma-separated list of data streams used to limit the request. Supports wildcards (*). To target all data streams use * or _all.

expand_wildcards union oneOf · default: open

Type of data stream that wildcard patterns can match. Supports comma-separated values, such as open,hidden.

Supported values include:

all: Match any data stream or index, including hidden ones.
open: Match open, non-hidden indices. Also matches any non-hidden data stream.
closed: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.
hidden: Match hidden data streams and hidden indices. Must be combined with open, closed, or both.
none: Wildcard expressions are not accepted.

Values: all open closed hidden none

master_timeout union oneOf · default: 30s

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.

Values: -1 0

timeout union oneOf · default: 30s

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

Values: -1 0

failure_store object: If defined, it will update the failure store configuration of every data stream resolved by the name expression.

application/json

acknowledged boolean required: For a successful response, this value is always true. On failure, an exception is returned instead.