Get the status for a data stream lifecycle

GET /{index}/_lifecycle/explain

Get information about an index or data stream's current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution.

About data stream lifecycle

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

Path parameters

Query parameters

Response

application/json

indices map string to object required

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

GET .ds-metrics-2023.03.22-000001/_lifecycle/explain

JavaScript Elasticsearch JavaScript Client

const response = await client.indices.explainDataLifecycle({
  index: ".ds-metrics-2023.03.22-000001",
});

Python Elasticsearch Python Client

resp = client.indices.explain_data_lifecycle(
    index=".ds-metrics-2023.03.22-000001",
)

curl Shell

curl -X GET "$ELASTICSEARCH_URL/.ds-metrics-2023.03.22-000001/_lifecycle/explain" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.indices().explainDataLifecycle(e -> e
    .index(".ds-metrics-2023.03.22-000001")
);

C# Elasticsearch .NET Client

var response = await client.Indices.ExplainDataLifecycleAsync(indices: new[] { ".ds-metrics-2023.03.22-000001" });

PHP Elasticsearch PHP Client

$resp = $client->indices()->explainDataLifecycle([
    "index" => ".ds-metrics-2023.03.22-000001",
]);

Ruby Elasticsearch Ruby Client

response = client.indices.explain_data_lifecycle(
  index: ".ds-metrics-2023.03.22-000001"
)

Response

A successful response from GET .ds-metrics-2023.03.22-000001/_lifecycle/explain, which retrieves the lifecycle status for a data stream backing index. If the index is managed by a data stream lifecycle, the API will show the managed_by_lifecycle field set to true and the rest of the response will contain information about the lifecycle execution status for this index.

{
  "indices": {
    ".ds-metrics-2023.03.22-000001": {
      "index" : ".ds-metrics-2023.03.22-000001",
      "managed_by_lifecycle" : true,
      "index_creation_date_millis" : 1679475563571,
      "time_since_index_creation" : "843ms",
      "rollover_date_millis" : 1679475564293,
      "time_since_rollover" : "121ms",
      "lifecycle" : { },
      "generation_time" : "121ms"
  }
}