ilm-api.asciidoc 1.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344
  1. [[index-lifecycle-management-api]]
  2. == {ilm-cap} API
  3. You can use the following APIs to manage policies on indices. See
  4. <<index-lifecycle-management,Managing the index lifecycle>> for more information
  5. about Index Lifecycle Management.
  6. [float]
  7. [[ilm-api-policy-endpoint]]
  8. === Policy management APIs
  9. * <<ilm-put-lifecycle,Create lifecycle policy>>
  10. * <<ilm-get-lifecycle,Get lifecycle policy>>
  11. * <<ilm-delete-lifecycle,Delete lifecycle policy>>
  12. [float]
  13. [[ilm-api-index-endpoint]]
  14. === Index management APIs
  15. * <<ilm-move-to-step,Move index to step>>
  16. * <<ilm-retry-policy,Retry policy on indices>>
  17. [float]
  18. [[ilm-api-management-endpoint]]
  19. === Operation management APIs
  20. * <<ilm-get-status,Get ILM operation mode>>
  21. * <<ilm-start,Start ILM>>
  22. * <<ilm-stop,Stop ILM>>
  23. * <<ilm-explain-lifecycle,Explain API>>
  24. include::put-lifecycle.asciidoc[]
  25. include::get-lifecycle.asciidoc[]
  26. include::delete-lifecycle.asciidoc[]
  27. include::move-to-step.asciidoc[]
  28. include::remove-policy-from-index.asciidoc[]
  29. include::retry-policy.asciidoc[]
  30. include::get-status.asciidoc[]
  31. include::explain.asciidoc[]
  32. include::start.asciidoc[]
  33. include::stop.asciidoc[]