Stop snapshot lifecycle management API

Stop snapshot lifecycle management API

Turn off snapshot lifecycle management (SLM).

Request

POST /_slm/stop

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

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

master_timeout

(Optional, time units) 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. Defaults to 30s.

timeout

(Optional, time units) Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Defaults to 30s.

Examples

  1. POST _slm/stop