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.
Restart cluster
editRestart cluster
editRestarts 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
editPOST /api/v1/clusters/apm/{cluster_id}/_restart
Path parameters
editName | Type | Required | Description |
---|---|---|---|
|
|
Y |
The APM deployment identifier. |
Query parameters
editName | Type | Required | Description |
---|---|---|---|
|
|
N |
When |
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
) -
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
) -
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 example
editcurl -XPOST {{hostname}}/api/v1/clusters/apm/{cluster_id}/_restart \ -u $CLOUD_USER:$CLOUD_KEY