Update data stream lifecycles

PUT /_data_stream/{name}/_lifecycle

Update the data stream lifecycle of the specified 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

Request body

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

A successful response for configuring a data stream lifecycle.

{
  "acknowledged": true
}

Request Console 1 / 2 languages

This example configures two downsampling rounds.

Console Kibana Dev Tools

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

Generated from the API spec

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"
        }
      ]
  }'

Generated from the API spec

Response

A successful response for configuring a data stream lifecycle.

{
  "acknowledged": true
}

Required authorization

Authentication

Path parameters

Query parameters

Request body { }

Response

Request body