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

« Search clusters Resynchronize cluster »

› › › ›

Restart cluster

edit

Restart cluster

edit

This endpoint is deprecated and scheduled to be removed in the next major version. Use restart resource instead.

Restarts the Kibana instance. When you restart an active instance, the existing plan is used and a cluster_reboot is applied. A cluster_reboot issues a Kibana restart command, then waits for the command to complete. When you restart an inactive instance, the most recent successful plan is applied.

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)

Headers

x-cloud-error-codes (string; allowed values: [clusters.cluster_not_found]): The error codes associated with the response

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)

Headers

x-cloud-error-codes (string; allowed values: [clusters.cluster_plan_state_error]): 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}/_restart \
-H "Authorization: ApiKey $ECE_API_KEY"

« Search clusters Resynchronize cluster »