elasticsearch/docs/reference/shutdown/apis/shutdown-api.asciidoc
Gordon Brown 4944959acf
Node shutdown API docs (#74505)
* Put Shutdown API docs

* Get Shutdown API docs

* Properly escape regex

* Doc tests build now! (but don't pass)

* Doc tests pass now! (with a code fix that will go in a different PR)

* DELETE shutdown docs

* Edit for language & consistency

* Fix doctest

* Add cloud-only banner

* Add allocation_delay docs

* Restore file that got deleted somehow?

* Use `restart` type in example to demonstrate `allocation_delay` param

* Fix typo per review

Co-authored-by: debadair <debadair@elastic.co>

* Vastly improve wording per review

Co-authored-by: debadair <debadair@elastic.co>

* Adjust test request & response so it passes

Co-authored-by: Deb Adair <debadair@elastic.co>
Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
2021-08-19 12:42:27 -04:00

19 lines
530 B
Text

[role="xpack"]
[testenv="basic"]
[[node-lifecycle-api]]
== Node lifecycle APIs
NOTE: {cloud-only}
You use the shutdown APIs to prepare nodes for temporary or permanent shutdown, monitor the shutdown status, and enable a previously shut-down node to resume normal operations.
[discrete]
=== Node shutdown APIs
* <<put-shutdown,Put shutdown API>>
* <<get-shutdown,Get shutdown API>>
* <<delete-shutdown,Delete shutdown API>>
include::shutdown-put.asciidoc[]
include::shutdown-get.asciidoc[]
include::shutdown-delete.asciidoc[]