Stop snapshot lifecycle management API

edit

Stop snapshot lifecycle management API

edit

Turn off snapshot lifecycle management (SLM).

Request

edit

POST /_slm/stop

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

Halts all snapshot lifecycle management (SLM) operations and stops the SLM plugin. This is useful when you are performing maintenance on a cluster and need to prevent SLM from performing any actions on your data streams or indices. Stopping SLM does not stop any snapshots that are in progress. You can manually trigger snapshots with the Execute snapshot lifecycle policy even if SLM is stopped.

The API returns a response as soon as the request is acknowledged, but the plugin might continue to run until in-progress operations complete and it can be safely stopped.

Use the Get snapshot lifecycle management status to see if SLM is running.

Query parameters

edit

master_timeout: (Optional, time units) Period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. Defaults to 30s. Can also be set to -1 to indicate that the request should never timeout.
timeout: (Optional, time units) Period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata. If no response is received before the timeout expires, the cluster metadata update still applies but the response will indicate that it was not completely acknowledged. Defaults to 30s. Can also be set to -1 to indicate that the request should never timeout.

Examples

edit

resp = client.slm.stop()
print(resp)

const response = await client.slm.stop();
console.log(response);

POST _slm/stop

« Start snapshot lifecycle management API SQL APIs »