IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
Elastic Docs ›Elasticsearch Guide [6.6] ›X-Pack APIs ›Index lifecycle management API
« Create lifecycle policy API Delete lifecycle policy API »

Get lifecycle policy APIedit

This functionality is in beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.

Retrieves a lifecycle policy.

Requestedit

GET _ilm/policy

GET _ilm/policy/<policy_id>

Descriptionedit

Returns the specified policy definition. Includes the policy version and last modified date. If no policy is specified, returns all defined policies.

Path Parametersedit

policy (optional)
(string) Identifier for the policy.

Request Parametersedit

timeout
(time units) Specifies the period of time to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Defaults to 30s. For more information about time units, see Time units.
master_timeout
(time units) Specifies the period of time 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. Defaults to 30s. For more information about time units, see Time units.

Authorizationedit

You must have the manage_ilm or read_ilm or both cluster privileges to use this API. For more information, see Security Privileges.

Examplesedit

The following example retrieves my_policy:

GET _ilm/policy

If the request succeeds, the body of the response contains the policy definition:

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

The policy version is incremented whenever the policy is updated

When this policy was last modified
« Create lifecycle policy API Delete lifecycle policy API »