Delete lifecycle policy API
Deletes an index lifecycle policy.
Request
DELETE _ilm/policy/<policy_id>
Prerequisites
- If the Elasticsearch security features are enabled, you must have the
manage_ilmcluster privilege to use this API. For more information, see Security privileges.
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_id> - (Required, 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 deletes my_policy:
DELETE _ilm/policy/my_policy
When the policy is successfully deleted, you receive the following result:
{
"acknowledged": true
}
© 2023-2025 Elasticsearch
As of September 2024, Elasticsearch is available under a choice of three licenses: the Server Side Public License (SSPL), the Elastic License, or the AGPLv3 (OSI approved).
Elasticsearch and the Elasticsearch logo are trademarks of Elasticsearch B.V., registered in the U.S. and in other countries.
https://www.elastic.co/guide/en/elasticsearch/reference/7.17/ilm-delete-lifecycle.html
