---
type: api
title: Get Deployment upgrade assistant status
description: Get details about an Elasticsearch resource belonging to a given deployment.
url: https://www.elastic.co/elastic/docs-builder/docs/4493/api/doc/cloud-enterprise/v4/operation/operation-get-deployment-upgrade-assistant-status
resource: https://www.elastic.co/elastic/docs-builder/docs/4493/api/doc/cloud-enterprise/v4/operation/operation-get-deployment-upgrade-assistant-status
products:
  - Elastic Cloud Enterprise
---

# Get Deployment upgrade assistant status

## Paths

- `GET` `/deployments/{deployment_id}/upgrade_assistant/status`

#### Path parameters

- `deployment_id` (string) — required
  Identifier for the Deployment

## Description

Get details about an Elasticsearch resource belonging to a given deployment.

## Authentication

- Basic: `Authorization: Basic <credentials>`
- Api key: `Authorization: <value>`

## Query string parameters

- `target_version` (string) — optional
  If present, value is included in resource request to provide additional context (only supported for Kibana)

## Responses

#### `200`

The Upgrade Assistant returned the status successfully

`application/json`

- `ready_for_upgrade` (boolean)
  A boolean indicating whether or not the cluster is ready to be upgraded
- `details` (string)
  Message with information about the number of Elasticsearch and Kibana deprecations
#### `404`

The Deployment specified by {deployment_id} cannot be found. (code: `deployments.deployment_not_found`)

`application/json`

- `errors` (object[])
  A list of errors that occurred in the failing request
  - `code` (string)
    A structured code representing the error type that occurred
  - `message` (string)
    A human readable message describing the error that occurred
  - `fields` (string[])
    If the error can be tied to a specific field or fields in the user request, this lists those fields
##### Response headers

- `x-cloud-error-codes` (enum)
  The error codes associated with the response

## Code examples

#### curl

```curl
curl -X GET "${API_URL}/deployments/${DEPLOYMENT_ID}/upgrade_assistant/status" \
  -u "${USERNAME}:${PASSWORD}"
```