Get data streams

GET /_data_stream/{name}
GET /_data_stream

Auth

Get information about one or more data streams.

Required authorization

Index privileges view_index_metadata

Path parameters

name union string | string[] optional

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

Leave it out to use /_data_stream.

Query parameters

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

include_defaults boolean · default: false

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

master_timeout string · 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.

verbose boolean · default: false

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

Response

application/json

data_streams object[] required

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

GET _data_stream/my-data-stream

JavaScript Elasticsearch JavaScript Client

const response = await client.indices.getDataStream({
  name: "my-data-stream",
});

Python Elasticsearch Python Client

resp = client.indices.get_data_stream(
    name="my-data-stream",
)

curl Shell

curl -X GET "$ELASTICSEARCH_URL/_data_stream/my-data-stream" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.indices().getDataStream(g -> g
    .name("my-data-stream")
);

C# Elasticsearch .NET Client

var response = await client.Indices
    .GetDataStreamAsync(d1 => d1
        .Name(new[] { "my-data-stream" })
    );

PHP Elasticsearch PHP Client

$resp = $client->indices()->getDataStream([
    "name" => "my-data-stream",
]);

Ruby Elasticsearch Ruby Client

response = client.indices.get_data_stream(
  name: "my-data-stream"
)

Response

A successful response for retrieving information about a data stream.

{
  "data_streams": [
    {
      "name": "my-data-stream",
      "timestamp_field": {
        "name": "@timestamp"
      },
      "indices": [
        {
          "index_name": ".ds-my-data-stream-2099.03.07-000001",
          "index_uuid": "xCEhwsp8Tey0-FLNFYVwSg",
          "prefer_ilm": true,
          "ilm_policy": "my-lifecycle-policy",
          "managed_by": "Index Lifecycle Management"
        },
        {
          "index_name": ".ds-my-data-stream-2099.03.08-000002",
          "index_uuid": "PA_JquKGSiKcAKBA8DJ5gw",
          "prefer_ilm": true,
          "ilm_policy": "my-lifecycle-policy",
          "managed_by": "Index Lifecycle Management"
        }
      ],
      "generation": 2,
      "_meta": {
        "my-meta-field": "foo"
      },
      "status": "GREEN",
      "next_generation_managed_by": "Index Lifecycle Management",
      "prefer_ilm": true,
      "template": "my-index-template",
      "ilm_policy": "my-lifecycle-policy",
      "hidden": false,
      "system": false,
      "allow_custom_routing": false,
      "replicated": false,
      "rollover_on_write": false
    },
    {
      "name": "my-data-stream-two",
      "timestamp_field": {
        "name": "@timestamp"
      },
      "indices": [
        {
          "index_name": ".ds-my-data-stream-two-2099.03.08-000001",
          "index_uuid": "3liBu2SYS5axasRt6fUIpA",
          "prefer_ilm": true,
          "ilm_policy": "my-lifecycle-policy",
          "managed_by": "Index Lifecycle Management"
        }
      ],
      "generation": 1,
      "_meta": {
        "my-meta-field": "foo"
      },
      "status": "YELLOW",
      "next_generation_managed_by": "Index Lifecycle Management",
      "prefer_ilm": true,
      "template": "my-index-template",
      "ilm_policy": "my-lifecycle-policy",
      "hidden": false,
      "system": false,
      "allow_custom_routing": false,
      "replicated": false,
      "rollover_on_write": false
    }
  ]
}