]> granicus.if.org Git - pdns/commitdiff
Add missing config option in API docs
authorAnhad Jai Singh <ajaisingh@tower-research.com>
Wed, 25 Oct 2017 17:28:32 +0000 (22:58 +0530)
committerAnhad Jai Singh <ajaisingh@tower-research.com>
Wed, 25 Oct 2017 17:28:32 +0000 (22:58 +0530)
- Add `api=yes` required to enable API
- Change ports in examples from 8082 to 8081 to reflect default port in
  configs for Authoritative DNS

docs/common/api/configsetting.rst
docs/http-api/index.rst

index 2211dd0892c1f59a5a55c72315fb7da830ab6c78..68aaad057de8fb555b557186e15c4070875a0bac 100644 (file)
@@ -16,5 +16,5 @@ ConfigSetting
     {
       "name": "webserver-port",
       "type": "ConfigSetting",
-      "value": "8082"
+      "value": "8081"
     }
index 8127c5b04cf6c35625e14d3326574579952d16bd..5bac7b6fa282d43cf31147edb65c4f86d1a9a57c 100644 (file)
@@ -26,14 +26,17 @@ Enabling the API
 To enable the API, the webserver and the HTTP API need to be enbaled.
 Add these lines to the ``pdns.conf``::
 
-    webserver=yes
-    webserver-port=8082
+    api=yes
     api-key=changeme
+    webserver=yes
+    webserver-port=8081
+
+The API endpoints run off of the same webserver, but the :ref:`setting-api` is required to enable API access. Setting :ref:`setting-api` also implicitly enables the webserver v4.1.x onwards.
 
 And restart, the following examples should start working::
 
-    curl -v -H 'X-API-Key: changeme' http://127.0.0.1:8082/api/v1/servers/localhost | jq .
-    curl -v -H 'X-API-Key: changeme' http://127.0.0.1:8082/api/v1/servers/localhost/zones | jq .
+    curl -v -H 'X-API-Key: changeme' http://127.0.0.1:8081/api/v1/servers/localhost | jq .
+    curl -v -H 'X-API-Key: changeme' http://127.0.0.1:8081/api/v1/servers/localhost/zones | jq .
 
 JSON Objects
 ------------