Path parameters

• name string | array[string]

  Comma-separated list of data stream names used to limit the request. Wildcard (*) expressions are supported. If omitted, all data streams are returned.

Query parameters

• expand_wildcards string | array[string]

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

• include_defaults boolean

  If true, returns all relevant default configurations for the index template.

• 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.

• verbose boolean

  Whether the maximum timestamp for each data stream should be calculated and returned.

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

    • _meta object
      Hide _meta attribute Show _meta attribute object

      • * object Additional properties
    • allow_custom_routing boolean

      If true, the data stream allows custom routing on write request.

    • failure_store object
      Hide failure_store attributes Show failure_store attributes object

      • enabled boolean Required
      • indices array[object] Required
        Hide indices attributes Show indices attributes object

        • index_name string Required
        • index_uuid string Required
        • ilm_policy string
        • managed_by string

          Values are Index Lifecycle Management, Data stream lifecycle, or Unmanaged.

        • prefer_ilm boolean

          Indicates if ILM should take precedence over DSL in case both are configured to manage this index.

      • rollover_on_write boolean Required
    • generation number Required

      Current generation for the data stream. This number acts as a cumulative count of the stream’s rollovers, starting at 1.

    • hidden boolean Required

      If true, the data stream is hidden.

    • ilm_policy string
    • next_generation_managed_by string Required

      Values are Index Lifecycle Management, Data stream lifecycle, or Unmanaged.

    • prefer_ilm boolean Required

      Indicates if ILM should take precedence over DSL in case both are configured to managed this data stream.

    • indices array[object] Required

      Array of objects containing information about the data stream’s backing indices. The last item in this array contains information about the stream’s current write index.

      Hide indices attributes Show indices attributes object

      • index_name string Required
      • index_uuid string Required
      • ilm_policy string
      • managed_by string

        Values are Index Lifecycle Management, Data stream lifecycle, or Unmanaged.

      • prefer_ilm boolean

        Indicates if ILM should take precedence over DSL in case both are configured to manage this index.

    • lifecycle object

      Data stream lifecycle with rollover can be used to display the configuration including the default rollover conditions, if asked.

      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.

      • downsampling object
        Hide downsampling attribute Show downsampling attribute object

        • rounds array[object] Required

          The list of downsampling rounds to execute as part of this downsampling configuration

      • 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.

        Default value is true.

      • rollover object
        Hide rollover attributes Show rollover attributes object

        • min_age 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.

        • max_age string
        • min_docs number
        • max_docs number
        • min_size
        • max_size
        • min_primary_shard_size
        • max_primary_shard_size
        • min_primary_shard_docs number
        • max_primary_shard_docs number
    • name string Required
    • replicated boolean

      If true, the data stream is created and managed by cross-cluster replication and the local cluster can not write into this data stream or change its mappings.

    • rollover_on_write boolean Required

      If true, the next write to this data stream will trigger a rollover first and the document will be indexed in the new backing index. If the rollover fails the indexing request will fail too.

    • status string Required

      Values are green, GREEN, yellow, YELLOW, red, or RED.

    • system boolean Generally available; Added in 7.10.0

      If true, the data stream is created and managed by an Elastic stack component and cannot be modified through normal user interaction.

    • template string Required
    • timestamp_field object Required
      Hide timestamp_field attribute Show timestamp_field attribute object

      • name string Required

        Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.