› › ›

Delete snapshot lifecycle policy API

Deletes an existing snapshot lifecycle policy.

Request

DELETE /_slm/policy/<snapshot-lifecycle-policy-id>

Prerequisites

If the Elasticsearch security features are enabled, you must have the manage_slm cluster privilege to use this API. For more information, see Security privileges.

Description

Deletes the specified lifecycle policy definition. This prevents any future snapshots from being taken but does not cancel in-progress snapshots or remove previously-taken snapshots.

Path parameters

<policy-id>: (Required, string) ID of the snapshot lifecycle policy to delete.

Examples

resp = client.slm.delete_lifecycle(
    policy_id="daily-snapshots",
)
print(resp)

response = client.slm.delete_lifecycle(
  policy_id: 'daily-snapshots'
)
puts response

const response = await client.slm.deleteLifecycle({
  policy_id: "daily-snapshots",
});
console.log(response);

DELETE /_slm/policy/daily-snapshots

© 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/8.17/slm-api-delete-policy.html