Update data stream lifecycles

PUT /_data_stream/{name}/_lifecycle

Api key auth Basic auth Bearer auth

Update the data stream lifecycle of the specified data streams.

Read the reference documentation

Path Parameters

name union DataStreamName | [] DataStreamName required: Comma-separated list of data streams used to limit the request. Supports wildcards (*). To target all data streams use * or _all.

Query Parameters

Request

Response

application/json

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

PUT _data_stream/my-data-stream/_lifecycle
{
  "data_retention": "7d"
}

JavaScript Elasticsearch JavaScript Client

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

Python Elasticsearch Python Client

resp = client.indices.put_data_lifecycle(
    name="my-data-stream",
    data_retention="7d",
)

curl Shell

curl -X PUT "$ELASTICSEARCH_URL/_data_stream/my-data-stream/_lifecycle" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "data_retention": "7d"
  }'

Java Elasticsearch Java Client

client.indices().putDataLifecycle(p -> p
    .dataRetention(d -> d
        .time("7d")
    )
    .name("my-data-stream")
);

C# Elasticsearch .NET Client

var response = await client.Indices
    .PutDataLifecycleAsync(name: new[] { "my-data-stream" }, d1 => d1
        .DataRetention("7d")
    );

PHP Elasticsearch PHP Client

$resp = $client->indices()->putDataLifecycle([
    "name" => "my-data-stream",
    "body" => [
        "data_retention" => "7d",
    ],
]);

Ruby Elasticsearch Ruby Client

response = client.indices.put_data_lifecycle(
  name: "my-data-stream",
  body: {
    "data_retention": "7d"
  }
)

Response

{
  "acknowledged": true
}

This example configures two downsampling rounds.

Request Console 1 / 2 languages

Console Kibana Dev Tools

PUT /_data_stream/{name}/_lifecycle
{
    "downsampling": [
      {
        "after": "1d",
        "fixed_interval": "10m"
      },
      {
        "after": "7d",
        "fixed_interval": "1d"
      }
    ]
}

curl Shell

curl -X PUT "$ELASTICSEARCH_URL/_data_stream/{name}/_lifecycle" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "downsampling": [
      {
        "after": "1d",
        "fixed_interval": "10m"
      },
      {
        "after": "7d",
        "fixed_interval": "1d"
      }
    ]
}'

Response

{
  "acknowledged": true
}

Path Parameters

Query Parameters { expand_wildcards , master_timeout , timeout , }

Request { data_retention , downsampling , enabled , }

Response

Query Parameters

Request