Get Snapshot Lifecycle Management status API

Retrieves the current Snapshot Lifecycle Management (SLM) status.

Request

GET /_slm/status

Description

Returns the status of the SLM plugin. The operation_mode field in the response shows one of three states: STARTED, STOPPING, or STOPPED. You can change the status of the SLM plugin with the Start SLM and Stop SLM APIs.

Request Parameters

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.

Authorization

You must have the manage_slm or read_slm or both cluster privileges to use this API. For more information, see Security privileges.

Examples

Gets the SLM plugin status.

GET _slm/status

If the request succeeds, the body of the response shows the operation mode:

{
  "operation_mode": "RUNNING"
}