---
type: api
title: Get data stream lifecycles
description: Get the data stream lifecycle configuration of one or more data streams.
url: https://www.elastic.co/elastic/docs-builder/docs/4493/api/doc/elasticsearch/v8/operation/operation-indices-get-data-lifecycle
resource: https://www.elastic.co/elastic/docs-builder/docs/4493/api/doc/elasticsearch/v8/operation/operation-indices-get-data-lifecycle
products:
  - Elasticsearch
---

# Get data stream lifecycles

Availability: Generally available since 8.11

## Paths

- `GET` `/_data_stream/{name}/_lifecycle`

#### Path parameters

- `name` (union string | 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`.

## Description

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

[Read the reference documentation](https://www.elastic.co/guide/en/elasticsearch/reference/8.19/data-stream-lifecycle.html)

## Authentication

- Api key: `Authorization: <value>`
  Elasticsearch APIs support 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}"
  ```
  
  To get API keys, use the `/_security/api_key` APIs.
- Basic: `Authorization: Basic <credentials>`
- Bearer: `Authorization: Bearer <token>`
  Elasticsearch APIs support the use of bearer tokens in the `Authorization` HTTP header to authenticate with the API.
  For examples, refer to [Token-based authentication services](https://www.elastic.co/guide/en/elasticsearch/reference/current/token-authentication-services.html)

## Query string parameters

- `expand_wildcards` (string · default: open) — optional
  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) — optional
  If `true`, return all default settings in the response.
- `master_timeout` (string · default: 30s) — optional
  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.

## Response

`application/json`

- `data_streams` (object[])
  - `name` (string)
  - `lifecycle` (object)
    - `data_retention` (string)
      If defined, every document added to this data stream will be stored at least for this time frame.
Any time after this duration the document could be deleted.
When empty, every document in this data stream will be stored indefinitely.
    - `effective_retention` (string)
      The least amount of time data should be kept by elasticsearch.
    - `retention_determined_by` (enum)
      Configuration source that can influence the retention of a data stream.
      Values: `data_stream_configuration`, `default_global_retention`, `max_global_retention`, `default_failures_retention`
    - `downsampling` (object[])
      The list of downsampling rounds to execute as part of this downsampling configuration
      - `after` (string)
        The duration since rollover when this downsampling round should execute
      - `config` (object)
        The downsample configuration to execute.
        - `fixed_interval` (string)
          The interval at which to aggregate the original time series index.
    - `enabled` (boolean · default: true)
      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.
    - `rollover` (object)
      The conditions which will trigger the rollover of a backing index as configured by the cluster setting `cluster.lifecycle.default.rollover`.
This property is an implementation detail and it will only be retrieved when the query param `include_defaults` is set to true.
The contents of this field are subject to change.
      - `min_age` (string)
      - `max_age` (string)
      - `min_docs` (number)
      - `max_docs` (number)
      - `min_size` (number | string)
      - `max_size` (number | string)
      - `min_primary_shard_size` (number | string)
      - `max_primary_shard_size` (number | string)
      - `min_primary_shard_docs` (number)
      - `max_primary_shard_docs` (number)
- `global_retention` (object)
  - `max_retention` (string)
  - `default_retention` (string)
## Code examples

#### Console

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

#### JavaScript

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

#### Python

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

#### curl

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

#### Java

```java

```

#### C#

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

#### PHP

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

#### Ruby

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

## Response examples

#### Indices get data lifecycle response example1

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

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