Batch start or resume reindexing

Base URL: https://{kibana_url}

POST /api/upgrade_assistant/reindex/batch

Auth

Start or resume multiple reindexing tasks in one request. Additionally, reindexing tasks started or resumed via the batch endpoint will be placed on a queue and run one-by-one, which ensures that minimal cluster resources are consumed over time.

Request body

indexNames string[] required: The list of index names to be reindexed. The order of the indices determines the order that the reindex tasks are run.

Response

Indicates a successful call.

application/json

enqueued object[]: A list of reindex tasks created. The order in the array indicates the order in which tasks will be run.
errors object[]: A list of errors that may have occurred preventing the reindex task from being created.

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST kbn:/api/upgrade_assistant/reindex/batch
{
  "indexNames": [
    "string"
  ]
}

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/upgrade_assistant/reindex/batch" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "indexNames": [
      "string"
    ]
  }'

Generated from the API spec

Response

{
  "enqueued": [ 
    {
      "indexName": "index1",
      "newIndexName": "reindexed-v8-index1",
      "status": 3,
      "lastCompletedStep": 0,
      "locked": null,
      "reindexTaskId": null,
      "reindexTaskPercComplete": null,
      "errorMessage": null,
      "runningReindexCount": null,
      "reindexOptions": { 
        "queueSettings": {
          "queuedAt": 1583406985489 
        }
      }
    }
  ],
  "errors": [ 
    {
      "indexName": "index2",
      "message": "Something went wrong!"
    }
  ]
}

Request body { }

Response

Request body