IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Delete lifecycle policy API
editDelete lifecycle policy API
editDeletes an index lifecycle policy.
Request
editDELETE _ilm/policy/<policy_id>
Prerequisites
edit-
If the Elasticsearch security features are enabled, you must have the
manage_ilm
cluster privilege to use this API. For more information, see Security privileges.
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_id>
- (Required, string) Identifier for the policy.
Query parameters
edit-
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
editThe following example deletes my_policy
:
response = client.ilm.delete_lifecycle( policy: 'my_policy' ) puts response
DELETE _ilm/policy/my_policy
When the policy is successfully deleted, you receive the following result:
{ "acknowledged": true }