Shut down clusteredit
This endpoint is deprecated and scheduled to be removed in the next major version. Use shutdown resource instead.
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 |
|---|---|---|---|
|
|
Y |
The Kibana deployment identifier. |
Query parametersedit
| Name | Type | Required | Description |
|---|---|---|---|
|
|
N |
Hides the clusters during shutdown. NOTE: By default, hidden clusters are not listed. |
Responsesedit
-
202 -
The shutdown command was issued successfully, use the "GET" command on the /{cluster_id} resource to monitor progress
-
404 -
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 -
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
-
Request exampleedit
curl -XPOST https://{{hostname}}/api/v1/clusters/kibana/{cluster_id}/_shutdown \
-H "Authorization: ApiKey $ECE_API_KEY"