diff options
| author | rebortg <github@ghlr.de> | 2021-03-01 18:38:09 +0100 |
|---|---|---|
| committer | rebortg <github@ghlr.de> | 2021-03-08 19:51:38 +0100 |
| commit | fb7d6976dda9596ad44e02b2bbbcb91c69579967 (patch) | |
| tree | 6f158520cee83188cbaa554a7f57564c8399a8ce | |
| parent | 740fd0e911cd968a97ff9be811b46fa00c5f2473 (diff) | |
| download | vyos-documentation-fb7d6976dda9596ad44e02b2bbbcb91c69579967.tar.gz vyos-documentation-fb7d6976dda9596ad44e02b2bbbcb91c69579967.zip | |
HTTP-API: add a proper explanation for multiple commands
(cherry picked from commit e30feb684539dc6041b587677bd2ac2e65cbe90c)
| -rw-r--r-- | docs/automation/vyos-api.rst | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/docs/automation/vyos-api.rst b/docs/automation/vyos-api.rst index c34f4f52..1504a05a 100644 --- a/docs/automation/vyos-api.rst +++ b/docs/automation/vyos-api.rst @@ -4,7 +4,7 @@ VyOS API ######## -for configuration and enabling the API see :ref:`httpapi` +for configuration and enabling the API see :ref:`http-api` ************** Authentication @@ -242,14 +242,16 @@ You can pass a ``set``, ``delete`` or ``comment`` command to the "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 ``data`` field. .. code-block:: none 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' response: |