Get Deployment upgrade assistant status

Auth

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

Path parameters

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

Examples

Request curl 1 / 1 language

curl Shell

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

Generated from the API spec

Response

{
  "ready_for_upgrade": false,
  "details": "string"
}

Generated from the API spec

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

Generated from the API spec