vyos/vyos-documentation
1
0
Fork 0
mirror of https://github.com/vyos/vyos-documentation.git synced 2025-10-26 08:41:46 +01:00
Code Issues Packages Projects Releases Wiki Activity

HTTP-API: add a proper explanation for multiple commands

Browse Source 
(cherry picked from commit e30feb684539dc6041b587677bd2ac2e65cbe90c)
This commit is contained in:
rebortg 2021-03-01 18:38:09 +01:00
parent 740fd0e911
commit fb7d6976dd
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/automation/vyos-api.rst
View File

@ -4,7 +4,7 @@
VyOS API VyOS API
######## ########
for configuration and enabling the API see :ref:`httpapi` for configuration and enabling the API see :ref:`http-api`
************** **************
Authentication Authentication
@ -242,14 +242,16 @@ You can pass a ``set``, ``delete`` or ``comment`` command to the
"error": null "error": null
} }
The API will push the command to a session and commit after each HTTP reguest. The API push every request to a session and commit it.
But some of VyOS components like DHCP and PPPoE Servers, IPSec, VXLAN, and
other tunnels require full configuration for commit.
The Endpoint will process multiple commands when you pass them as a list to The Endpoint will process multiple commands when you pass them as a list to
the ``data`` field. the ``data`` field.
.. code-block:: none .. code-block:: none
curl -k --location --request POST 'https://vyos/configure' \ curl -k --location --request POST 'https://vyos/configure' \
--form data='[{"op": "delete", "path": ["interfaces", "dummy", "dum1", "address"]},{"op": "set", "path": ["interfaces", "dummy", "dum1", "address", "10.11.0.1/32"]}]' \ --form data='[{"op": "set","path":["interfaces","vxlan","vxlan1","remote","203.0.113.99"]}, {"op": "set","path":["interfaces","vxlan","vxlan1","vni","1"]}]' \
--form key='MY-HTTPS-API-PLAINTEXT-KEY' --form key='MY-HTTPS-API-PLAINTEXT-KEY'
response: response: