Get data stream lifecycles

GET /_data_stream/{name}/_lifecycle

Get the data stream lifecycle configuration of one or more data streams.

Required authorization

Authentication

Authorization: <value>

Elasticsearch APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example:

		curl -X GET "${ES_URL}/_cat/indices?v=true" \
  -H "Authorization: ApiKey ${API_KEY}"

For more information about where to find API keys for the Elasticsearch endpoint (${ES_URL}) for a project, go to Get started with Elasticsearch Serverless.

Path parameters

Query parameters

Response

application/json

data_streams object[] required
global_retention object required

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

GET /_data_stream/{name}/_lifecycle?human&pretty

JavaScript Elasticsearch JavaScript Client

const response = await client.indices.getDataLifecycle({
  name: "{name}",
  human: "true",
  pretty: "true",
});

Python Elasticsearch Python Client

resp = client.indices.get_data_lifecycle(
    name="{name}",
    human=True,
    pretty=True,
)

curl Shell

curl -X GET "$ELASTICSEARCH_URL/_data_stream/%7Bname%7D/_lifecycle?human&pretty" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.indices().getDataLifecycle(g -> g
    .name("{name}")
);

C# Elasticsearch .NET Client

var response = await client.Indices.GetDataLifecycleAsync(name: new[] { "{name}" });

PHP Elasticsearch PHP Client

$resp = $client->indices()->getDataLifecycle([
    "name" => "{name}",
    "human" => "true",
    "pretty" => "true",
]);

Ruby Elasticsearch Ruby Client

response = client.indices.get_data_lifecycle(
  name: "{name}",
  human: "true",
  pretty: "true"
)

Response

A successful response from GET /_data_stream/{name}/_lifecycle?human&pretty.

{
  "data_streams": [
    {
      "name": "my-data-stream-1",
      "lifecycle": {
        "enabled": true,
        "data_retention": "7d"
      }
    },
    {
      "name": "my-data-stream-2",
      "lifecycle": {
        "enabled": true,
        "data_retention": "7d"
      }
    }
  ]
}