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.
« Batch start or resume reindex API Add default field API »
Elastic Docs ›Kibana Guide [7.13] ›REST API ›Upgrade assistant APIs

Batch reindex queue API

edit

Batch reindex queue API

edit

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

Check the current reindex batch queue.

Request

edit

GET /api/upgrade_assistant/reindex/batch/queue

Response code

edit
200
Indicates a successful call.

Example

edit

The API returns the following:

{
  "queue": [ 
    {
      "indexName": "index1",
      "newIndexName": "reindexed-v8-index2",
      "status": 3,
      "lastCompletedStep": 0,
      "locked": null,
      "reindexTaskId": null,
      "reindexTaskPercComplete": null,
      "errorMessage": null,
      "runningReindexCount": null,
      "reindexOptions": {
        "queueSettings": {
          "queuedAt": 1583406985489
        }
      }
    },
    {
      "indexName": "index2",
      "newIndexName": "reindexed-v8-index2",
      "status": 3,
      "lastCompletedStep": 0,
      "locked": null,
      "reindexTaskId": null,
      "reindexTaskPercComplete": null,
      "errorMessage": null,
      "runningReindexCount": null,
      "reindexOptions": {
        "queueSettings": {
          "queuedAt": 1583406987334
        }
      }
    }
  ]
}

Items in this array indicate reindex tasks at a given point in time and the order in which they will be executed.
« Batch start or resume reindex API Add default field API »

On this page

Was this helpful?
Feedback