Get snapshot lifecycle management status API
Retrieves the status of snapshot lifecycle management (SLM).
Request
GET /_slm/status
Description
Returns 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
-
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.
Prerequisites
If 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
GET _slm/status
The API returns the following result:
{
"operation_mode": "RUNNING"
}
© 2023-2025 Elasticsearch
As of September 2024, Elasticsearch is available under a choice of three licenses: the Server Side Public License (SSPL), the Elastic License, or the AGPLv3 (OSI approved).
Elasticsearch and the Elasticsearch logo are trademarks of Elasticsearch B.V., registered in the U.S. and in other countries.
https://www.elastic.co/guide/en/elasticsearch/reference/7.17/slm-api-get-status.html
