Get lifecycle policy API

Get lifecycle policy API

Retrieves a lifecycle policy.

Request

GET _ilm/policy

GET _ilm/policy/<policy_id>

Prerequisites

• If the Elasticsearch security features are enabled, you must have the manage_ilm or read_ilm or both cluster privileges to use this API. For more information, see Security privileges.

Description

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

Path parameters

<policy_id>

(Optional, string) Identifier for the policy.

Query parameters

master_timeout

(Optional, time units) 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. Defaults to 30s.

timeout

(Optional, time units) Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Defaults to 30s.

Examples

The following example retrieves my_policy:

GET _ilm/policy/my_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": {
              "delete_searchable_snapshot": true
            }
          }
        }
      }
    },
    "in_use_by" : { 
      "indices" : [],
      "data_streams" : [],
      "composable_templates" : []
    }
  }
}

• « Create or update lifecycle policy API
• Delete lifecycle policy API »