elasticsearch/docs/reference/ilm/apis/ilm-api.asciidoc
2024-12-31 11:32:29 -08:00

52 lines
1.4 KiB
Text

[[index-lifecycle-management-api]]
== {ilm-cap} APIs
.New API reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-ilm[{ilm-cap} APIs].
--
You use the following APIs to set up policies to automatically manage the index lifecycle.
For more information about {ilm} ({ilm-init}), see <<index-lifecycle-management>>.
[discrete]
[[ilm-api-policy-endpoint]]
=== Policy management APIs
* <<ilm-put-lifecycle,Create lifecycle policy>>
* <<ilm-get-lifecycle,Get lifecycle policy>>
* <<ilm-delete-lifecycle,Delete lifecycle policy>>
[discrete]
[[ilm-api-index-endpoint]]
=== Index management APIs
* <<ilm-move-to-step,Move index to step>>
* <<ilm-retry-policy,Retry policy on indices>>
* <<ilm-remove-policy,Remove policy from index>>
[discrete]
[[ilm-api-management-endpoint]]
=== Operation management APIs
* <<ilm-get-status,Get {ilm-init} operation mode>>
* <<ilm-start,Start {ilm-init}>>
* <<ilm-stop,Stop {ilm-init}>>
* <<ilm-explain-lifecycle,Explain API>>
* <<ilm-migrate-to-data-tiers,Migrate to data tiers routing API>>
include::put-lifecycle.asciidoc[]
include::get-lifecycle.asciidoc[]
include::delete-lifecycle.asciidoc[]
include::move-to-step.asciidoc[]
include::remove-policy-from-index.asciidoc[]
include::retry-policy.asciidoc[]
include::get-status.asciidoc[]
include::explain.asciidoc[]
include::start.asciidoc[]
include::stop.asciidoc[]
include::migrate-to-data-tiers.asciidoc[]