Upgrade Kibana, APM, Integrations Server, AppSearch, Enterprise Search inside Deployment

POST /deployments/{deployment_id}/{stateless_resource_kind}/{ref_id}/_upgrade

Auth

Warning

This endpoint is deprecated and scheduled to be removed in the next major version. Use Update deployment instead.

Upgrades a running cluster.

Path parameters

deployment_id string required: Identifier for the Deployment.
stateless_resource_kind enum required: The kind of stateless resource; Values: kibana apm appsearch enterprise_search integrations_server
ref_id string required: User-specified RefId for the Resource (or '_main' if there is only one).

Query parameters

validate_only boolean · default: false: When true, returns the update version without performing the upgrade

Responses

The upgrade command was issued successfully. Use the "GET" command on the /{deployment_id} resource to monitor progress

application/json

resource_id string required
stack_version string required

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

application/json

Examples

Request curl 1 / 1 language

curl Shell

curl -X POST "${API_URL}/deployments/${DEPLOYMENT_ID}/kibana/${REF_ID}/_upgrade" \
  -u "${USERNAME}:${PASSWORD}"

Generated from the API spec

Response

{
  "resource_id": "string",
  "stack_version": "string"
}

Generated from the API spec

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

Generated from the API spec