summaryrefslogtreecommitdiff
path: root/docs/appendix/http-api.rst
diff options
context:
space:
mode:
authorDaniil Baturin <daniil@vyos.io>2020-05-01 08:13:48 +0700
committerGitHub <noreply@github.com>2020-05-01 08:13:48 +0700
commit600cecb4cf0127677b4e2f3012024dc4e16476ad (patch)
tree6f4049aa55700fd1b959b88bacf8ef874218e0ce /docs/appendix/http-api.rst
parent44ca885b409a2f0b709521b0ff85cf9b4a32b5c4 (diff)
parent9df6cf90acbd74290330f1fa0a8b16b059426b5d (diff)
downloadvyos-documentation-600cecb4cf0127677b4e2f3012024dc4e16476ad.tar.gz
vyos-documentation-600cecb4cf0127677b4e2f3012024dc4e16476ad.zip
Merge pull request #242 from underinternet/fix-reading-config
fixed pre formatting
Diffstat (limited to 'docs/appendix/http-api.rst')
-rw-r--r--docs/appendix/http-api.rst5
1 files changed, 5 insertions, 0 deletions
diff --git a/docs/appendix/http-api.rst b/docs/appendix/http-api.rst
index fe990269..945a2518 100644
--- a/docs/appendix/http-api.rst
+++ b/docs/appendix/http-api.rst
@@ -76,9 +76,14 @@ Reading config
To retrieve raw configs:
+.. code-block:: none
+
# curl -X POST -F data='{"op": "showConfig", "path": ["interfaces", "dummy"]}' -F key=MY-HTTP-API-PLAINTEXT-KEY https://192.168.122.127/retrieve
It will returns:
+
+.. code-block:: none
+
{"success": true, "data": " /* So very dummy */\n dummy dum0 {\n address 192.168.168.1/32\n address 192.168.168.2/32\n /* That is a description */\n description \"Test interface\"\n }\n dummy dum1 {\n address 203.0.113.76/32\n address 203.0.113.79/32\n }\n", "error": null}