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.

« Search clusters Resynchronize cluster »
Elastic Docs ›Elastic Cloud Enterprise Reference [2.1] ›RESTful API ›API reference ›Clusters - Kibana - Commands

Restart cluster

edit

Restart cluster

edit

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.

Request

edit

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

Path parameters

edit
Name Type Required Description

cluster_id

string

Y

The Kibana deployment identifier.

Query parameters

edit
Name Type Required Description

cancel_pending

boolean; default: false

N

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

Responses

edit
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 example

edit
curl -XPOST {{hostname}}/api/v1/clusters/kibana/{cluster_id}/_restart \
-u $CLOUD_USER:$CLOUD_KEY
« Search clusters Resynchronize cluster »