11[role="xpack"]
2- [[migration-api-feature-upgrade ]]
3- === Feature Upgrade APIs
2+ [[feature- migration-api]]
3+ === Feature migration APIs
44++++
5- <titleabbrev>Feature upgrade APIs </titleabbrev>
5+ <titleabbrev>Feature migration </titleabbrev>
66++++
77
8- IMPORTANT: Use this API to check for system features that need to be upgraded before
9- a major version upgrade. You should run it on the last minor version of the
10- major version you are upgrading from.
8+ include::{es-repo-dir}/migration/apis/shared-migration-apis-tip.asciidoc[]
119
12- The feature upgrade APIs are to be used to retrieve information about system features
13- that have to be upgraded before a cluster can be migrated to the next major version number,
14- and to trigger an automated system upgrade that might potentially involve downtime for
15- {es} system features .
10+ Version upgrades sometimes require changes to how features store configuration
11+ information and data in system indices. The feature migration APIs enable you to
12+ see what features require changes, initiate the automatic migration process, and
13+ check migration status .
1614
17- [[feature-upgrade-api-request]]
15+ Some functionality might be temporarily unavailable during the migration
16+ process.
17+
18+ [[feature-migration-api-request]]
1819==== {api-request-title}
1920
2021`GET /migration/system_features`
2122
22- [[feature-upgrade-api-prereqs]]
23+ `POST /migration/system_features`
24+
25+ [[feature-migration-api-prereqs]]
2326==== {api-prereq-title}
2427
2528* If the {es} {security-features} are enabled, you must have the `manage`
2629<<privileges-list-cluster,cluster privilege>> to use this API.
2730
28- [[feature-upgrade-api-example]]
31+ [[feature-migration-api-desc]]
32+ ==== {api-description-title}
33+
34+ Submit a GET request to the `_migration/system_features` endpoint to see what
35+ features need to be migrated and the status of any migrations that are in
36+ progress.
37+
38+ Submit a POST request to the endpoint to start the migration process.
39+
40+ [[feature-migration-api-example]]
2941==== {api-examples-title}
3042
31- To see the list of system features needing upgrades, submit a GET request to the
32- `_migration/system_features` endpoint:
43+ When you submit a GET request to the `_migration/system_features` endpoint, the
44+ response indicates the status of any features that need to be migrated.
3345
3446[source,console]
3547--------------------------------------------------
@@ -120,10 +132,10 @@ Example response:
120132--------------------------------------------------
121133// TESTRESPONSE[s/"minimum_index_version" : "8.0.0"/"minimum_index_version" : $body.$_path/]
122134
123- This response tells us that Elasticsearch security needs its internal
124- indices upgraded before we can upgrade the cluster to 8.0.
125135
126- To perform the required upgrade, submit a POST request to the same endpoint.
136+ When you submit a POST request to the `_migration/system_features` endpoint to
137+ start the migration process, the response indicates what features will be
138+ migrated.
127139
128140[source,console]
129141--------------------------------------------------
@@ -138,13 +150,13 @@ Example response:
138150 "accepted" : true,
139151 "features" : [
140152 {
141- "feature_name" : "security"
153+ "feature_name" : "security" <1>
142154 }
143155 ]
144156}
145157--------------------------------------------------
146158// TESTRESPONSE[skip: can't actually upgrade system indices in these tests]
147159
148- This tells us that the security index is being upgraded. To check the
149- overall status of the upgrade, call the endpoint with GET.
160+ <1> {es} security will be migrated before the cluster is upgraded.
150161
162+ Subsequent GET requests will return the status of the migration process.
0 commit comments