# Restart Deployment Elasticsearch Resource

**POST /deployments/{deployment_id}/elasticsearch/{ref_id}/_restart**

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.


## Servers
- https://api.elastic-cloud.com/api/v1: https://api.elastic-cloud.com/api/v1 ()



## Parameters

### Path parameters
- **deployment_id** (string)
  Identifier for the Deployment.
- **ref_id** (string)
  User-specified RefId for the Resource (or '_main' if there is only one).

### Query parameters
- **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** (integer)
  The time, in seconds, to wait for shards that show no progress of initializing, before rolling the next group (default: 10 minutes)


## Responses
### 202
The restart command was issued successfully.

#### Body: application/json (object)
- **warnings** (array[object])
  List of warnings generated from validating command

### 404
* The Deployment specified by {deployment_id} cannot be found. (code: `deployments.deployment_not_found`)
* The Resource specified by {ref_id} cannot be found. (code: `deployments.deployment_resource_not_found`)
#### Headers
- **x-cloud-error-codes** (string)
  The error codes associated with the response

#### Body: application/json (object)
- **errors** (array[object])
  A list of errors that occurred in the failing request

### 422
The command sent to a Resource found the Resource in an illegal state, the error message gives more details. (code: `deployments.deployment_resource_plan_change_error`)
#### Headers
- **x-cloud-error-codes** (string)
  The error codes associated with the response

#### Body: application/json (object)
- **errors** (array[object])
  A list of errors that occurred in the failing request

### 500
A Resource that was previously stored no longer exists. (code: `deployments.deployment_resource_no_longer_exists`)
#### Headers
- **x-cloud-error-codes** (string)
  The error codes associated with the response

#### Body: application/json (object)
- **errors** (array[object])
  A list of errors that occurred in the failing request


[Powered by Bump.sh](https://bump.sh)