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.

« Search clusters Resynchronize cluster »

› › › ›

Restart cluster

edit

Restart cluster

edit

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.

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: `"__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`; 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`, does not capture a snapshot before restarting the cluster.

Responses

edit

202

(ClusterCommandResponse) The stop command was issued successfully, use the "GET" command on the /{cluster_id} resource to monitor progress

400

(BasicFailedReply) The cluster specified by {cluster_id} is unable to restart. (code: clusters.restart.failed)

Headers

x-cloud-error-codes (string; allowed values: [clusters.restart.failed]): The error codes associated with the response

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

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 \
-H "Authorization: ApiKey $ECE_API_KEY"

« Search clusters Resynchronize cluster »