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.
Shut down cluster
editShut down cluster
editShuts 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.
Request
editPOST /api/v1/clusters/kibana/{cluster_id}/_shutdown
Path parameters
edit| Name | Type | Required | Description |
|---|---|---|---|
|
|
Y |
The Kibana deployment identifier. |
Query parameters
edit| Name | Type | Required | Description |
|---|---|---|---|
|
|
N |
Hides the clusters during shutdown. NOTE: By default, hidden clusters are not listed. |
Responses
edit-
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)Headers
-
x-cloud-error-codes(string; allowed values: [clusters.cluster_not_found]) - 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
-
To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.
Request example
editcurl -XPOST {{hostname}}/api/v1/clusters/kibana/{cluster_id}/_shutdown \
-H "Authorization: ApiKey $ECE_API_KEY"