Path parameters

• name string | array[string] Required

  Comma-separated list of data streams to limit the request. Supports wildcards (*). To target all data streams, omit this parameter or use * or _all.

Query parameters

• expand_wildcards string | array[string]

  Type of data stream that wildcard patterns can match. Supports comma-separated values, such as open,hidden. Valid values are: all, open, closed, hidden, none.

  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 are all, open, closed, hidden, or none.

• master_timeout string

  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 are -1 or 0.

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
    • options object
      Hide options attribute Show options attribute object

      • failure_store object
        Hide failure_store attributes Show failure_store attributes object

        • enabled boolean

          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.

        • lifecycle object
          Hide lifecycle attributes Show lifecycle attributes object

          • data_retention string

            A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

          • enabled boolean

            If defined, it turns data stream lifecycle on/off (true/false) for this data stream. A data stream lifecycle that's disabled (enabled: false) will have no effect on the data stream.