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.

« Reset elastic user password Shutdown Deployment Elasticsearch Resource »

› › › ›

Restart Deployment Elasticsearch Resource

edit

Restart Deployment Elasticsearch Resource

edit

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.

Request

edit

POST /api/v1/deployments/{deployment_id}/elasticsearch/{ref_id}/_restart

Path parameters

edit

Name	Type	Required	Description
`deployment_id`	`string`	Y	Identifier for the Deployment
`ref_id`	`string`	Y	User-specified RefId for the Resource

Query parameters

edit

Name	Type	Required	Description
`cancel_pending`	`boolean`; default: `false`	N	If true, will cancel any pending plans before restarting (else will error)
`group_attribute`	`string`; default: `"_\_zone\_\_"`	N	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 the time, or a comma-separated list of attributes of the instances
`restore_snapshot`	`boolean`; default: `true`	N	If restoring from shutdown and true (the default), then will restore the cluster from the last snapshot (if available)
`shard_init_wait_time`	`integer` as `int64`; 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	If true, will not take a snapshot of the cluster before restarting

Responses

edit

202: (DeploymentResourceCommandResponse) The restart command was issued successfully
404: (BasicFailedReply) The Resource specified by {ref_id} cannot be found
422: (BasicFailedReply) The command sent to a Resource found the Resource in an illegal state, the error message gives more details
449: (BasicFailedReply) elevated permissions are required. (code: '"root.unauthorized.rbac.elevated_permissions_required"')

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/deployments/{deployment_id}/elasticsearch/{ref_id}/_restart \
-H "Authorization: ApiKey $ECE_API_KEY"

« Reset elastic user password Shutdown Deployment Elasticsearch Resource »