API Module Nameserver searchTemplateDnsRequest
From Openprovider API documentation
(Difference between revisions)
(→Module DNS template > Search) |
|||
| (4 intermediate revisions not shown) | |||
| Line 9: | Line 9: | ||
|- | |- | ||
|'''Use''' | |'''Use''' | ||
| - | |Returns a list of DNS | + | |Returns a list of DNS zone templates matching search criteria |
|- style="vertical-align:top;" | |- style="vertical-align:top;" | ||
|'''Input''' | |'''Input''' | ||
| | | | ||
| - | *limit ''default value: 100'' | + | *[[API Format Limit|limit]] (''default value: 100, maximum value: 1000'') |
| - | *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''' | ||
| Line 33: | Line 33: | ||
===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 45: | Line 46: | ||
<openXML> | <openXML> | ||
<reply> | <reply> | ||
| - | < code>0</code> | + | <nowiki><code>0</code></nowiki> |
<desc></desc> | <desc></desc> | ||
<data> | <data> | ||
Current revision as of 10:56, 17 June 2016
Contents |
Module DNS template > Search
| Module | DNS template |
| Command name | searchTemplateDnsRequest |
| Use | Returns a list of DNS zone templates matching search criteria |
| Input | |
| Output | Result set of DNS template details:
|
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>