NOTE: You are looking at documentation for an older release. For the latest information, see the current release documentation.
Delete lifecycle policy API
editDelete lifecycle policy API
editDeletes a lifecycle policy.
Request
editDELETE _ilm/policy/<policy_id>
Description
editDeletes 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
edit-
policy(required) - (string) Identifier for the policy.
Request Parameters
edit-
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
editYou must have the manage_ilm cluster privilege to use this API.
For more information, see Security privileges.
Examples
editThe following example deletes my_policy:
DELETE _ilm/policy/my_policy
When the policy is successfully deleted, you receive the following result:
{
"acknowledged": true
}