---
type: api
title: Get the upgrade readiness status
description: Check the status of your cluster.
url: https://www.elastic.co/elastic/docs-builder/docs/4493/api/doc/kibana/v0/operation/operation-get-upgrade-status
resource: https://www.elastic.co/elastic/docs-builder/docs/4493/api/doc/kibana/v0/operation/operation-get-upgrade-status
products:
  - Kibana
---

# Get the upgrade readiness status

Availability: Preview

- Server: `https://{kibana_url}`

## Paths

- `GET` `/api/upgrade_assistant/status`

## Description

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

Indicates a successful call.

`application/json`

## Code examples

#### Console

```console
GET kbn:/api/upgrade_assistant/status
```

#### curl

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

## Response examples

#### Get upgrade status response example1

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