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 Batch start or resume reindex API »
Elastic Docs ›Kibana Guide [7.12] ›REST API ›Upgrade assistant APIs

Start or resume reindex API

edit

Start or resume reindex API

edit

[preview] This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. Start a new reindex or resume a paused reindex.

Start a new reindex or resume a paused reindex.

Request

edit

POST <kibana host>:<port>/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 
}

The name of the new index.

The reindex status. For more information, refer to Status codes.

The last successfully completed step of the reindex. For more information, refer to Step codes.

The task ID of the reindex task in Elasticsearch. Appears when the reindexing starts.

The progress of the reindexing task in Elasticsearch. Appears in decimal form, from 0 to 1.

The error that caused the reindex to fail, if it failed.
« Upgrade readiness status API Batch start or resume reindex API »

On this page

Was this helpful?
Feedback