New

The executive guide to generative AI

Read more

Upgrade cluster

edit

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

Upgrades a running cluster.

Request

edit

POST /api/v1/clusters/apm/{cluster_id}/_upgrade

Path parameters

edit
Name Type Required Description

cluster_id

string

Y

The APM deployment identifier.

Query parameters

edit
Name Type Required Description

validate_only

boolean; default: false

N

When true, returns the update version without performing the upgrade

Responses

edit
202

(ClusterUpgradeInfo)

The upgrade command was issued successfully, use the "GET" command on the /{cluster_id} resource to monitor progress

404

(BasicFailedReply)

The cluster specified by {cluster_id} cannot be found. (code: clusters.cluster_not_found)

Headers

x-cloud-error-codes (string; allowed values: [clusters.cluster_not_found])
The error codes associated with the response
449

(BasicFailedReply)

Elevated permissions are required. (code: root.unauthorized.rbac.elevated_permissions_required)

Headers

x-cloud-error-codes (string; allowed values: [root.unauthorized.rbac.elevated_permissions_required])
The error codes associated with the response

Request example

edit
curl -XPOST https://{{hostname}}/api/v1/clusters/apm/{cluster_id}/_upgrade \
-H "Authorization: ApiKey $ECE_API_KEY"
Was this helpful?
Feedback