Start the feature migration

POST /_migration/system_features

Version upgrades sometimes require changes to how features store configuration information and data in system indices. This API starts the automatic migration process.

Some functionality might be temporarily unavailable during the migration process.

Tip

The API is designed for indirect use by the Upgrade Assistant. We strongly recommend you use the Upgrade Assistant.

Required authorization

Authentication

Api key

Authorization: <value>

Elasticsearch APIs support key-based authentication. You must create an API key and use the encoded value in the request header. For example:

		curl -X GET "${ES_URL}/_cat/indices?v=true" \
  -H "Authorization: ApiKey ${API_KEY}"

To get API keys, use the /_security/api_key APIs.

Basic

Authorization: Basic <credentials>

Bearer

Authorization: Bearer <token>

Elasticsearch APIs support the use of bearer tokens in the Authorization HTTP header to authenticate with the API. For examples, refer to Token-based authentication services

Response

application/json

Examples

Request Console 1 / 7 languages

Console Kibana Dev Tools

POST /_migration/system_features

JavaScript Elasticsearch JavaScript Client

const response = await client.migration.postFeatureUpgrade();

Python Elasticsearch Python Client

resp = client.migration.post_feature_upgrade()

curl Shell

curl -X POST "$ELASTICSEARCH_URL/_migration/system_features" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.migration().postFeatureUpgrade();

PHP Elasticsearch PHP Client

$resp = $client->migration()->postFeatureUpgrade();

Ruby Elasticsearch Ruby Client

response = client.migration.post_feature_upgrade

Response

When you run POST /_migration/system_features to start the migration process, the response lists the features that will be migrated.

{
  "accepted" : true,
  "features" : [
    {
      "feature_name" : "security"
    }
  ]
}