Delete a policy Generally available; Added in 7.4.0

DELETE /_slm/policy/{policy_id}
Api key auth Basic auth Bearer auth

Delete a snapshot lifecycle policy definition. This operation prevents any future snapshots from being taken but does not cancel in-progress snapshots or remove previously-taken snapshots.

Required authorization

  • Cluster privileges: manage_slm

Path parameters

  • policy_id string Required

    The id of the snapshot lifecycle policy to remove

Query parameters

  • master_timeout string

    The 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 are -1 or 0.

  • timeout string

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

    Values are -1 or 0.

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 /_slm/policy/{policy_id} 
curl \
 --request DELETE 'http://api.example.com/_slm/policy/{policy_id}' \
 --header "Authorization: $API_KEY"