]> granicus.if.org Git - pdns/commitdiff
remotebackend: Add documentation
authorAki Tuomi <cmouse@cmouse.fi>
Tue, 31 May 2016 11:24:40 +0000 (14:24 +0300)
committerAki Tuomi <cmouse@cmouse.fi>
Tue, 31 May 2016 11:26:03 +0000 (14:26 +0300)
docs/markdown/authoritative/backend-remote.md

index a597726915612edf80b28a805d42f3e71dcf3e5b..bedaaf72e14684a5c2986be1a0681710a83427de 100644 (file)
@@ -1052,6 +1052,38 @@ Content-Type: text/javascript; charset=utf-8
 {"result":"PONG"}
 ```
 
+### `getAllDomains`
+Get DomainInfo records for all domains in your backend.
+
+* Mandatory: no
+* Parameters: include_disabled
+* Reply: array of DomainInfo
+
+#### Example JSON/RPC
+Query:
+```
+{"method": "getAllDomains", "parameters": {"include_disabled": true}}
+```
+
+Response:
+```
+{"result":[{"id":1,"zone":"unit.test.","masters":["10.0.0.1"],"notified_serial":2,"serial":2,"last_check":1464693331,"kind":"native"}]}
+```
+
+#### Example HTTP/RPC
+Query:
+```
+GET /dnsapi/getAllDomains?includeDisabled=true
+```
+
+Response:
+```
+HTTP/1.1 200 OK
+Content-Type: text/javascript; charset=utf-8
+Content-Length: 135
+{"result":[{"id":1,"zone":"unit.test.","masters":["10.0.0.1"],"notified_serial":2,"serial":2,"last_check":1464693331,"kind":"native"}]}
+```
+
 ### `searchRecords`
 Can be used to search records from the backend. This is used by web api.