Docs
-->
Elasticsearch Reference [7.0] » X-Pack APIs » Index lifecycle management API » Get index lifecycle management status API
«  Retry policy execution API     Explain lifecycle API  »

Get index lifecycle management status API

Retrieves the current index lifecycle management (ILM) status.

Request

GET /_ilm/status

Description

Returns the status of the ILM plugin. The operation_mode field in the response shows one of three states: STARTED, STOPPING, or STOPPED. You can change the status of the ILM plugin with the Start ILM and Stop ILM APIs.

Request Parameters

timeout
(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. For more information about time units, see Time units.
master_timeout
(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. For more information about time units, see Time units.

Authorization

You must have the manage_ilm or read_ilm or both cluster privileges to use this API. For more information, see Security Privileges.

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"
}
«  Retry policy execution API     Explain lifecycle API  »