stop_lifecycle_management.asciidoc 967 B

1234567891011121314151617181920212223242526272829303132333435363738
  1. --
  2. :api: ilm-stop-ilm
  3. :request: StopILMRequest
  4. :response: AcknowledgedResponse
  5. --
  6. [role="xpack"]
  7. [id="{upid}-{api}"]
  8. === Stop Index Lifecycle Management API
  9. [id="{upid}-{api}-request"]
  10. ==== Request
  11. The Stop Lifecycle Management API allows you to stop Index Lifecycle
  12. Management temporarily.
  13. ["source","java",subs="attributes,callouts,macros"]
  14. --------------------------------------------------
  15. include-tagged::{doc-tests-file}[{api}-request]
  16. --------------------------------------------------
  17. [id="{upid}-{api}-response"]
  18. ==== Response
  19. The returned +{response}+ indicates if the request to stop Index Lifecycle
  20. Management was received.
  21. ["source","java",subs="attributes,callouts,macros"]
  22. --------------------------------------------------
  23. include-tagged::{doc-tests-file}[{api}-response]
  24. --------------------------------------------------
  25. <1> Whether or not the request to stop Index Lifecycle Management was
  26. acknowledged.
  27. include::../execution.asciidoc[]