2018-10-16 15:18:54 -04:00
|
|
|
[[index-lifecycle-management-api]]
|
2018-12-20 13:23:28 -05:00
|
|
|
== {ilm-cap} API
|
2018-10-16 15:18:54 -04:00
|
|
|
|
2019-11-20 11:19:33 -05:00
|
|
|
You can use the following APIs to manage policies on indices. For more
|
|
|
|
information, see <<index-lifecycle-management>>.
|
2018-10-16 15:18:54 -04:00
|
|
|
|
|
|
|
[float]
|
|
|
|
[[ilm-api-policy-endpoint]]
|
2018-12-20 13:23:28 -05:00
|
|
|
=== Policy management APIs
|
2018-10-16 15:18:54 -04:00
|
|
|
|
2018-12-20 13:23:28 -05:00
|
|
|
* <<ilm-put-lifecycle,Create lifecycle policy>>
|
|
|
|
* <<ilm-get-lifecycle,Get lifecycle policy>>
|
|
|
|
* <<ilm-delete-lifecycle,Delete lifecycle policy>>
|
2018-10-16 15:18:54 -04:00
|
|
|
|
|
|
|
[float]
|
|
|
|
[[ilm-api-index-endpoint]]
|
2018-12-20 13:23:28 -05:00
|
|
|
=== Index management APIs
|
2018-10-16 15:18:54 -04:00
|
|
|
|
2018-12-20 13:23:28 -05:00
|
|
|
* <<ilm-move-to-step,Move index to step>>
|
|
|
|
* <<ilm-retry-policy,Retry policy on indices>>
|
2019-02-05 16:42:31 -05:00
|
|
|
* <<ilm-remove-policy,Remove policy from index>>
|
2018-10-16 15:18:54 -04:00
|
|
|
|
|
|
|
[float]
|
|
|
|
[[ilm-api-management-endpoint]]
|
2018-12-20 13:23:28 -05:00
|
|
|
=== Operation management APIs
|
2018-10-16 15:18:54 -04:00
|
|
|
|
2018-12-20 13:23:28 -05:00
|
|
|
* <<ilm-get-status,Get ILM operation mode>>
|
2018-10-16 15:18:54 -04:00
|
|
|
* <<ilm-start,Start ILM>>
|
|
|
|
* <<ilm-stop,Stop ILM>>
|
2018-11-08 18:26:27 -05:00
|
|
|
* <<ilm-explain-lifecycle,Explain API>>
|
2018-10-16 15:18:54 -04:00
|
|
|
|
|
|
|
|
|
|
|
include::put-lifecycle.asciidoc[]
|
|
|
|
include::get-lifecycle.asciidoc[]
|
|
|
|
include::delete-lifecycle.asciidoc[]
|
|
|
|
|
|
|
|
include::move-to-step.asciidoc[]
|
2018-11-27 16:28:58 -05:00
|
|
|
include::remove-policy-from-index.asciidoc[]
|
2018-10-16 15:18:54 -04:00
|
|
|
include::retry-policy.asciidoc[]
|
|
|
|
|
|
|
|
include::get-status.asciidoc[]
|
|
|
|
include::explain.asciidoc[]
|
|
|
|
include::start.asciidoc[]
|
|
|
|
include::stop.asciidoc[]
|