Get snapshot lifecycle management status APIedit

Retrieves the status of snapshot lifecycle management (SLM).

Requestedit

GET /_slm/status

Descriptionedit

Returns the status of the SLM plugin. The operation_mode field in the response shows one of three states: STARTED, STOPPING, or STOPPED. You halt and restart the SLM plugin with the stop and start APIs.

Query parametersedit

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.
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.

Prerequisitesedit

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.

Examplesedit

GET _slm/status

The API returns the following result:

{
  "operation_mode": "RUNNING"
}