Type to search.

Get the shutdown status

  • GET /_nodes/{node_id}/shutdown
  • GET /_nodes/shutdown
Auth The Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats. Availability Generally available since 7.13 This functionality is generally available and ready for production usage. Unless stated otherwise on the page, this functionality is available when your Elastic Stack is deployed on Elastic Cloud Hosted, Elastic Cloud Enterprise, Elastic Cloud on Kubernetes, and self-managed environments. This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.

Get information about nodes that are ready to be shut down, have shut down preparations still in progress, or have stalled. The API returns status information for each part of the shut down process.

Note

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

If the operator privileges feature is enabled, you must be an operator to use this API.

Required privileges

Cluster privileges manage

Path parameters

node_id union string | string[] optional

Comma-separated list of nodes for which to retrieve the shutdown status

Leave it out to use /_nodes/shutdown.

Query parameters

master_timeout union oneOf · default: 30s

Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

Values: -1 0

Response

application/json
nodes object[] required
node_id string required
type enum required
Values: remove restart
reason string required
shutdown_startedmillis number required
status enum required
Values: not_started in_progress stalled complete
shard_migration object required
status enum required
Values: not_started in_progress stalled complete
persistent_tasks object required
status enum required
Values: not_started in_progress stalled complete
plugins object required
status enum required
Values: not_started in_progress stalled complete