This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.
« Retry policy execution API Explain lifecycle API »
Elastic Docs ›Elasticsearch Guide [master] ›REST APIs ›Index lifecycle management APIs

Get index lifecycle management status API

edit

Get index lifecycle management status API

edit

Retrieves the current index lifecycle management (ILM) status.

You can start or stop ILM with the start ILM and stop ILM APIs.

Request

edit

GET /_ilm/status

Prerequisites

edit
  • If the Elasticsearch security features are enabled, you must have the manage_ilm or read_ilm or both cluster privileges to use this API. For more information, see Security privileges.

Query parameters

edit
master_timeout
(Optional, time units) Period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. Defaults to 30s. Can also be set to -1 to indicate that the request should never timeout.
timeout
(Optional, time units) Period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata. If no response is received before the timeout expires, the cluster metadata update still applies but the response will indicate that it was not completely acknowledged. Defaults to 30s. Can also be set to -1 to indicate that the request should never timeout.

Response body

edit
operation_mode

(string) Current operation mode for ILM.

Possible values for operation_mode
RUNNING
ILM is running.
STOPPING
ILM is finishing sensitive actions, such as shrink, that are in progress. When these actions finish, ILM will move to STOPPED.
STOPPED
ILM is not running.

Examples

edit

The following example gets the ILM plugin status.

resp = client.ilm.get_status()
print(resp)
response = client.ilm.get_status
puts response
const response = await client.ilm.getStatus();
console.log(response);
GET _ilm/status

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

{
  "operation_mode": "RUNNING"
}
« Retry policy execution API Explain lifecycle API »