New

The executive guide to generative AI

Read more
About usPartnersSupport|Login
IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Upgrade assistant APIs Start or resume reindex API »
Elastic Docs ›Kibana Guide [7.4] ›REST API ›Upgrade assistant APIs

Upgrade readiness status API

edit
IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

Upgrade readiness status API

edit

Check the status of your cluster.

The underlying Upgrade Assistant concepts are stable, but the APIs for managing Upgrade Assistant are experimental.

Request

edit

GET /api/upgrade_assistant/status

Response codes

edit
200
Indicates a successful call.

Example

edit

The API returns the following:

{
  "readyForUpgrade": false,
  "cluster": [
    {
      "message": "Cluster deprecated issue",
      "details": "...",
      "level": "warning",
      "url": "https://docs.elastic.co/..."
    }
  ],
  "indices": [
    {
      "message": "Index was created before 6.0",
      "details": "...",
      "index": "myIndex",
      "level": "critical",
      "reindex": true, 
      "url": "https://docs.elastic.co/..."
    }
  ]
}

To fix indices with the reindex attribute, set to true using the Start or resume reindex API.
« Upgrade assistant APIs Start or resume reindex API »

On this page

Was this helpful?
Feedback