From: Aki Tuomi Date: Tue, 31 May 2016 11:24:40 +0000 (+0300) Subject: remotebackend: Add documentation X-Git-Tag: rec-4.0.0-rc1~21^2 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=dc6b43a9d32f68f45429d15da633989840145fc7;p=pdns remotebackend: Add documentation --- diff --git a/docs/markdown/authoritative/backend-remote.md b/docs/markdown/authoritative/backend-remote.md index a59772691..bedaaf72e 100644 --- a/docs/markdown/authoritative/backend-remote.md +++ b/docs/markdown/authoritative/backend-remote.md @@ -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.