Get data stream options
- GET /_data_stream/{name}/_options
Get the data stream options configuration of one or more data streams.
Query parameters
-
expand_wildcardsstring · 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 withopen,closed, orboth.none: Wildcard expressions are not accepted.
-
Values:
allopenclosedhiddennone
Response
application/json
-
data_streamsobjectrequired -
optionsobject -
failure_storeobject -
If defined, it specifies configuration for the failure store of this data stream.
-
enabledboolean · default: true -
If defined, it turns the failure store on/off (
true/false) for this data stream. A data stream failure store that's disabled (enabled:false) will redirect no new failed indices to the failure store; however, it will not remove any existing data from the failure store.