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.

Read the reference documentation

Path Parameters

index union IndexName | [] IndexName required: Comma-separated list of index names to explain

Query Parameters

Response

application/json

Examples

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.

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

{
  "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"
  }
}

Path Parameters

Query Parameters { include_defaults , master_timeout , }

Response

Query Parameters