diff options
author | Viacheslav Hletenko <v.gletenko@vyos.io> | 2023-11-24 12:25:55 +0200 |
---|---|---|
committer | Mergify <37929162+mergify[bot]@users.noreply.github.com> | 2023-11-24 20:26:00 +0000 |
commit | 9c961c0d5261c6ba16d48d7e44cb069c856d99d5 (patch) | |
tree | 947b42ec9f487a8292d83767201f0b1506d18489 /docs/automation | |
parent | 5fb241c9ae0f95a3917a90d34c9979f06b965197 (diff) | |
download | vyos-documentation-9c961c0d5261c6ba16d48d7e44cb069c856d99d5.tar.gz vyos-documentation-9c961c0d5261c6ba16d48d7e44cb069c856d99d5.zip |
HTTP API add reboot and poweroff endpoints example
(cherry picked from commit d29ee63b82a77c186c0827d562d14e0627c1db31)
Diffstat (limited to 'docs/automation')
-rw-r--r-- | docs/automation/vyos-api.rst | 37 |
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 ====== |