Set the lifecycle of a data stream

If the Elasticsearch security features are enabled, you must have the manage_data_stream_lifecycle index privilege or higher to use this API. For more information, see Security privileges.

PUT _data_stream/<data-stream>/_lifecycle

Configures the data stream lifecycle for the targeted data streams. If multiple data streams are provided but at least one of them does not exist, then the update of the lifecycle will fail for all of them and the API will respond with 404.

The following example sets the lifecycle of my-data-stream:

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

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

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

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

When the lifecycle is successfully updated in all data streams, you receive the following result:

{
  "acknowledged": true
}

The following example configures two downsampling rounds, the first one starting one day after the backing index is rolled over (or later, if the index is still within its write-accepting time bounds) with an interval of 10m, and a second round starting 7 days after rollover at an interval of 1d:

resp = client.indices.put_data_lifecycle(
    name="my-weather-sensor-data-stream",
    downsampling=[
        {
            "after": "1d",
            "fixed_interval": "10m"
        },
        {
            "after": "7d",
            "fixed_interval": "1d"
        }
    ],
)
print(resp)

response = client.indices.put_data_lifecycle(
  name: 'my-weather-sensor-data-stream',
  body: {
    downsampling: [
      {
        after: '1d',
        fixed_interval: '10m'
      },
      {
        after: '7d',
        fixed_interval: '1d'
      }
    ]
  }
)
puts response

const response = await client.indices.putDataLifecycle({
  name: "my-weather-sensor-data-stream",
  downsampling: [
    {
      after: "1d",
      fixed_interval: "10m",
    },
    {
      after: "7d",
      fixed_interval: "1d",
    },
  ],
});
console.log(response);

PUT _data_stream/my-weather-sensor-data-stream/_lifecycle
{
    "downsampling": [
      {
        "after": "1d",
        "fixed_interval": "10m"
      },
      {
        "after": "7d",
        "fixed_interval": "1d"
      }
    ]
}