API Module Nameserver modifyZoneDnsRequest

From Openprovider API documentation

(Difference between revisions)

Current revision as of 03:11, 9 September 2021

Module DNS zone > Modify

Module	DNS zone
Command name	modifyZoneDnsRequest
Use	Modifies DNS zone object
Input	domain masterIp (required for slave dns zones) records (required for master dns zones) isSpamexpertsEnabled (to enable spam filtering by default on this DNS zone, default value: 0) secured (0 or 1, default value is 0) - is needed to create DNSSEC keys for zone provider (openprovider or sectigo, default value is openprovider) - in case you have a premium DNS zone, parameter has to be specified to operate over it
Output	-

Examples

Using PHP class

$request = new OP_Request;
$request->setCommand('modifyZoneDnsRequest')
  ->setAuth(array('username' => 'username', 'password' => 'password'))
  ->setArgs(array(
    'domain' => array(
      'name' => 'demozone',
      'extension' => 'com'
    ),
    'records' => array(
      array(
        'type' => 'A',
        'name' => "",
        'value' => '89.255.0.43',
        'ttl' => 86400
      ),
      array(
        'type' => 'A',
        'name' => '*',
        'value' => '89.255.0.43',
        'ttl' => 86400
      ),
      array(
        'type' => 'MX',
        'name' => "",
        'value' => 'mail.openprovider.eu',
        'prio' => 10,
        'ttl' => 86400
      )
    )
  ));

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>
  <modifyZoneDnsRequest>
    <domain>
      <name>demozone</name>
      <extension>com</extension>
    </domain>
    <records>
      <array>
        <item>
          <type>A</type>
          <name></name>
          <value>89.255.0.43</value>
          <ttl>86400</ttl>
        </item>
        <item>
          <type>A</type>
          <name>*</name>
          <value>89.255.0.43</value>
          <ttl>86400</ttl>
        </item>
        <item>
          <type>MX</type>
          <name></name>
          <value>mail.openprovider.eu</value>
          <prio>10</prio>
          <ttl>86400</ttl>
        </item>
      </array>
    </records>
  </modifyZoneDnsRequest>
</openXML>

<?xml version="1.0" encoding="UTF-8"?>
<openXML>
  <reply>
    <code>0</code>
    <desc></desc>
    <data>1</data>
  </reply>
</openXML>

@@ Line 14: / Line 14: @@
 |
 *'''[[API Format Domain|domain]]'''
-*'''type''' (''master'' or ''slave'')
 *masterIp (required for slave dns zones)
 *[[API Format Records|records]] (required for master dns zones)
 *isSpamexpertsEnabled ''(to enable spam filtering by default on this DNS zone, default value: 0)''
+*secured (''0'' or ''1'', default value is ''0'') - is needed to create DNSSEC keys for zone
+*provider (''openprovider'' or ''sectigo'', default value is ''openprovider'') - in case you have a premium DNS zone, parameter has to be specified to operate over it
 |- style="vertical-align:top;"
 |'''Output'''