Delete lifecycle policy APIedit
Deletes an index lifecycle policy.
Requestedit
DELETE _ilm/policy/<policy_id>
Prerequisitesedit
-
If the Elasticsearch security features are enabled, you must have the
manage_ilmcluster privilege to use this API. For more information, see Security privileges.
Descriptionedit
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 parametersedit
-
<policy_id> - (Required, string) Identifier for the policy.
Query parametersedit
-
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.
Examplesedit
The following example deletes my_policy:
DELETE _ilm/policy/my_policy
When the policy is successfully deleted, you receive the following result:
{
"acknowledged": true
}