Get the upgrade readiness status

Base URL: https://{kibana_url}

GET /api/upgrade_assistant/status

Check the status of your cluster.

Authentication

Api key

Authorization: <value>

These APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example: Authorization: ApiKey base64AccessApiKey

Basic

Authorization: Basic <credentials>

Response

200

Indicates a successful call.

application/json

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

GET kbn:/api/upgrade_assistant/status

Generated from the API spec

curl Shell

curl -X GET "${KIBANA_URL}/api/upgrade_assistant/status" \
  -H "Authorization: ApiKey ${API_KEY}"

Generated from the API spec

Response

{
  "readyForUpgrade": false,
  "cluster": [
    {
      "message": "Cluster deprecated issue",
      "details":"You have 2 system indices that must be migrated and 5 Elasticsearch deprecation issues and 0 Kibana deprecation issues that must be resolved before upgrading."
    }
  ]
}