Restart clusteredit

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 Kibana deployment is stopping. To monitor progress, use the GET command on the /{cluster_id} resource.

404

(BasicFailedReply) The {cluster_id} can't be found. (code: 'clusters.cluster_not_found')

412

(BasicFailedReply) The Kibana deployment is in an unhealthy state. For more details, refer to the error message. (code: 'clusters.cluster_plan_state_error')

449

(BasicFailedReply) Elevated permissions are required. (code: '"root.needs_elevated_permissions"')

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request exampleedit

curl -XPOST {{hostname}}/api/v1/clusters/kibana/{cluster_id}/_restart \
-u $CLOUD_USER:$CLOUD_KEY