Elasticsearch API Documentation
Restart Deployment Elasticsearch Resource
POST {{baseUrl}}/deployments/:deployment_id/elasticsearch/:ref_id/_restart?restore_snapshot=true&skip_snapshot=true&cancel_pending=false&group_attribute=__zone__&shard_init_wait_time=600
Restarts an Elasticsearch Resource. If a Resource is active: this command re-applies the existing plan but applies a cluster_reboot
, which issues a restart command and waits for it to complete. If a Resource is inactive: this command starts it up with the most recent successful plan.
Body
PARAM
| Key | Datatype | Required | Description |
restore_snapshot
|
boolean | When set to true and restoring from shutdown, then will restore the cluster from the last snapshot (if available). | |
skip_snapshot
|
boolean | If true, will not take a snapshot of the cluster before restarting. | |
cancel_pending
|
boolean | If true, cancels any pending plans before restarting. If false and there are pending plans, returns an error. | |
group_attribute
|
string | Indicates the property or properties used to divide the list of instances to restart in groups. Valid options are: '\_\_all\_\_' (restart all at once), '\_\_zone\_\_' by logical zone, '\_\_name\_\_' one instance at a time, or a comma-separated list of attributes of the instances | |
shard_init_wait_time
|
number | The time, in seconds, to wait for shards that show no progress of initializing, before rolling the next group (default: 10 minutes) |
HEADERS
| Key | Datatype | Required | Description |
RESPONSES
status
Curl
curl -X POST 'https://api.elastic-cloud.com/api/v1//deployments/:deployment_id/elasticsearch/:ref_id/_restart?restore_snapshot=true&skip_snapshot=true&cancel_pending=false&group_attribute=__zone__&shard_init_wait_time=600?restore_snapshot=true&skip_snapshot=true&cancel_pending=false&group_attribute=__zone__&shard_init_wait_time=600'
ENDPOINTS