summaryrefslogtreecommitdiff
path: root/docs/automation/vyos-api.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/automation/vyos-api.rst')
-rw-r--r--docs/automation/vyos-api.rst18
1 files changed, 18 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
======