Get the snapshot lifecycle management status Generally available; Added in 7.6.0

GET /_slm/status
Api key auth Basic auth Bearer auth

Required authorization

  • Cluster privileges: read_slm

Query parameters

  • master_timeout string

    The 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. To indicate that the request should never timeout, set it to -1.

    External documentation
  • timeout string

    The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. To indicate that the request should never timeout, set it to -1.

    External documentation

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
    • operation_mode string Required

      Values are RUNNING, STOPPING, or STOPPED.
GET /_slm/status 
GET _slm/status 
resp = client.slm.get_status()
const response = await client.slm.getStatus();
response = client.slm.get_status
$resp = $client->slm()->getStatus();
curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_slm/status"
Response examples (200)
A successful response from `GET _slm/status`. 
{ "operation_mode": "RUNNING" }