Shut down clusteredit

Shuts down the active Kibana instance and removes all of the instance nodes. The instance definition is retained. WARNING: To avoid data loss, save the snapshot repository before you shut down the instance.

Requestedit

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

Path parametersedit

Name Type Required Description

cluster_id

string

Y

The Kibana deployment identifier.

Query parametersedit

Name Type Required Description

hide

boolean; default: false

N

Hides the clusters during shutdown. NOTE: By default, hidden clusters are not listed.

Responsesedit

202

(ClusterCommandResponse) The shutdown 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)

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 exampleedit

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