Start or resume reindexing Technical Preview

POST /api/upgrade_assistant/reindex/{index}
Api key auth Basic auth

Start a new reindex or resume a paused reindex. The following steps are performed during a reindex task:

  1. Set the index to read-only.
  2. Create a new index.
  3. Reindex documents into the new index.
  4. Create an index alias for the new index.
  5. Delete the old index.

Path parameters

  • index string Required

    The name of the index to reindex.

Responses

  • 200 application/json

    Indicates a successful call.

    Hide response attributes Show response attributes object
    • errorMessage string

      The error that caused the reindex to fail, if it failed.

    • indexName string

      The name of the old index.

    • lastCompletedStep integer

      The last successfully completed step of the reindex. For example:

      • 0: The reindex task has been created in Kibana. - 10: The index group services stopped. Only applies to some system indices. - 20: The index is set to readonly. - 30: The new destination index has been created. - 40: The reindex task in Elasticsearch has started. - 50: The reindex task in Elasticsearch has completed. - 60: Aliases were created to point to the new index, and the old index has been deleted. - 70: The index group services have resumed. Only applies to some system indices.
    • newIndexName string

      The name of the new index.

    • reindexTaskId string

      The task ID of the reindex task in Elasticsearch. This value appears when the reindexing starts.

    • reindexTaskPercComplete number

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

    • status integer

      The reindex status. For example:

      • 0: In progress - 1: Completed - 2: Failed - 3: Paused
POST /api/upgrade_assistant/reindex/{index} 
curl \
 --request POST http://localhost:5622/api/upgrade_assistant/reindex/{index} \
 --header "Authorization: $API_KEY"
Response examples (200) 
{
  "indexName": ".ml-state",
  "newIndexName": ".reindexed-v7-ml-state", 
  "status": 0, 
  "lastCompletedStep": 0, 
  "reindexTaskId": null, 
  "reindexTaskPercComplete": null, 
  "errorMessage": null 
}