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