2019-02-13 21:12:19 +01:00
[role="xpack"]
[[upgrade-assistant-api]]
2019-09-06 18:09:57 +02:00
== Upgrade assistant APIs
2019-02-13 21:12:19 +01:00
2020-03-20 22:33:20 +01:00
Check the upgrade status of your {es} cluster and reindex indices that were created in the previous major version. The assistant helps you prepare for the next major version of {es}.
2019-02-13 21:12:19 +01:00
2019-10-16 22:10:40 +02:00
The following upgrade assistant APIs are available:
* <<upgrade-assistant-api-status, Upgrade readiness status API>> to check the status of your cluster
* <<start-resume-reindex, Start or resume reindex API>> to start a new reindex or resume a paused reindex
2020-03-20 11:44:35 +01:00
* <<batch-start-resume-reindex, Batch start or resume reindex API>> to start or resume multiple reindex tasks
* <<batch-reindex-queue, Batch reindex queue API>> to check the current reindex batch queue
2019-10-16 22:10:40 +02:00
* <<check-reindex-status, Check reindex status API>> to check the status of the reindex operation
2020-03-20 22:33:20 +01:00
* <<cancel-reindex, Cancel reindex API>> to cancel reindexes that are waiting for the {es} reindex task to complete
2019-02-13 21:12:19 +01:00
include::upgrade-assistant/status.asciidoc[]
include::upgrade-assistant/reindexing.asciidoc[]
2020-03-20 11:44:35 +01:00
include::upgrade-assistant/batch_reindexing.asciidoc[]
include::upgrade-assistant/batch_queue.asciidoc[]
2019-09-06 18:09:57 +02:00
include::upgrade-assistant/check_reindex_status.asciidoc[]
include::upgrade-assistant/cancel_reindex.asciidoc[]