Start the feature migration

POST /_migration/system_features

Auth

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

Index privileges manage
Cluster privileges manage

Response

application/json

accepted boolean required
features object[]
reason string

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"
    }
  ]
}