diff options
| author | Viacheslav Hletenko <v.gletenko@vyos.io> | 2022-05-30 12:20:44 +0300 |
|---|---|---|
| committer | Viacheslav Hletenko <v.gletenko@vyos.io> | 2022-05-30 12:55:16 +0300 |
| commit | 30bcbedb809e7ecef32477a79c9554ade9307b03 (patch) | |
| tree | 6030b182c376c66192178d29315c642fad16b59a | |
| parent | 265fe883eece3b562fb6f6f771c41622de4b563e (diff) | |
| download | vyos-documentation-30bcbedb809e7ecef32477a79c9554ade9307b03.tar.gz vyos-documentation-30bcbedb809e7ecef32477a79c9554ade9307b03.zip | |
http-api: Add action reset and socket description
(cherry picked from commit a7fab19a17d6a412c50b4df66faa5d66b85f8d08)
| -rw-r--r-- | docs/automation/vyos-api.rst | 18 | ||||
| -rw-r--r-- | docs/configuration/service/https.rst | 4 |
2 files changed, 22 insertions, 0 deletions
diff --git a/docs/automation/vyos-api.rst b/docs/automation/vyos-api.rst index 5ab150e3..4bd6c63b 100644 --- a/docs/automation/vyos-api.rst +++ b/docs/automation/vyos-api.rst @@ -125,6 +125,24 @@ For example, get the addresses of a ``dum0`` interface. "error": null } +/reset +====== + +The ``reset`` endpoint run a ``reset`` command. + +.. code-block:: none + + curl --location --request POST 'https://vyos/reset' \ + --form data='{"op": "reset", "path": ["ip", "bgp", "192.0.2.11"]}' \ + --form key='MY-HTTPS-API-PLAINTEXT-KEY' + + respone: + { + "success": true, + "data": "", + "error": null + } + /image ====== diff --git a/docs/configuration/service/https.rst b/docs/configuration/service/https.rst index 0c6dcbd9..18227027 100644 --- a/docs/configuration/service/https.rst +++ b/docs/configuration/service/https.rst @@ -28,6 +28,10 @@ Configuration Set the listen port of the local API, this has no effect on the webserver. The default is port 8080 +.. cfgcmd:: set service https api socket + + Use local socket for API + .. cfgcmd:: set service https api strict Enforce strict path checking |