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

Merge pull request #1640 from jestabro/api-extend-load-merge

Browse Source 
T7498: add example of merge and of passing config in body of request
This commit is contained in:
Christian Breunig 2025-05-29 14:29:45 +02:00 committed by GitHub
commit 6ef2db0fc0
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 31 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -517,3 +517,34 @@ To Load a configuration file.
"data": null,
"error": null
}
To Merge a configuration file.
.. code-block:: none
curl -k --location --request POST 'https://vyos/config-file' \
--form data='{"op": "merge", "file": "/config/test.config"}' \
--form key='MY-HTTPS-API-PLAINTEXT-KEY'
response:
{
"success": true,
"data": null,
"error": null
}
In either of the last two cases, one can pass a string in the body of the
request, for example:
.. code-block:: none
curl -k --location --request POST 'https://vyos/config-file' \
--form data='{"op": "merge", "string": "interfaces {\nethernet eth1 {\naddress "192.168.2.137/24"\ndescription "test"\n}\n}\n"}' \
--form key='MY-HTTPS-API-PLAINTEXT-KEY'
response:
{
"success": true,
"data": null,
"error": null
}