Get feature migration information | Elasticsearch API (v8)

Get feature migration information Added in 7.16.0

GET /_migration/system_features

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. We strongly recommend you use the Upgrade Assistant.

Responses

200 application/json
Hide response attributes Show response attributes object
- features array[object] Required
  
  Hide features attributes Show features attributes object
  
  feature_name string Required
  
  minimum_index_version string Required
  
  migration_status string Required
  
  Values are NO_MIGRATION_NEEDED, MIGRATION_NEEDED, IN_PROGRESS, or ERROR.
  
  indices array[object] Required
  
  Hide indices attributes Show indices attributes object
  
  index string Required
  
  version string Required
  
  failure_cause object
  
  Additional properties are allowed.
  
  Hide failure_cause attributes Show failure_cause attributes object
  
  type string Required
  
  The type of error
  
  reason string
  
  A human-readable explanation of the error, in english
  
  stack_trace string
  
  The server stack trace. Present only if the error_trace=true parameter was sent with the request.
  
  caused_by object
  
  Additional properties are allowed.
  
  root_cause array[object]
  
  suppressed array[object]
- migration_status string Required
  
  Values are NO_MIGRATION_NEEDED, MIGRATION_NEEDED, IN_PROGRESS, or ERROR.

GET /_migration/system_features

curl \
 -X GET http://api.example.com/_migration/system_features

Response examples (200)

{
  "features": [
    {
      "feature_name": "string",
      "minimum_index_version": "string",
      "migration_status": "NO_MIGRATION_NEEDED",
      "indices": [
        {
          "index": "string",
          "version": "string",
          "failure_cause": {
            "type": "string",
            "reason": "string",
            "stack_trace": "string",
            "caused_by": {},
            "root_cause": [
              {}
            ],
            "suppressed": [
              {}
            ]
          }
        }
      ]
    }
  ],
  "migration_status": "NO_MIGRATION_NEEDED"
}