New

The executive guide to generative AI

Read more
About usPartnersSupport|Login
IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Upgrade readiness status API Add default field API »
Elastic Docs ›Kibana Guide [7.4] ›REST API ›Upgrade assistant APIs

Start or resume reindex API

edit

Start or resume reindex API

edit

Start a new reindex or resume a paused reindex.

The underlying Upgrade Assistant concepts are stable, but the APIs for managing Upgrade Assistant are experimental.

Request

edit

POST /api/upgrade_assistant/reindex/myIndex

Response code

edit
200
Indicates a successful call.

Example

edit

The API returns the following:

{
  "indexName": ".ml-state",
  "newIndexName": ".reindexed-v7-ml-state", 
  "status": 0, 
  "lastCompletedStep": 0, 
  "reindexTaskId": null, 
  "reindexTaskPercComplete": null, 
  "errorMessage": null 
}

Name of the new index that is being created.

Current status of the reindex. For details, see Status codes.

Last successfully completed step of the reindex. For details, see Step codes table.

Task ID of the reindex task in Elasticsearch. Only present if reindexing has started.

Percentage of how far the reindexing task in Elasticsearch has progressed, in decimal from from 0 to 1.

Error that caused the reindex to fail, if it failed.
« Upgrade readiness status API Add default field API »

On this page

Was this helpful?
Feedback