http-api: T6135: add details on op 'exists' for retrieve endpoint

This commit is contained in:
John Estabrook 2024-03-18 14:06:58 -05:00
parent 64be488c72
commit 72c4b47d4d

View File

@ -125,6 +125,38 @@ For example, get the addresses of a ``dum0`` interface.
"error": null
}
To check existence of a configuration path, use the ``exists`` operation.
For example, check an existing path:
.. code-block:: none
curl -k --location --request POST 'https://vyos/retrieve' \
--form data='{"op": "exists", "path": ["service","https","api"]}' \
--form key='MY-HTTPS-API-PLAINTEXT-KEY'
response:
{
"success": true,
"data": true,
"error": null
}
versus a non-existent path:
.. code-block:: none
curl -k --location --request POST 'https://vyos/retrieve' \
--form data='{"op": "exists", "path": ["service","non","existent","path"]}' \
--form key='MY-HTTPS-API-PLAINTEXT-KEY'
response:
{
"success": true,
"data": false,
"error": null
}
/reset
======