Get lifecycle policies

GET /_ilm/policy/{policy}
GET /_ilm/policy

Auth

Required privileges

Cluster privileges manage_ilm read_ilm

Path parameters

policy string optional

Identifier for the policy.

Leave it out to use /_ilm/policy.

Query parameters

master_timeout union oneOf · default: 30s: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.; Values: -1 0
timeout union oneOf · default: 30s: Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.; Values: -1 0

Response

application/json

<string> object

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

GET _ilm/policy/my_policy

JavaScript Elasticsearch JavaScript Client

const response = await client.ilm.getLifecycle({
  name: "my_policy",
});

Python Elasticsearch Python Client

resp = client.ilm.get_lifecycle(
    name="my_policy",
)

curl Shell

curl -X GET "$ELASTICSEARCH_URL/_ilm/policy/my_policy" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.ilm().getLifecycle(g -> g
    .name("my_policy")
);

C# Elasticsearch .NET Client

var response = await client.IndexLifecycleManagement
    .GetLifecycleAsync(d1 => d1
        .Name("my_policy")
    );

PHP Elasticsearch PHP Client

$resp = $client->ilm()->getLifecycle([
    "policy" => "my_policy",
]);

Ruby Elasticsearch Ruby Client

response = client.ilm.get_lifecycle(
  policy: "my_policy"
)

Response

A successful response when retrieving a lifecycle policy.

{
  "my_policy": {
    "version": 1,
    "modified_date": 82392349,
    "policy": {
      "phases": {
        "warm": {
          "min_age": "10d",
          "actions": {
            "forcemerge": {
              "max_num_segments": 1
            }
          }
        },
        "delete": {
          "min_age": "30d",
          "actions": {
            "delete": {
              "delete_searchable_snapshot": true
            }
          }
        }
      }
    },
    "in_use_by" : {
      "indices" : [],
      "data_streams" : [],
      "composable_templates" : []
    }
  }
}