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.1] ›RESTful API ›API reference ›Clusters - Elasticsearch - Commands
« Search clusters Resynchronize cluster »

Restart clusteredit

Restarts the Elasticsearch cluster. When you restart an active cluster, the existing plan is used and a cluster_reboot is applied. A cluster_reboot issues an Elasticsearch restart command, then waits for the command to complete. When you restart an inactive cluster, the most recent successful plan is applied.

Requestedit

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

Path parametersedit

Name Type Required Description

cluster_id

string

Y

The Elasticsearch cluster identifier.

Query parametersedit

Name Type Required Description

cancel_pending

boolean; default: false

N

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

group_attribute

string; default: "_\_zone\_\_"

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.

shard_init_wait_time

integer as int64; default: 600

N

The time, in seconds, to wait for shards that show no progress of initializing, before rolling the next group (default: 10 minutes)

skip_snapshot

boolean; default: true

N

When true, captures a snapshot, then restarts the cluster.

Responsesedit

202

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

400

(BasicFailedReply) The {cluster_id} is unable to restart. Specify a different {cluster_id}, then try again. (code: 'clusters.restart.failed')

404

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

412

(BasicFailedReply) The Elasticsearch cluster 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 exampleedit

curl -XPOST {{hostname}}/api/v1/clusters/elasticsearch/{cluster_id}/_restart \
-u $CLOUD_USER:$CLOUD_KEY
« Search clusters Resynchronize cluster »