API Module Nameserver searchZoneDnsRequest

From Openprovider API documentation

(Difference between revisions)

Current revision as of 11:04, 17 June 2016

Module DNS zone > Search

Module	DNS zone
Command name	searchZoneDnsRequest
Use	Returns a list of DNS zone objects matching search criteria
Input	limit (default value: 100, maximum value: 1000) offset (default value: 0) namePattern type (master or slave) withRecords (default value: 0) withHistory (default value: 0)
Output	Result set of DNS zone details: type (master or slave) name ip creationDate modificationDate records (if withRecords = true) history (if withHistory = true)

Examples

Using PHP class

$request = new OP_Request;
$request->setCommand('searchZoneDnsRequest')
  ->setAuth(array('username' => 'username', 'password' => 'password'))
  ->setArgs(array(
    'namePattern' => '%demo%'
  ));

Raw XML

Please note that newlines and leading spaces are added only for readability. Those whitespaces should be excluded from your XML command before sending it to Openprovider.

<?xml version="1.0" encoding="UTF-8"?>
<openXML>
  <credentials>
    <username>username</username>
    <password>password</password>
  </credentials>
  <searchZoneDnsRequest>
    <namePattern>%demo%</namePattern>
  </searchZoneDnsRequest>
</openXML>

<?xml version="1.0" encoding="UTF-8"?>
<openXML>
  <reply>
    <code>0</code>
    <desc></desc>
    <data>
      <results>
        <array>
          <item>
            <id>48890</id>
            <type>master</type>
            <name>demozone.com</name>
            <ip>89.255.0.43</ip>
            <active>1</active>
            <creationDate>2010-07-13 17:07:22</creationDate>
            <modificationDate>2010-07-13 17:07:22</modificationDate>
          </item>
        </array>
      </results>
      <total>1</total>
    </data>
  </reply>
</openXML>

@@ Line 17: / Line 17: @@
 *namePattern
 *type (''master'' or ''slave'')
-*withRecords ''default value: 0''
+*withRecords (''default value: 0'')
-*withHistory ''default value: 0''
+*withHistory (''default value: 0'')
 |- style="vertical-align:top;"
 |'''Output'''
 |Result set of DNS zone details:
-*type
+*type (''master'' or ''slave'')
 *name
 *ip
@@ Line 56: / Line 56: @@
   <openXML>
     <reply>
-      < code>0</code>
+      <nowiki><code>0</code></nowiki>
       <desc></desc>
       <data>