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 API Reindex API »
Elastic Docs ›Kibana Guide [7.3] ›REST API ›Upgrade Assistant API

Upgrade Readiness Status

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

Upgrade Readiness Status

edit

This API is experimental and may be changed or removed completely in a future release. The underlying Upgrade Assistant concepts are stable, but the APIs for managing Upgrade Assistant are currently experimental.

Request

edit

To check the status of your cluster, submit a GET request to the /api/upgrade_assistant/status endpoint:

Note: You cannot access this endpoint via the Console in Kibana.

GET /api/upgrade_assistant/status
Copy as curl 

Response

edit

A successful call returns a response code of 200 and a response body containing a JSON structure similar to the following example:

{
  "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/..."
    }
  ]
}

You can fix indices with the reindex attribute set to true using the Reindex API.
« Upgrade Assistant API Reindex API »
Was this helpful?
Feedback