Skip to main content
POST
/
deployments
/
{deployment_id}
/
elasticsearch
/
{ref_id}
/
_restart
Restart Deployment Elasticsearch Resource
curl --request POST \
  --url https://api.elastic-cloud.com/api/v1/deployments/{deployment_id}/elasticsearch/{ref_id}/_restart \
  --header 'Authorization: <api-key>'
{
  "warnings": [
    {
      "code": "<string>",
      "message": "<string>"
    },
    {
      "code": "<string>",
      "message": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Path Parameters

​
deployment_id
string
required

(Required) Identifier for the Deployment.

Example:

"<string>"

​
ref_id
string
required

(Required) User-specified RefId for the Resource (or '_main' if there is only one).

Example:

"<string>"

Query Parameters

​
restore_snapshot
string

When set to true and restoring from shutdown, then will restore the cluster from the last snapshot (if available).

Example:

"true"

​
skip_snapshot
string

If true, will not take a snapshot of the cluster before restarting.

Example:

"true"

​
cancel_pending
string

If true, cancels any pending plans before restarting. If false and there are pending plans, returns an error.

Example:

"false"

​
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

Example:

"__zone__"

​
shard_init_wait_time
string

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

Example:

"600"

Response

The restart command was issued successfully.

​
warnings
object[]
Example:
[
  { "code": "<string>", "message": "<string>" },
  { "code": "<string>", "message": "<string>" }
]
⌘I