Get Deployment upgrade assistant status

GET /deployments/{deployment_id}/upgrade_assistant/status

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

Path parameters

Query parameters

  • target_version string

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

Responses

  • 200 application/json

    The Upgrade Assistant returned the status successfully

    Hide response attributes Show response attributes object
    • 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
  • 404 application/json

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

    Hide headers attribute Show headers attribute
    • x-cloud-error-codes string

      The error codes associated with the response

      Value is deployments.deployment_not_found.

    Hide response attribute Show response attribute object
    • errors array[object] Required

      A list of errors that occurred in the failing request

      Hide errors attributes Show errors attributes object
      • 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 array[string]

        If the error can be tied to a specific field or fields in the user request, this lists those fields
GET /deployments/{deployment_id}/upgrade_assistant/status 
curl \
 --request GET 'https://api.elastic-cloud.com/api/v1/deployments/{deployment_id}/upgrade_assistant/status'
Response examples (200) 
{
  "ready_for_upgrade": true,
  "details": "string"
}
Response examples (404) 
# Headers
x-cloud-error-codes: deployments.deployment_not_found

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}