Delete a lifecycle policy

DELETE /_ilm/policy/{policy}

Auth

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.

Required privileges

Cluster privileges manage_ilm

Path parameters

policy string required: Identifier for the policy.

Query parameters

master_timeout union oneOf · default: 30s: 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.; Values: -1 0
timeout union oneOf · default: 30s: Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.; Values: -1 0

Response

application/json

acknowledged boolean required: For a successful response, this value is always true. On failure, an exception is returned instead.

View as Markdown

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

DELETE _ilm/policy/my_policy

JavaScript Elasticsearch JavaScript Client

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

Python Elasticsearch Python Client

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

curl Shell

curl -X DELETE "$ELASTICSEARCH_URL/_ilm/policy/my_policy" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.ilm().deleteLifecycle(d -> d
    .name("my_policy")
);

C# Elasticsearch .NET Client

var response = await client.IndexLifecycleManagement.DeleteLifecycleAsync(name: "my_policy");

PHP Elasticsearch PHP Client

$resp = $client->ilm()->deleteLifecycle([
    "policy" => "my_policy",
]);

Ruby Elasticsearch Ruby Client

response = client.ilm.delete_lifecycle(
  policy: "my_policy"
)

Response

A successful response when deleting a lifecycle policy.

{
  "acknowledged": true
}