IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Execute snapshot retention policy API Get snapshot lifecycle stats API »
Elastic Docs ›Elasticsearch Guide [7.9] ›REST APIs ›Snapshot lifecycle management API

Get snapshot lifecycle management status API

edit

Get snapshot lifecycle management status API

edit

Retrieves the status of snapshot lifecycle management (SLM).

Request

edit

GET /_slm/status

Description

edit

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

Prerequisites

edit

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

edit
GET _slm/status

The API returns the following result:

{
  "operation_mode": "RUNNING"
}
« Execute snapshot retention policy API Get snapshot lifecycle stats API »