NOTE: You are looking at documentation for an older release. For the latest information, see the current release documentation.

« Migration APIs Migration upgrade API »

› › ›

Migration assistance API

edit

Migration assistance API

edit

The Migration Assistance API is deprecated, use the deprecation info API instead, which provides more complete and detailed information about actions necessary prior to upgrade.

[6.7] Deprecated in 6.7. Use the Deprecation Info API instead. The migration assistance API analyzes existing indices in the cluster and returns the information about indices that require some changes before the cluster can be upgraded to the next major version.

Request

edit

GET /_xpack/migration/assistance

GET /_xpack/migration/assistance/<index_name>

Path Parameters

edit

index_name: (string) Identifier for the index. It can be an index name or a wildcard expression.

Examples

edit

To see a list of indices that needs to be upgraded or reindexed, submit a GET request to the /_xpack/migration/assistance endpoint:

GET /_xpack/migration/assistance

A successful call returns a list of indices that need to be updated or reindexed:

{
  "indices" : {
    ".watches" : {
      "action_required" : "upgrade"
    },
    ".security" : {
      "action_required" : "upgrade"
    },
    "my_old_index": {
      "action_required" : "reindex"
    },
    "my_other_old_index": {
      "action_required" : "reindex"
    }
  }
}

To check a particular index or set of indices, specify this index name or mask as the last part of the /_xpack/migration/assistance/index_name endpoint:

GET /_xpack/migration/assistance/my_*

A successful call returns a list of indices that needs to be updated or reindexed and match the index specified on the endpoint:

{
  "indices" : {
    "my_old_index": {
      "action_required" : "reindex"
    },
    "my_other_old_index": {
      "action_required" : "reindex"
    }
  }
}

« Migration APIs Migration upgrade API »