vyos/vyos-documentation
1
0
Fork 0
mirror of https://github.com/vyos/vyos-documentation.git synced 2025-12-16 10:32:02 +01:00
Code Issues Packages Projects Releases Wiki Activity

vyos-api: correct spelling and grammar

Browse Source
This commit is contained in:
rebortg 2021-06-28 14:17:53 +02:00
parent d742504a0c
commit 61dfaf6f61
1 changed files with 12 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -1,3 +1,5 @@
:lastproofread: 2021-06-28
.. _vyosapi: .. _vyosapi:
######## ########
@ -10,11 +12,11 @@ for configuration and enabling the API see :ref:`http-api`
Authentication Authentication
************** **************
All Endpoint only listen on HTTP POST requests and the API KEY must set as All endpoints only listen on HTTP POST requests and the API KEY must set as
``key`` in the formdata. ``key`` in the formdata.
Below see one example or curl and one for python. Below see one example for curl and one for python.
In the following, the documentation is reduced to curl. The rest of the documentation is reduced to curl.
.. code-block:: none .. code-block:: none
@ -74,8 +76,7 @@ To get the whole configuration, pass an empty list to the ``path`` field
} }
only get a part of the configuration, To only get a part of the configuration, for example ``system syslog``.
for example ``system syslog``.
.. code-block:: none .. code-block:: none
@ -105,7 +106,7 @@ for example ``system syslog``.
if you just want the Value of a multi-valued node, use the ``returnValues`` if you just want the Value of a multi-valued node, use the ``returnValues``
operation. operation.
for example get the addresses of a ``dum0`` interface For example, get the addresses of a ``dum0`` interface.
.. code-block:: none .. code-block:: none
@ -165,9 +166,9 @@ delete an image, for example ``1.3-rolling-202006070117``
/show /show
===== =====
The ``/show`` endpoint is to show everthing in operational mode The ``/show`` endpoint is to show everything in the operational mode.
for example which images are installed For example, show which images are installed.
.. code-block:: none .. code-block:: none
@ -189,7 +190,7 @@ for example which images are installed
/generate /generate
========= =========
to run a ``generate`` command use the THe ``generate`` endpoint run a ``generate`` command.
.. code-block:: none .. code-block:: none
@ -242,10 +243,10 @@ You can pass a ``set``, ``delete`` or ``comment`` command to the
"error": null "error": null
} }
The API push every request to a session and commit it. The API pushes every request to a session and commit it.
But some of VyOS components like DHCP and PPPoE Servers, IPSec, VXLAN, and But some of VyOS components like DHCP and PPPoE Servers, IPSec, VXLAN, and
other tunnels require full configuration for commit. 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