Merge pull request #7677 from rgacogne/dnsdist-logging-facility

[thirdparty/pdns.git] / docs / domainmetadata.rst

diff --git a/docs/domainmetadata.rst b/docs/domainmetadata.rst
index 97f383e5ede753bd33c43b147e29607b8a73b287..c3c6ece7fc2afd99310b328210826844be0c14fb 100644 (file)
--- a/docs/domainmetadata.rst
+++ b/docs/domainmetadata.rst
@@ -46,6 +46,20 @@ Each ACL has its own row in the database:
 To disallow all IP's, except those explicitly allowed by domainmetadata
 records, add ``allow-axfr-ips=`` to ``pdns.conf``.
 
+.. _metadata-api-rectify:
+
+API-RECTIFY
+-----------
+.. versionadded:: 4.1.0
+
+This metadata item controls whether or not a zone is fully rectified on changes
+to the contents of a zone made through the :doc:`API <http-api/index>`.
+
+When the ``API-RECTIFY`` value is "1", the zone will be rectified on changes.
+Any other other value means that it will not be rectified. If this is not set
+at all, rectifying of the zone depends on the config variable
+:ref:`setting-default-api-rectify`.
+
 .. _metadata-axfr-source:
 
 AXFR-SOURCE
@@ -169,6 +183,19 @@ fresh RRSIGs. See the :ref:`DNSSEC
 documentation <soa-edit-ensure-signature-freshness-on-slaves>`
 for more information.
 
+.. _metadata-soa-edit-api:
+
+SOA-EDIT-API
+------------
+
+On changes to the contents of a zone made through the :doc:`API <http-api/index>`,
+the SOA record will be edited according to the SOA-EDIT-API rules. These rules
+are the same as the :ref:`SOA-EDIT-DNSUPDATE <dnsupdate-soa-serial-updates>` rules.
+If not set during zone creation, a SOA-EDIT-API metadata record is created and set to ``DEFAULT``.
+If this record is removed from the backend, the default behaviour is to not do any SOA editing based on this setting.
+This is different from setting ``DEFAULT``.
+
+
 TSIG-ALLOW-AXFR
 ---------------