Get Lifecycle Policy APIedit

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 unitsedit.
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 unitsedit.

Authorizationedit

You must have the cluster manage privilege 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