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 retrieveTemplateDnsRequest

From Openprovider API documentation

(Difference between revisions)
Jump to: navigation, search
(Created page with '==Module DNS template > Retrieve== {| border="1" cellpadding="4" |- style="background-color:#BBBBBB;" |'''Module''' |DNS template |- style="background-color:#EEEEEE;" |'''Command…')
(Raw XML)
 
(4 intermediate revisions not shown)
Line 9: Line 9:
|-
|-
|'''Use'''
|'''Use'''
-
|Retrieves information about an existing DNS template object
+
|Retrieves information about an existing DNS zone template
|- style="vertical-align:top;"
|- style="vertical-align:top;"
|'''Input'''
|'''Input'''
Line 16: Line 16:
|- style="vertical-align:top;"
|- style="vertical-align:top;"
|'''Output'''
|'''Output'''
-
|Result set of DNS template details:
+
|
*id
*id
*name
*name
Line 32: Line 32:
===Raw XML===
===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"?>
  <?xml version="1.0" encoding="UTF-8"?>
  <openXML>
  <openXML>
Line 46: Line 47:
  <openXML>
  <openXML>
   <reply>
   <reply>
-
     < code>0</code>
+
     <nowiki><code>0</code></nowiki>
     <desc></desc>
     <desc></desc>
     <data>
     <data>
Line 55: Line 56:
           <item>
           <item>
             <id>63581</id>
             <id>63581</id>
-
             <name>
+
             <name></name>
-
            </name>
+
             <type>A</type>
             <type>A</type>
             <value>213.193.110.246</value>
             <value>213.193.110.246</value>
Line 88: Line 88:
           <item>
           <item>
             <id>63585</id>
             <id>63585</id>
-
             <name>
+
             <name></name>
-
            </name>
+
             <type>MX</type>
             <type>MX</type>
             <value>mail.%domain%</value>
             <value>mail.%domain%</value>
Line 97: Line 96:
           <item>
           <item>
             <id>63586</id>
             <id>63586</id>
-
             <name>
+
             <name></name>
-
            </name>
+
             <type>SPF</type>
             <type>SPF</type>
             <value>"v=spf1 a mx ip4:77.74.50.63 ~all"</value>
             <value>"v=spf1 a mx ip4:77.74.50.63 ~all"</value>

Current revision as of 10:57, 17 June 2016

Contents

Module DNS template > Retrieve

Module DNS template
Command name retrieveTemplateDnsRequest
Use Retrieves information about an existing DNS zone template
Input
  • id
Output

Examples

Using PHP class

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

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>
  <retrieveTemplateDnsRequest>
    <id>5562</id>
  </retrieveTemplateDnsRequest>
</openXML>
<?xml version="1.0" encoding="UTF-8"?>
<openXML>
  <reply>
    <code>0</code>
    <desc></desc>
    <data>
      <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>
    </data>
  </reply>
</openXML>
Views
Personal tools