Merge pull request #781 from sever-sever/api-reset-eq

http-api: Add action reset and socket description

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