API Module Nameserver searchNsRequest

From Openprovider API documentation

(Difference between revisions)

Revision as of 09:34, 12 March 2014

Module nameserver object / hosts > Search

Module	Nameserver object / hosts
Command name	searchNsRequest
Use	Returns a list of nameserver objects / hosts matching search criteria
Input	limit default value: 100 offset default value: 0 pattern
Output	Result set of nameserver object details: name ip ip6

Examples

Using PHP class

$request = new OP_Request;
$request->setCommand('searchNsRequest')
  ->setAuth(array('username' => 'username', 'password' => 'password'))
  ->setArgs(array(
    'pattern' => '*openprovider.com'
  ));

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>
  <searchNsRequest>
    <pattern>*openprovider.com</pattern>
  </searchNsRequest>
</openXML>

<?xml version="1.0" encoding="UTF-8"?>
<openXML>
  <reply>
    < code>0</code>
    <desc></desc>
    <data>
      <results>
        <array>
          <item>
            <name>glue-ns1.openprovider.com</name>
            <ip>93.180.69.5</ip>
            <ip6>2a00:f10:11f::5</ip6>
          </item>
          <item>
            <name>glue-ns2.openprovider.com</name>
            <ip>93.180.69.1</ip>
            <ip6>2a00:f10:11f::1</ip6>
          </item>
        </array>
      </results>
      <total>2</total>
    </data>
  </reply>
</openXML>

@@ Line 15: / Line 15: @@
 *limit ''default value: 100''
 *offset ''default value: 0''
-*pattern
+*'''pattern'''
 |- style="vertical-align:top;"
 |'''Output'''