This documentation has moved

XML API documentation can now be found at developer.openprovider.com. This page will remain available until September 2026, but will no longer be updated.

The XML API itself is not changing. Your existing integration continues to work.

API Module Nameserver searchZoneDnsRequest

From Openprovider API documentation

Revision as of 08:46, 9 November 2010 by WikiSysop (Talk | contribs)
Jump to: navigation, search

Contents

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
  • 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
  • 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

<?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>
Views
Personal tools