Stop Snapshot Lifecycle Management API
editStop Snapshot Lifecycle Management API
editStop the Snapshot Lifecycle Management (SLM) plugin.
Request
editPOST /_slm/stop
Description
editHalts all snapshot lifecycle management operations and stops the SLM plugin. This is useful when you are performing maintenance on the cluster and need to prevent SLM from performing any actions on your indices. Note that this API does not stop any snapshots that are currently in progress, and that snapshots can still be taken manually via the Execute Policy API even when SLM is stopped.
The API returns as soon as the stop request has been acknowledged, but the plugin might continue to run until in-progress operations complete and the plugin can be safely stopped. Use the Get SLM Status API to see if SLM is running.
Request Parameters
edit-
timeout -
(Optional, time units) Specifies the period of time to wait for
a response. If no response is received before the timeout expires, the request
fails and returns an error. Defaults to
30s. -
master_timeout -
(Optional, time units) Specifies the period of time 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. Defaults to
30s.
Authorization
editYou must have the manage_slm cluster privilege to use this API.
For more information, see Security privileges.
Examples
editStops the SLM plugin.
POST _slm/stop
If the request does not encounter errors, you receive the following result:
{
"acknowledged": true
}