New

The executive guide to generative AI

Read more

Restart cluster

edit

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

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 stop 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
412

(BasicFailedReply)

The command sent to a cluster found the cluster in an illegal state, the error message gives more details. (code: clusters.cluster_plan_state_error)

Headers

x-cloud-error-codes (string; allowed values: [clusters.cluster_plan_state_error])
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}/_restart \
-H "Authorization: ApiKey $ECE_API_KEY"
Was this helpful?
Feedback