Delete lifecycle policy API

edit

Delete lifecycle policy API

edit

Deletes an index lifecycle policy.

Request

edit

DELETE _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

edit

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

edit

<policy_id>: (Required, string) Identifier for the policy.

Query parameters

edit

master_timeout: (Optional, time units) Period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. Defaults to 30s. Can also be set to -1 to indicate that the request should never timeout.
timeout: (Optional, time units) Period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata. If no response is received before the timeout expires, the cluster metadata update still applies but the response will indicate that it was not completely acknowledged. Defaults to 30s. Can also be set to -1 to indicate that the request should never timeout.

Examples

edit

The following example deletes my_policy:

resp = client.ilm.delete_lifecycle(
    name="my_policy",
)
print(resp)

response = client.ilm.delete_lifecycle(
  policy: 'my_policy'
)
puts response

const response = await client.ilm.deleteLifecycle({
  name: "my_policy",
});
console.log(response);

DELETE _ilm/policy/my_policy

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

{
  "acknowledged": true
}

« Get lifecycle policy API Move to lifecycle step API »