Delete lifecycle policy API

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.

Deletes a lifecycle policy.

Request

DELETE _ilm/policy/<policy_id>

Description

Deletes the specified lifecycle policy definition. You cannot delete policies that are currently in use. If the policy is being used to manage any indices, the request fails and returns an error.

Path Parameters

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

Request Parameters

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.

Authorization

You must have the manage_ilm cluster privilege to use this API. For more information, see Security Privileges.

Examples

The following example deletes my_policy:

DELETE _ilm/policy/my_policy

When the policy is successfully deleted, you receive the following result:

{
  "acknowledged": true
}