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.

Go to the new documentation

API Module Nameserver searchTemplateDnsRequest

From Openprovider API documentation

(Difference between revisions)
Jump to: navigation, search
(→Module DNS template > Search)
(→Module DNS template > Search)
Line 15: Line 15:
*[[API Format Limit|limit]] (''default value: 100, maximum value: 1000'')
*[[API Format Limit|limit]] (''default value: 100, maximum value: 1000'')
*[[API Format Offset|offset]] (''default value: 0'')
*[[API Format Offset|offset]] (''default value: 0'')
-
*withRecords ''default value: 1''
+
*withRecords (''default value: 1'', to retrieve DNS zone template with all default records)
|- style="vertical-align:top;"
|- style="vertical-align:top;"
|'''Output'''
|'''Output'''

Revision as of 10:55, 17 June 2016

Contents

Module DNS template > Search

Module DNS template
Command name searchTemplateDnsRequest
Use Returns a list of DNS template objects matching search criteria
Input
  • limit (default value: 100, maximum value: 1000)
  • offset (default value: 0)
  • withRecords (default value: 1, to retrieve DNS zone template with all default records)
Output Result set of DNS template details:
  • id
  • name
  • records (if withRecords = true)

Examples

Using PHP class

$request = new OP_Request;
$request->setCommand('searchTemplateDnsRequest')
  ->setAuth(array('username' => 'username', 'password' => 'password'))
  ->setArgs(array(
  ));

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>
  <searchTemplateDnsRequest />
</openXML>

<?xml version="1.0" encoding="UTF-8"?>
<openXML>
  <reply>
    < code>0</code>
    <desc></desc>
    <data>
      <results>
        <array>
          <item>
            <id>5120</id>
            <name>Corporate Redirect</name>
            <records>
              <array>
                <item>
                  <id>63573</id>
                  <name></name>
                  <type>A</type>
                  <value>213.193.220.146</value>
                  <ttl>86400</ttl>
                  <priority>0</priority>
                </item>
                <item>
                  <id>63574</id>
                  <name>www</name>
                  <type>CNAME</type>
                  <value>%domain%</value>
                  <ttl>86400</ttl>
                  <priority>0</priority>
                </item>
              </array>
            </records>
          </item>
          <item>
            <id>5562</id>
            <name>Default</name>
            <records>
              <array>
                <item>
                  <id>63581</id>
                  <name></name>
                  <type>A</type>
                  <value>213.193.110.246</value>
                  <ttl>86400</ttl>
                  <priority>0</priority>
                </item>
                <item>
                  <id>63583</id>
                  <name>intranet</name>
                  <type>A</type>
                  <value>1.0.0.0</value>
                  <ttl>86400</ttl>
                  <priority>0</priority>
                </item>
                <item>
                  <id>63582</id>
                  <name>mail</name>
                  <type>A</type>
                  <value>213.193.110.246</value>
                  <ttl>86400</ttl>
                  <priority>0</priority>
                </item>
                <item>
                  <id>63584</id>
                  <name>www</name>
                  <type>CNAME</type>
                  <value>%domain%</value>
                  <ttl>86400</ttl>
                  <priority>0</priority>
                </item>
                <item>
                  <id>63585</id>
                  <name></name>
                  <type>MX</type>
                  <value>mail.%domain%</value>
                  <ttl>86400</ttl>
                  <priority>123</priority>
                </item>
                <item>
                  <id>63586</id>
                  <name></name>
                  <type>SPF</type>
                  <value>"v=spf1 a mx ip4:77.74.50.63 ~all"</value>
                  <ttl>86400</ttl>
                  <priority>0</priority>
                </item>
              </array>
            </records>
          </item>
          <item>
            <id>5936</id>
            <name>Demo</name>
            <records>
              <array>
                <item>
                  <id>63602</id>
                  <name></name>
                  <type>A</type>
                  <value>89.255.0.43</value>
                  <ttl>86400</ttl>
                  <priority>0</priority>
                </item>
                <item>
                  <id>63603</id>
                  <name>*</name>
                  <type>A</type>
                  <value>89.255.0.43</value>
                  <ttl>86400</ttl>
                  <priority>0</priority>
                </item>
                <item>
                  <id>63604</id>
                  <name></name>
                  <type>MX</type>
                  <value>mail.%domain%</value>
                  <ttl>86400</ttl>
                  <priority>10</priority>
                </item>
              </array>
            </records>
          </item>
          <item>
            <id>5638</id>
            <name>Shared Hosting</name>
            <records>
              <array>
                <item>
                  <id>63587</id>
                  <name></name>
                  <type>A</type>
                  <value>89.255.0.46</value>
                  <ttl>86400</ttl>
                  <priority>0</priority>
                </item>
                <item>
                  <id>63589</id>
                  <name>mail</name>
                  <type>A</type>
                  <value>89.255.0.53</value>
                  <ttl>86400</ttl>
                  <priority>0</priority>
                </item>
                <item>
                  <id>63588</id>
                  <name>www</name>
                  <type>A</type>
                  <value>89.255.0.46</value>
                  <ttl>86400</ttl>
                  <priority>0</priority>
                </item>
                <item>
                  <id>63591</id>
                  <name>ftp</name>
                  <type>CNAME</type>
                  <value>%domain%</value>
                  <ttl>86400</ttl>
                  <priority>0</priority>
                </item>
                <item>
                  <id>63592</id>
                  <name>webmail</name>
                  <type>CNAME</type>
                  <value>%domain%</value>
                  <ttl>86400</ttl>
                  <priority>0</priority>
                </item>
                <item>
                  <id>63590</id>
                  <name></name>
                  <type>MX</type>
                  <value>mail.%domain%</value>
                  <ttl>86400</ttl>
                  <priority>10</priority>
                </item>
              </array>
            </records>
          </item>
        </array>
      </results>
      <total>4</total>
    </data>
  </reply>
</openXML>
Retrieved from "https://doc.openprovider.eu/API_Module_Nameserver_searchTemplateDnsRequest"
Views
Personal tools