Restart cluster

edit

Restarts a Apm cluster. If a cluster is active: this command re-applies the existing plan but applies a "cluster_reboot", which issues a Apm restart command and waits for it to complete. If a cluster is inactive: this command starts it up with the most recent successful plan.

Request

edit

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

Path parameters

edit
Name Type Required Description

cluster_id

string

Y

The APM deployment identifier.

Query parameters

edit
Name Type Required Description

cancel_pending

boolean; default: false

N

When true, cancels the pending plans, then restarts the cluster.

Responses

edit
202

(ClusterCommandResponse) The APM server is stopping. To monitor progress, use the GET command on the /{cluster_id} resource.

404

(BasicFailedReply) The {cluster_id} can't be found. (code: 'clusters.cluster_not_found')

412

(BasicFailedReply) The APM server is in an unhealthy state. For more details, refer to the error message. (code: 'clusters.cluster_plan_state_error')

449

(BasicFailedReply) Elevated permissions are required. (code: '"root.needs_elevated_permissions"')

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

Request example

edit
curl -XPOST {{hostname}}/api/v1/clusters/apm/{cluster_id}/_restart \
-u $CLOUD_USER:$CLOUD_KEY