OpenSearch/x-pack/docs/en/ilm/apis/ilm-api.asciidoc
Tal Levy 2846effc74
initial api reference docs for ILM (#33866)
This adds the bulk of the ILM APIs in docs with examples
2018-10-16 12:18:54 -07:00

45 lines
1.1 KiB
Plaintext

[[index-lifecycle-management-api]]
== Index Lifecycle Management API
You can use the following APIs to manage policies on indices.
[float]
[[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>>
[float]
[[ilm-api-index-endpoint]]
=== Index Management APIs
* <<ilm-move-to-step,Move Index To Step>>
* <<ilm-set-policy,Set Policy On Index>>
* <<ilm-retry-policy,Retry Policy On Indices>>
[float]
[[ilm-api-management-endpoint]]
=== Operation Management APIs
* <<ilm-get-status,Get ILM Operation Mode>>
* <<ilm-start,Start ILM>>
* <<ilm-stop,Stop ILM>>
* <<ilm-explain,Explain API>>
include::put-lifecycle.asciidoc[]
include::get-lifecycle.asciidoc[]
include::delete-lifecycle.asciidoc[]
include::move-to-step.asciidoc[]
include::set-policy.asciidoc[]
include::remove-policy.asciidoc[]
include::retry-policy.asciidoc[]
include::get-status.asciidoc[]
include::explain.asciidoc[]
include::start.asciidoc[]
include::stop.asciidoc[]