]> granicus.if.org Git - pdns/commitdiff
Documentation for isMaster
authorAki Tuomi <cmouse@desteem.org>
Tue, 15 Jul 2014 17:31:54 +0000 (20:31 +0300)
committerAki Tuomi <cmouse@desteem.org>
Tue, 15 Jul 2014 17:31:54 +0000 (20:31 +0300)
pdns/docs/pdns.xml

index 7072e4056460a7d2a886bf1a2b89a8cf46da7bd6..df975a5a0422ec1c933f157c947cdad3e362938a 100644 (file)
@@ -21766,6 +21766,67 @@ Content-Type: text/javascript; charset=utf-8
 </variablelist>
 </sect4>
 
+<sect4 id="remotebackend-api-method-ismaster"><title>Method: isMaster</title>
+ <variablelist>
+  <varlistentry>
+   <term>Mandatory:</term>
+   <listitem><para>No</para></listitem>
+ </varlistentry>
+ <varlistentry>
+   <term>Parameters:</term>
+   <listitem><para>name,ip</para></listitem>
+ </varlistentry>
+ <varlistentry>
+   <term>Reply:</term>
+   <listitem><para>true for success, false for failure.</para></listitem>
+ </varlistentry>
+ <varlistentry>
+  <term>Description</term>
+<listitem><para>
+Determines whether given IP is master for given domain name.  
+</para></listitem>
+ </varlistentry>
+ <varlistentry>
+  <term>Example JSON/RPC:</term>
+  <listitem>
+   <para>
+    Query:
+<programlisting>
+{"method":"isMaster","parameters":{"name":"example.com","ip":"10.0.0.1"}}
+</programlisting>
+   </para>
+   <para>
+    Response:
+<programlisting>
+{"result":true}
+</programlisting>
+   </para>
+  </listitem>
+ </varlistentry>
+ <varlistentry>
+  <term>Example HTTP/RPC:</term>
+  <listitem>
+   <para>
+     Query:
+<programlisting>
+GET /dnsapi/isMaster/example.com/10.0.0.1
+
+</programlisting>
+   </para>
+   <para>
+     Response:
+<programlisting>
+HTTP/1.1 200 OK
+Content-Type: text/javascript; charset=utf-8
+
+{"result":true}
+</programlisting>
+   </para>
+  </listitem>
+ </varlistentry>
+</variablelist>
+</sect4>
+
 <sect4 id="remotebackend-api-method-supermasterbackend"><title>Method: superMasterBackend</title>
  <variablelist>
   <varlistentry>