elasticsearch/docs/reference/ilm/apis/get-status.asciidoc

[role="xpack"]
[testenv="basic"]
[[ilm-get-status]]
=== Get {ilm} status API

[subs="attributes"]
++++
<titleabbrev>Get {ilm} status</titleabbrev>
++++

Retrieves the current {ilm} ({ilm-init}) status.

You can start or stop {ilm-init} with the <<ilm-start,start {ilm-init}>> and
<<ilm-stop,stop {ilm-init}>> APIs.

[[ilm-get-status-request]]
==== {api-request-title}

`GET /_ilm/status`

[[ilm-get-status-prereqs]]
==== {api-prereq-title}

* If the {es} {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>>.

[[ilm-get-status-query-params]]
==== {api-query-parms-title}

include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]

[role="child_attributes"]
[[ilm-get-status-response-body]]
==== {api-response-body-title}

[[ilm-operating-modes]]
`operation_mode`::
(string) Current operation mode for {ilm-init}.
+
.Possible values for `operation_mode`
[%collapsible%open]
====
`RUNNING`::
{ilm-init} is running.

`STOPPING`::
{ilm-init} is finishing sensitive actions, such as <<ilm-shrink,shrink>>, that
are in progress. When these actions finish, {ilm-init} will move to `STOPPED`.

`STOPPED`::
{ilm-init} is not running.
====

[[ilm-get-status-example]]
==== {api-examples-title}

The following example gets the {ilm-init} plugin status.

[source,console]
--------------------------------------------------
GET _ilm/status
--------------------------------------------------

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

[source,console-result]
--------------------------------------------------
{
  "operation_mode": "RUNNING"
}
--------------------------------------------------