Restart cluster

edit

Restarts an Elasticsearch cluster. If a cluster is active: this command re-applies the existing plan but applies a "cluster_reboot", which issues an Elasticsearch 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/elasticsearch/{cluster_id}/_restart

Path parameters

edit
Name Type Required Description

cluster_id

string

Y

The Elasticsearch cluster identifier.

Query parameters

edit
Name Type Required Description

cancel_pending

boolean; default: false

N

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

group_attribute

string; default: "_\_all\_\_"

N

Specifies the properties that divide the instances into groups.To restart all of the instances, use \_\_all\_\.To restart the instances by logical zone, use \_\_zone\_\.To restart one instance at a time, use \_\_name\_\, or use a comma-separated list of instance attributes.

restore_snapshot

boolean; default: true

N

When true and restoring from a shutdown, restores the cluster from the last available snapshot.

skip_snapshot

boolean; default: true

N

When true, captures a snapshot, 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')

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.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/elasticsearch/{cluster_id}/_restart \
-u $CLOUD_USER:$CLOUD_KEY