IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« Get snapshot lifecycle policy API Execute snapshot lifecycle policy API »

› › ›

Delete snapshot lifecycle policy API

edit

Delete snapshot lifecycle policy API

edit

Deletes an existing snapshot lifecycle policy.

Request

edit

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

Prerequisites

edit

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

edit

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

edit

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

Examples

edit

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

DELETE /_slm/policy/daily-snapshots

« Get snapshot lifecycle policy API Execute snapshot lifecycle policy API »