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.0] ›RESTful API ›API reference ›Clusters - Kibana - Commands

Restart cluster

edit

Restart cluster

edit

Restarts a Kibana cluster. If a cluster is active: this command re-applies the existing plan but applies a "cluster_reboot", which issues a Kibana restart command and waits for it to complete. If a cluster is inactive: this command starts it up with the most recent successful plan.

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 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')

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')

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 »