elasticsearch/docs/reference/ilm/apis/ilm-api.asciidoc

[[index-lifecycle-management-api]]
== {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[]
initial api reference docs for ILM (#33866) This adds the bulk of the ILM APIs in docs with examples 2018-10-17 03:18:54 +08:00			`[[index-lifecycle-management-api]]`
[DOCS] Fix API titles (#67475) 2021-01-14 04:15:37 +08:00			`== {ilm-cap} APIs`
initial api reference docs for ILM (#33866) This adds the bulk of the ILM APIs in docs with examples 2018-10-17 03:18:54 +08:00
Add migrate to data tiers API (#74264) This adds the _ilm/migrate_to_data_tiers API to expose the service for migrating the elasticsearch abstractions (indices, ILM policies and an optional legacy template to delete) to data tiers routing allocation (away from custom node attributes) 2021-06-28 19:07:39 +08:00			`You use the following APIs to set up policies to automatically manage the index lifecycle.`
[DOCS] Align with ILM API docs (#48705) * [DOCS] Reconciled with Snapshot/Restore reorg 2020-01-22 11:58:17 +08:00			`For more information about {ilm} ({ilm-init}), see <<index-lifecycle-management>>.`
initial api reference docs for ILM (#33866) This adds the bulk of the ILM APIs in docs with examples 2018-10-17 03:18:54 +08:00
[DOCS] Rework conceptual info for ILM. (#52181) * [DOCS] Rework conceptual info for ILM. * Split the actions out of concepts. * Added xpack role to actions. Co-Authored-By: James Rodewig <james.rodewig@elastic.co> * Apply suggestions from code review 2020-04-23 04:53:30 +08:00			`[discrete]`
initial api reference docs for ILM (#33866) This adds the bulk of the ILM APIs in docs with examples 2018-10-17 03:18:54 +08:00			`[[ilm-api-policy-endpoint]]`
[DOCS] Synchs titles of X-Pack APIs 2018-12-21 02:23:28 +08:00			`=== Policy management APIs`
initial api reference docs for ILM (#33866) This adds the bulk of the ILM APIs in docs with examples 2018-10-17 03:18:54 +08:00
[DOCS] Synchs titles of X-Pack APIs 2018-12-21 02:23:28 +08:00			`* <<ilm-put-lifecycle,Create lifecycle policy>>`
			`* <<ilm-get-lifecycle,Get lifecycle policy>>`
			`* <<ilm-delete-lifecycle,Delete lifecycle policy>>`
initial api reference docs for ILM (#33866) This adds the bulk of the ILM APIs in docs with examples 2018-10-17 03:18:54 +08:00
[DOCS] Rework conceptual info for ILM. (#52181) * [DOCS] Rework conceptual info for ILM. * Split the actions out of concepts. * Added xpack role to actions. Co-Authored-By: James Rodewig <james.rodewig@elastic.co> * Apply suggestions from code review 2020-04-23 04:53:30 +08:00			`[discrete]`
initial api reference docs for ILM (#33866) This adds the bulk of the ILM APIs in docs with examples 2018-10-17 03:18:54 +08:00			`[[ilm-api-index-endpoint]]`
[DOCS] Synchs titles of X-Pack APIs 2018-12-21 02:23:28 +08:00			`=== Index management APIs`
initial api reference docs for ILM (#33866) This adds the bulk of the ILM APIs in docs with examples 2018-10-17 03:18:54 +08:00
[DOCS] Synchs titles of X-Pack APIs 2018-12-21 02:23:28 +08:00			`* <<ilm-move-to-step,Move index to step>>`
			`* <<ilm-retry-policy,Retry policy on indices>>`
Update ilm-api.asciidoc, point to REMOVE policy (#38235) (#38463) 2019-02-06 05:42:31 +08:00			`* <<ilm-remove-policy,Remove policy from index>>`
initial api reference docs for ILM (#33866) This adds the bulk of the ILM APIs in docs with examples 2018-10-17 03:18:54 +08:00
[DOCS] Rework conceptual info for ILM. (#52181) * [DOCS] Rework conceptual info for ILM. * Split the actions out of concepts. * Added xpack role to actions. Co-Authored-By: James Rodewig <james.rodewig@elastic.co> * Apply suggestions from code review 2020-04-23 04:53:30 +08:00			`[discrete]`
initial api reference docs for ILM (#33866) This adds the bulk of the ILM APIs in docs with examples 2018-10-17 03:18:54 +08:00			`[[ilm-api-management-endpoint]]`
[DOCS] Synchs titles of X-Pack APIs 2018-12-21 02:23:28 +08:00			`=== Operation management APIs`
initial api reference docs for ILM (#33866) This adds the bulk of the ILM APIs in docs with examples 2018-10-17 03:18:54 +08:00
[DOCS] Rework conceptual info for ILM. (#52181) * [DOCS] Rework conceptual info for ILM. * Split the actions out of concepts. * Added xpack role to actions. Co-Authored-By: James Rodewig <james.rodewig@elastic.co> * Apply suggestions from code review 2020-04-23 04:53:30 +08:00			`* <<ilm-get-status,Get {ilm-init} operation mode>>`
			`* <<ilm-start,Start {ilm-init}>>`
			`* <<ilm-stop,Stop {ilm-init}>>`
ILM API ref edits (#35112) * [DOCS] ILM API Ref edits * [DOCS] Fixed endpoint for DELETE policy. * [DOCS] Removed comparison to setting index.lifecycle.name to null. * [DOCS] Fixed xrefs to explain API. 2018-11-09 07:26:27 +08:00			`* <<ilm-explain-lifecycle,Explain API>>`
Add migrate to data tiers API (#74264) This adds the _ilm/migrate_to_data_tiers API to expose the service for migrating the elasticsearch abstractions (indices, ILM policies and an optional legacy template to delete) to data tiers routing allocation (away from custom node attributes) 2021-06-28 19:07:39 +08:00			`* <<ilm-migrate-to-data-tiers,Migrate to data tiers routing API>>`
initial api reference docs for ILM (#33866) This adds the bulk of the ILM APIs in docs with examples 2018-10-17 03:18:54 +08:00

			`include::put-lifecycle.asciidoc[]`
			`include::get-lifecycle.asciidoc[]`
			`include::delete-lifecycle.asciidoc[]`

			`include::move-to-step.asciidoc[]`
[ILM] add HLRC docs to remove-policy-from-index (#35759) This primarily introduces documentation for the HLRC remove-policy-from-index action. 2018-11-28 05:28:58 +08:00			`include::remove-policy-from-index.asciidoc[]`
initial api reference docs for ILM (#33866) This adds the bulk of the ILM APIs in docs with examples 2018-10-17 03:18:54 +08:00			`include::retry-policy.asciidoc[]`

			`include::get-status.asciidoc[]`
			`include::explain.asciidoc[]`
			`include::start.asciidoc[]`
			`include::stop.asciidoc[]`
Add migrate to data tiers API (#74264) This adds the _ilm/migrate_to_data_tiers API to expose the service for migrating the elasticsearch abstractions (indices, ILM policies and an optional legacy template to delete) to data tiers routing allocation (away from custom node attributes) 2021-06-28 19:07:39 +08:00			`include::migrate-to-data-tiers.asciidoc[]`