Restart clusteredit

This endpoint is deprecated and scheduled to be removed in the next major version. Use restart resource instead.

Restarts the Kibana instance. When you restart an active instance, the existing plan is used and a cluster_reboot is applied. A cluster_reboot issues a Kibana restart command, then waits for the command to complete. When you restart an inactive instance, the most recent successful plan is applied.

Requestedit

POST /api/v1/clusters/kibana/{cluster_id}/_restart

Path parametersedit

Name Type Required Description

cluster_id

string

Y

The Kibana deployment identifier.

Query parametersedit

Name Type Required Description

cancel_pending

boolean; default: false

N

When true, cancels the pending plans, then restarts the cluster.

Responsesedit

202

(ClusterCommandResponse)

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

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

Request exampleedit

curl -XPOST https://{{hostname}}/api/v1/clusters/kibana/{cluster_id}/_restart \
-H "Authorization: ApiKey $ECE_API_KEY"