Get Deployment upgrade assistant status

Base URL
https://api.elastic-cloud.com/api/v1
No auth

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

Path parameters

deployment_id string required

Identifier for the Deployment

Query parameters

target_version string

If present, value is included in resource request to provide additional context (only supported for Kibana)

Responses

The Upgrade Assistant returned the status successfully

application/json
ready_for_upgrade boolean required

A boolean indicating whether or not the cluster is ready to be upgraded

details string required

Message with information about the number of Elasticsearch and Kibana deprecations

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

application/json
errors object[] required

A list of errors that occurred in the failing request

code string required

A structured code representing the error type that occurred

message string required

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

Base URL
https://api.elastic-cloud.com/api/v1