Get index lifecycle management status API
Retrieves the current index lifecycle management (ILM) status.
Request
GET /_ilm/status
Prerequisites
- If the Elasticsearch security features are enabled, you must have the
manage_ilm
orread_ilm
or both cluster privileges to use this API. For more information, see Security privileges.
Description
Returns the status of the ILM plugin. The operation_mode
in the response shows one of three states: STARTED
, STOPPING
, or STOPPED
. You can start or stop ILM with the start ILM and stop ILM APIs.
Query parameters
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
.
Examples
The following example gets the ILM plugin status.
GET _ilm/status
If the request succeeds, the body of the response shows the operation mode:
{
"operation_mode": "RUNNING"
}