Get index lifecycle management status APIedit
Retrieves the current index lifecycle management (ILM) status.
Requestedit
GET /_ilm/status
Prerequisitesedit
-
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.
Descriptionedit
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 parametersedit
-
master_timeout
-
(Optional, time units)
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. Defaults to
30s
. -
timeout
-
(Optional, time units)
Period to wait for a response. If no response is received before the timeout
expires, the request fails and returns an error. Defaults to
30s
.
Examplesedit
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" }