IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Start snapshot lifecycle management API
edit
IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.
Start 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) 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. -
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.
Examples
editStart the SLM plugin:
POST _slm/start
If successful, this request returns:
{
"acknowledged": true
}