This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.
Start snapshot lifecycle management API
editStart snapshot lifecycle management API
editTurns on snapshot lifecycle management (SLM).
Request
editPOST /_slm/start
Prerequisites
editIf 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
editStarts the SLM plugin if it’s not running. SLM starts automatically when a cluster is formed. Manually starting SLM is only necessary if it has been stopped using the Stop snapshot lifecycle management.
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-1to 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-1to indicate that the request should never timeout.
Examples
editStart the SLM plugin:
resp = client.slm.start() print(resp)
const response = await client.slm.start(); console.log(response);
POST _slm/start
If successful, this request returns:
{
"acknowledged": true
}