From: Christian Hofstaedtler <christian@hofstaedtler.name>
Date: Tue, 28 Oct 2014 19:41:55 +0000 (+0100)
Subject: API: Document set-ptr
X-Git-Tag: rec-3.7.0-rc1~184^2
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=refs%2Fpull%2F1848%2Fhead;p=thirdparty%2Fpdns.git

API: Document set-ptr
---

diff --git a/pdns/docs/httpapi/api_spec.md b/pdns/docs/httpapi/api_spec.md
index 1fd56a6316..447a3d7e73 100644
--- a/pdns/docs/httpapi/api_spec.md
+++ b/pdns/docs/httpapi/api_spec.md
@@ -423,7 +423,8 @@ Client body for PATCH:
                 "name": <string>,
                 "ttl": <int>,
                 "type": <string>,
-                "disabled": <bool>
+                "disabled": <bool>,
+                "set-ptr": <bool>
               }, ...
             ],
           "comments":
@@ -457,6 +458,13 @@ Having `type` inside an RR differ from `type` at the top level is an error.
 * `records`
   List of new records (replacing the old ones). Must be empty when `changetype` is set to `DELETE`.
   An empty list results in deletion of all records (and comments).
+  A record consists of these fields:
+  * `type`: DNS type (MUST match outer `type`)
+  * `name`: full name (MUST match outer `name`)
+  * `ttl`: DNS TTL in seconds
+  * `content`: the record content. Must confirm to the DNS content rules for the specified `type`. (PowerDNS hint: includes the backend's `priority` field.)
+  * `disabled`: if this record will be hidden from DNS. (true: hidden, false: visible (the default)).
+  * `set-ptr`: If set to true, the server will find the matching reverse zone and create a `PTR` there. Existing `PTR` records are replaced. If no matching reverse Zone, an error is thrown. Only valid in client bodies, only valid for `A` and `AAAA` types. Not returned by the server. Only valid for the Authoritative server.
 
 * `comments`
   List of new comments (replacing the old ones). Must be empty when `changetype` is set to `DELETE`.