diff options
| author | Robert Göhler <github@ghlr.de> | 2022-05-31 11:50:16 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-05-31 11:50:16 +0200 |
| commit | 7c58e0fec38c6a26e0d004a1ab86fac6959bc29e (patch) | |
| tree | 59d3bf2c655ba7c5769c8c0b4c099ba14ce5db85 /docs/automation | |
| parent | e8a41523618b20908f1863e95515c77c4029e870 (diff) | |
| parent | 30bcbedb809e7ecef32477a79c9554ade9307b03 (diff) | |
| download | vyos-documentation-7c58e0fec38c6a26e0d004a1ab86fac6959bc29e.tar.gz vyos-documentation-7c58e0fec38c6a26e0d004a1ab86fac6959bc29e.zip | |
Merge pull request #781 from sever-sever/api-reset-eq
http-api: Add action reset and socket description
Diffstat (limited to 'docs/automation')
| -rw-r--r-- | docs/automation/vyos-api.rst | 18 |
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 ====== |