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

› › ›

Delete shutdown API

edit

Delete shutdown API

edit

This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.

Cancels shutdown preparations or clears a shutdown request so a node can resume normal operations.

Request

edit

DELETE _nodes/<node-id>/shutdown

Prerequisites

edit

If the Elasticsearch security features are enabled, you must have the manage cluster privilege to use this API.
If the operator privileges feature is enabled, you must be an operator to use this API.

Description

edit

Enables a node to resume normal operations following a put shutdown request. You must explicitly clear the shutdown request when a node rejoins the cluster, or when a node has permanently left the cluster. Shutdown requests are never removed automatically by Elasticsearch.

Path parameters

edit

<node-id>: (Optional, string) The ID of a node that you prepared for shut down.

Query parameters

edit

master_timeout: (Optional, time units) Period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. Defaults to 30s. Can also be set to -1 to indicate that the request should never timeout.

Examples

edit

Prepare a node to be restarted:

resp = client.shutdown.put_node(
    node_id="USpTGYaBSIKbgSUJR2Z9lg",
    type="restart",
    reason="Demonstrating how the node shutdown API works",
)
print(resp)

response = client.shutdown.put_node(
  node_id: 'USpTGYaBSIKbgSUJR2Z9lg',
  body: {
    type: 'restart',
    reason: 'Demonstrating how the node shutdown API works'
  }
)
puts response

const response = await client.shutdown.putNode({
  node_id: "USpTGYaBSIKbgSUJR2Z9lg",
  type: "restart",
  reason: "Demonstrating how the node shutdown API works",
});
console.log(response);

PUT /_nodes/USpTGYaBSIKbgSUJR2Z9lg/shutdown
{
  "type": "restart",
  "reason": "Demonstrating how the node shutdown API works"
}

Cancel the shutdown preparations or clear the shutdown request after restarting:

resp = client.shutdown.delete_node(
    node_id="USpTGYaBSIKbgSUJR2Z9lg",
)
print(resp)

response = client.shutdown.delete_node(
  node_id: 'USpTGYaBSIKbgSUJR2Z9lg'
)
puts response

const response = await client.shutdown.deleteNode({
  node_id: "USpTGYaBSIKbgSUJR2Z9lg",
});
console.log(response);

DELETE /_nodes/USpTGYaBSIKbgSUJR2Z9lg/shutdown

Which returns the following response:

{
    "acknowledged": true
}

« Get shutdown API Query rules APIs »