Get data stream lifecycle stats

GET /_lifecycle/stats

Get statistics about the data streams that are managed by a data stream lifecycle.

Required authorization

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

Response

application/json

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

GET _lifecycle/stats?human&pretty

JavaScript Elasticsearch JavaScript Client

const response = await client.indices.getDataLifecycleStats({
  human: "true",
  pretty: "true",
});

Python Elasticsearch Python Client

resp = client.indices.get_data_lifecycle_stats(
    human=True,
    pretty=True,
)

curl Shell

curl -X GET "$ELASTICSEARCH_URL/_lifecycle/stats?human&pretty" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.indices().getDataLifecycleStats();

C# Elasticsearch .NET Client

var response = await client.Indices.GetDataLifecycleStatsAsync();

PHP Elasticsearch PHP Client

$resp = $client->indices()->getDataLifecycleStats([
    "human" => "true",
    "pretty" => "true",
]);

Ruby Elasticsearch Ruby Client

response = client.indices.get_data_lifecycle_stats(
  human: "true",
  pretty: "true"
)

Response

A successful response for GET _lifecycle/stats?human&pretty

{
  "last_run_duration_in_millis": 2,
  "last_run_duration": "2ms",
  "time_between_starts_in_millis": 9998,
  "time_between_starts": "9.99s",
  "data_streams_count": 2,
  "data_streams": [
    {
      "name": "my-data-stream",
      "backing_indices_in_total": 2,
      "backing_indices_in_error": 0
    },
    {
      "name": "my-other-stream",
      "backing_indices_in_total": 2,
      "backing_indices_in_error": 1
    }
  ]
}