rrda

REST API allowing to perform DNS queries over HTTP
Log | Files | Refs | README | LICENSE

commit 6d7e5bdc23adbca35df070f01527cf13b0d5226b
parent be1b378ac210c29e299fe77f23e19fd81fc332d7
Author: Frederic Cambus <fcambus@users.sourceforge.net>
Date:   Mon,  1 Jul 2013 15:57:13 +0200

Documentation update and formatting fixes

Diffstat:
MREADME.md | 24+++++++++++++-----------
1 file changed, 13 insertions(+), 11 deletions(-)

diff --git a/README.md b/README.md @@ -19,6 +19,8 @@ Build and install with the `go` tool : go install rrda ## Usage + +By default, RRDA will bind on localhost, port 8080. Usage of ./rrda: -host="127.0.0.1": Set the server host @@ -32,14 +34,14 @@ The following examples assume there is a resolver on localhost listening on port URL Scheme : http://server:port/resolver:port/domain/querytype -Example : http://127.0.0.1:8080/127.0.0.1:53/example.org/ns +- Example : http://127.0.0.1:8080/127.0.0.1:53/example.org/ns ### Getting Reverse PTR Records (for both IPv4 and IPv6 addresses) URL Scheme : http://server:port/resolver:port/x/ip -Example (IPv4) : http://127.0.0.1:8080/127.0.0.1:53/x/193.0.6.139 -Example (IPv6) : http://127.0.0.1:8080/127.0.0.1:53/x/2001:67c:2e8:22::c100:68b +- Example (IPv4) : http://127.0.0.1:8080/127.0.0.1:53/x/193.0.6.139 +- Example (IPv6) : http://127.0.0.1:8080/127.0.0.1:53/x/2001:67c:2e8:22::c100:68b ## JSON Output Schema @@ -69,19 +71,19 @@ The output is a JSON object containing the following arrays, representing the ap When incorrect user input is entered, the server returns an HTTP 400 Error (Bad Request), along with a JSON-encoded error message. -Code 401 : Input string could not be parsed -Code 402 : Input string is not a well-formed domain name -Code 403 : Input string is not a valid IP address -Code 404 : Invalid DNS query type +- Code 401 : Input string could not be parsed +- Code 402 : Input string is not a well-formed domain name +- Code 403 : Input string is not a valid IP address +- Code 404 : Invalid DNS query type ## Server Errors When the DNS server cannot be reached or returns an error, the server returns an HTTP 500 Error (Internal Server Error), along with a JSON-encoded error message. -Code 501 : DNS server could not be reached -Code 502 : The name server encountered an internal failure while processing this request (SERVFAIL) -Code 503 : Some name that ought to exist, does not exist (NXDOMAIN) -Code 505 : The name server refuses to perform the specified operation for policy or security reasons (REFUSED) +- Code 501 : DNS server could not be reached +- Code 502 : The name server encountered an internal failure while processing this request (SERVFAIL) +- Code 503 : Some name that ought to exist, does not exist (NXDOMAIN) +- Code 505 : The name server refuses to perform the specified operation for policy or security reasons (REFUSED) ## Sites using RRDA