From 30bcbedb809e7ecef32477a79c9554ade9307b03 Mon Sep 17 00:00:00 2001
From: Viacheslav Hletenko <v.gletenko@vyos.io>
Date: Mon, 30 May 2022 12:20:44 +0300
Subject: http-api: Add action reset and socket description

(cherry picked from commit a7fab19a17d6a412c50b4df66faa5d66b85f8d08)
---
 docs/automation/vyos-api.rst | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

(limited to 'docs/automation/vyos-api.rst')

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
 ======
 
-- 
cgit v1.2.3