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 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 |
---|---|---|---|
|
|
Y |
The Elasticsearch cluster identifier. |
Query parametersedit
Name | Type | Required | Description |
---|---|---|---|
|
|
N |
When |
|
|
N |
Specifies the properties that divide the instances into groups.To restart all of the instances, use |
|
|
N |
When |
|
|
N |
The time, in seconds, to wait for shards that show no progress of initializing, before rolling the next group (default: 10 minutes) |
|
|
N |
When |
Responsesedit
-
202
-
(
ClusterCommandResponse
) The Elasticsearch cluster is stopping. To monitor progress, use theGET
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