Merge pull request #1163 from vyos/mergify/bp/sagitta/pr-1161

HTTP API add reboot and poweroff endpoints example (backport #1161)

1 files changed, 37 insertions, 0 deletions

diff --git a/docs/automation/vyos-api.rst b/docs/automation/vyos-api.rst
index efd00dd8..afcc1767 100644
--- a/docs/automation/vyos-api.rst
+++ b/docs/automation/vyos-api.rst
@@ -143,6 +143,43 @@ The ``reset`` endpoint run a ``reset`` command.
      "error": null
    }
 
+/reboot
+=======
+
+To initiate a reboot use the ``reboot`` endpoint.
+
+.. code-block:: none
+
+   curl --location --request POST 'https://vyos/reboot' \
+   --form data='{"op": "reboot", "path": ["now"]}' \
+   --form key='MY-HTTPS-API-PLAINTEXT-KEY'
+
+   respone:
+   {
+     "success": true,
+     "data": "",
+     "error": null
+   }
+
+/poweroff
+=========
+
+To power off the system use the ``poweroff`` endpoint.
+
+.. code-block:: none
+
+   curl --location --request POST 'https://vyos/poweroff' \
+   --form data='{"op": "poweroff", "path": ["now"]}' \
+   --form key='MY-HTTPS-API-PLAINTEXT-KEY'
+
+   respone:
+   {
+     "success": true,
+     "data": "",
+     "error": null
+   }
+
+
 /image
 ======