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 retrieveZoneDnsRequest

From Openprovider API documentation

Revision as of 09:26, 14 July 2010 by WikiSysop (Talk | contribs)
(diff) ← Older revision | Current revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Contents

Module DNS zone > Retrieve

Module DNS zone
Command name retrieveZoneDnsRequest
Use Retrieves information about an existing DNS zone object
Input
  • name
  • withRecords
  • withHistory
Output
  • type
  • name
  • ip
  • creationDate
  • modificationDate
  • records (if withRecords = true)
  • history (if withHistory = true)

Examples

Using PHP class

$request = new OP_Request;
$request->setCommand('retrieveZoneDnsRequest')
  ->setAuth(array('username' => 'username', 'password' => 'password'))
  ->setArgs(array(
    'name' => 'demozone.com',
    'withRecords' => true,
    'withHistory' => true
  ));

Raw XML

<?xml version="1.0" encoding="UTF-8"?>
<openXML>
  <credentials>
    <username>username</username>
    <password>password</password>
  </credentials>
  <retrieveZoneDnsRequest>
    <name>demozone.com</name>
    <withRecords>1</withRecords>
  </retrieveZoneDnsRequest>
</openXML>
<?xml version="1.0" encoding="UTF-8"?>
<openXML>
  <reply>
    < code>0</code>
    <desc></desc>
    <data>
      <id>48890</id>
      <type>master</type>
      <name>demozone.com</name>
      <ip>com.demozone</ip>
      <active>1</active>
      <creationDate>2010-07-13 17:07:22</creationDate>
      <modificationDate>2010-07-13 17:07:22</modificationDate>
      <records>
        <array>
          <item>
            <id>603319</id>
            <name>*.demozone.com</name>
            <type>A</type>
            <value>89.255.0.43</value>
            <prio></prio>
            <ttl>86400</ttl>
            <creationDate>2010-07-13 17:07:22</creationDate>
            <modificationDate>2010-07-13 17:07:22</modificationDate>
          </item>
          <item>
            <id>603318</id>
            <name>demozone.com</name>
            <type>A</type>
            <value>89.255.0.43</value>
            <prio></prio>
            <ttl>86400</ttl>
            <creationDate>2010-07-13 17:07:22</creationDate>
            <modificationDate>2010-07-13 17:07:22</modificationDate>
          </item>
          <item>
            <id>603320</id>
            <name>demozone.com</name>
            <type>MX</type>
            <value>mail.openprovider.eu</value>
            <prio>10</prio>
            <ttl>86400</ttl>
            <creationDate>2010-07-13 17:07:22</creationDate>
            <modificationDate>2010-07-13 17:07:22</modificationDate>
          </item>
          <item>
            <id>603321</id>
            <name>demozone.com</name>
            <type>NS</type>
            <value>ns3.openprovider.eu</value>
            <prio></prio>
            <ttl>86400</ttl>
            <creationDate>2010-07-13 17:07:22</creationDate>
            <modificationDate>2010-07-13 17:07:22</modificationDate>
          </item>
          <item>
            <id>603322</id>
            <name>demozone.com</name>
            <type>NS</type>
            <value>ns1.openprovider.nl</value>
            <prio></prio>
            <ttl>86400</ttl>
            <creationDate>2010-07-13 17:07:22</creationDate>
            <modificationDate>2010-07-13 17:07:22</modificationDate>
          </item>
          <item>
            <id>603323</id>
            <name>demozone.com</name>
            <type>NS</type>
            <value>ns2.openprovider.be</value>
            <prio></prio>
            <ttl>86400</ttl>
            <creationDate>2010-07-13 17:07:22</creationDate>
            <modificationDate>2010-07-13 17:07:22</modificationDate>
          </item>
          <item>
            <id>603324</id>
            <name>demozone.com</name>
            <type>SOA</type>
            <value>ns1.openprovider.nl dns@openprovider.eu 2010071300</value>
            <prio></prio>
            <ttl>86400</ttl>
            <creationDate>2010-07-13 17:07:22</creationDate>
            <modificationDate>2010-07-13 17:07:22</modificationDate>
          </item>
        </array>
      </records>
      <history>
        <array>
          <item>
            <date>2010-07-13 17:07:22</date>
            <is>+ A |demozone.com | 89.255.0.43</is>
            <was></was>
          </item>
          <item>
            <date>2010-07-13 17:07:22</date>
            <is>+ A |*.demozone.com | 89.255.0.43</is>
            <was></was>
          </item>
          <item>
            <date>2010-07-13 17:07:22</date>
            <is>+ MX |demozone.com | mail.openprovider.eu</is>
            <was></was>
          </item>
          <item>
            <date>2010-07-13 17:07:22</date>
            <is>+ NS |demozone.com | ns3.openprovider.eu</is>
            <was></was>
          </item>
          <item>
            <date>2010-07-13 17:07:22</date>
            <is>+ NS |demozone.com | ns1.openprovider.nl</is>
            <was></was>
          </item>
          <item>
            <date>2010-07-13 17:07:22</date>
            <is>+ NS |demozone.com | ns2.openprovider.be</is>
            <was></was>
          </item>
          <item>
            <date>2010-07-13 17:07:22</date>
            <is>+ SOA |demozone.com | ns1.openprovider.nl dns@openprovider.eu 2010071300</is>
            <was></was>
          </item>
        </array>
      </history>
    </data>
  </reply>
</openXML>
Views
Personal tools