--
:api: ilm-stop-ilm
:request: StopILMRequest
:response: AcknowledgedResponse
--
[role="xpack"]
[id="{upid}-{api}"]
=== Stop Index Lifecycle Management API


[id="{upid}-{api}-request"]
==== Request

The Stop Lifecycle Management API allows you to stop Index Lifecycle
Management temporarily.

["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{doc-tests-file}[{api}-request]
--------------------------------------------------


[id="{upid}-{api}-response"]
==== Response

The returned +{response}+ indicates if the request to stop Index Lifecycle
Management was received.

["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{doc-tests-file}[{api}-response]
--------------------------------------------------
<1> Whether or not the request to stop Index Lifecycle Management was
acknowledged.

include::../execution.asciidoc[]