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.
Get snapshot lifecycle management status API
editGet snapshot lifecycle management status API
editRetrieves the status of snapshot lifecycle management (SLM).
Request
editGET /_slm/status
Description
editReturns the status of the SLM plugin.
The operation_mode field in the response shows one of three states:
RUNNING, STOPPING, or STOPPED.
You halt and restart the SLM plugin with the
stop and start APIs.
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.
Prerequisites
editIf the Elasticsearch security features are enabled, you must have the
manage_slm or read_slm cluster privileges to use this API.
For more information, see Security privileges.
Examples
editresp = client.slm.get_status() print(resp)
response = client.slm.get_status puts response
const response = await client.slm.getStatus(); console.log(response);
GET _slm/status
The API returns the following result:
{
"operation_mode": "RUNNING"
}