Delete a lifecycle policy Generally available; Added in 6.6.0

View as markdown
DELETE /_ilm/policy/{policy}
Api key auth Basic auth Bearer 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 authorization

  • Cluster privileges: manage_ilm

Path parameters

  • policy string Required

    Identifier for the policy.

Query parameters

  • master_timeout string

    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.

    External documentation
  • timeout string

    Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

    External documentation

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
    • acknowledged boolean Required

      For a successful response, this value is always true. On failure, an exception is returned instead.
DELETE /_ilm/policy/{policy} 
DELETE _ilm/policy/my_policy 
resp = client.ilm.delete_lifecycle( name="my_policy", )
const response = await client.ilm.deleteLifecycle({ name: "my_policy", });
response = client.ilm.delete_lifecycle( policy: "my_policy" )
$resp = $client->ilm()->deleteLifecycle([ "policy" => "my_policy", ]);
curl -X DELETE -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_ilm/policy/my_policy"
Response examples (200)
A successful response when deleting a lifecycle policy. 
{ "acknowledged": true }