It is time to say goodbye: This version of Elastic Cloud Enterprise has reached end-of-life (EOL) and is no longer supported.

The documentation for this version is no longer being maintained. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.

Elastic Docs ›Elastic Cloud Enterprise Reference [2.3] ›RESTful API ›API reference ›Clusters - Apm - Commands
« Shut down cluster Move instances (advanced) »

Upgrade clusteredit

Upgrades a running cluster.

Requestedit

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

Path parametersedit

Name Type Required Description

cluster_id

string

Y

The APM deployment identifier.

Query parametersedit

Name Type Required Description

validate_only

boolean; default: false

N

When true, returns the update version without performing the upgrade

Responsesedit

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)

449

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

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request exampleedit

curl -XPOST {{hostname}}/api/v1/clusters/apm/{cluster_id}/_upgrade \
-u $CLOUD_USER:$CLOUD_KEY
« Shut down cluster Move instances (advanced) »