IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« Resynchronize cluster Upgrade cluster »

› › › ›

Shut down cluster

edit

Shut down cluster

edit

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.

Request

edit

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

Path parameters

edit

Name	Type	Required	Description
`cluster_id`	`string`	Y	The Kibana deployment identifier.

Query parameters

edit

Name	Type	Required	Description
`hide`	`boolean`; default: `false`	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

Request example

edit

curl -XPOST https://{{hostname}}/api/v1/clusters/kibana/{cluster_id}/_shutdown \
-H "Authorization: ApiKey $ECE_API_KEY"

« Resynchronize cluster Upgrade cluster »