remove_lifecycle_policy_from_index.asciidoc 1.1 KB

1234567891011121314151617181920212223242526272829303132333435363738
  1. --
  2. :api: ilm-remove-lifecycle-policy-from-index
  3. :request: RemoveIndexLifecyclePolicyRequest
  4. :response: AcknowledgedResponse
  5. --
  6. [role="xpack"]
  7. [id="{upid}-{api}"]
  8. === Remove Policy from Index API
  9. [id="{upid}-{api}-request"]
  10. ==== Request
  11. Removes the assigned lifecycle policy from an index.
  12. ["source","java",subs="attributes,callouts,macros"]
  13. --------------------------------------------------
  14. include-tagged::{doc-tests-file}[{api}-request]
  15. --------------------------------------------------
  16. <1> removes the `my_policy` policy from `my_index`
  17. [id="{upid}-{api}-response"]
  18. ==== Response
  19. The returned +{response}+ indicates if the request to remove
  20. the lifecycle policy from the index was received.
  21. ["source","java",subs="attributes,callouts,macros"]
  22. --------------------------------------------------
  23. include-tagged::{doc-tests-file}[{api}-response]
  24. --------------------------------------------------
  25. <1> Whether or not there were any policies failed
  26. to be removed from any indices from the request
  27. <2> A list of index names which are still managed
  28. by their policies.
  29. include::../execution.asciidoc[]