WARNING: Version 1.4 of Elasticsearch has passed its EOL date.

This documentation is no longer being maintained and may be removed. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.

« Optimize cat APIs »

› ›

Upgrade

edit

Upgrade

edit

The upgrade API allows to upgrade one or more indices to the latest format through an API. The upgrade process converts any segments written with previous formats.

Start an upgrade

edit

$ curl -XPOST 'http://localhost:9200/twitter/_upgrade'

Upgrading is an I/O intensive operation, and is limited to processing a single shard per node at a time. It also is not allowed to run at the same time as optimize.

Request Parameters

edit

The upgrade API accepts the following request parameters:

wait_for_completion

Should the request wait for the upgrade to complete. Defaults to true.

Check upgrade status

edit

Use a GET request to monitor how much of an index is upgraded. This can also be used prior to starting an upgrade to identify which indices you want to upgrade at the same time.

curl 'http://localhost:9200/twitter/_upgrade?pretty&human'

{
   "twitter": {
      "size": "21gb",
      "size_in_bytes": "21000000000",
      "size_to_upgrade": "10gb",
      "size_to_upgrade_in_bytes": "10000000000"
   }
}

« Optimize cat APIs »