Get feature migration information

  • GET /_migration/system_features
Auth

Version upgrades sometimes require changes to how features store configuration information and data in system indices. Check which features need to be migrated and the status of any migrations that are in progress.

Tip

This API is designed for indirect use by the Upgrade Assistant. You are strongly recommended to use the Upgrade Assistant.

Required authorization

Index privileges manage
Cluster privileges manage

Response

application/json
features object[] required
feature_name string required
minimum_index_version string required
migration_status enum required
Values: NO_MIGRATION_NEEDED MIGRATION_NEEDED IN_PROGRESS ERROR
indices object[] required
index string required
version string required
failure_cause object
type string required

The type of error

reason union string nullable

A human-readable explanation of the error, in English.

One of: string
stack_trace string

The server stack trace. Present only if the error_trace=true parameter was sent with the request.

caused_by object
Same fields as failure_cause in indices
root_cause object[]
Same fields as failure_cause in indices
suppressed object[]
Same fields as failure_cause in indices
migration_status enum required
Values: NO_MIGRATION_NEEDED MIGRATION_NEEDED IN_PROGRESS ERROR