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 Domain modifyDomainRequest

From Openprovider API documentation

(Difference between revisions)
Jump to: navigation, search
Line 23: Line 23:
*[[API Format Nameservers|nameServers]]
*[[API Format Nameservers|nameServers]]
*[[API Format isDnssecEnabled|isDnssecEnabled]] (''0'' (default) or ''1'' - Only accepted when nameservers of Openprovider are used)
*[[API Format isDnssecEnabled|isDnssecEnabled]] (''0'' (default) or ''1'' - Only accepted when nameservers of Openprovider are used)
-
*[[API Format DNSSEC Keys|dnssecKeys]] (when using your own nameservers)
+
*[[API Format DNSSEC Keys|dnssecKeys]] (when using your own nameservers; send an empty array to remove current DNSSEC data)
*[[API Format useDomicile|useDomicile]] (''0'' (default) or ''1'')
*[[API Format useDomicile|useDomicile]] (''0'' (default) or ''1'')
*[[API Format isPrivateWhoisEnabled|isPrivateWhoisEnabled]] (''0'' or ''1'', default value is ''0'')
*[[API Format isPrivateWhoisEnabled|isPrivateWhoisEnabled]] (''0'' or ''1'', default value is ''0'')

Revision as of 18:50, 17 October 2018

Contents

Module Domain > Modify

Module domain
Command name modifyDomainRequest
Use Used to modify the attributes of the domain existing in reseller account
Input
Output

-

Examples

Using PHP class

$request = new OP_Request;
$request->setCommand('modifyDomainRequest')
  ->setAuth(array('username' => 'username', 'password' => 'password'))
  ->setArgs(array(
    'adminHandle' => 'SR003891-NL',
    'techHandle' => 'SR003891-NL',
    'billingHandle' => 'SR003891-NL',
    'domain' => array(
      'name' => 'openprovider',
      'extension' => 'nl'
    ),
    'nsGroup' => 'MyServer',
    'isDnssecEnabled' => 1,
    'dnssecKeys' => array(
      array(
        'flags' => 256,
        'alg' => 8,
        'protocol' => 3,
        'pubKey' => 'AwEAA{...}VNfPps3=',
      ),
      array(
        'flags' => 257,
        'alg' => 8,
        'protocol' => 3,
        'pubKey' => 'AwEAA{...}TK5f9fs=',
      ),
    ),
  ));

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>
  <modifyDomainRequest>
    <adminHandle>SR003891-NL</adminHandle>
    <techHandle>SR003891-NL</techHandle>
    <billingHandle>SR003891-NL</billingHandle>
    <domain>
      <name>openprovider</name>
      <extension>nl</extension>
    </domain>
    <nsGroup>MyServer</nsGroup>
    <isDnssecEnabled>1</isDnssecEnabled>
    <dnssecKeys>
      <array>
        <item>
          <flags>256</flags>
          <alg>8</alg>
          <protocol>3</protocol>
          <pubKey>AwEAA{...}VNfPps3=</pubKey>
        </item>
        <item>
          <flags>257</flags>
          <alg>8</alg>
          <protocol>3</protocol>
          <pubKey>AwEAA{...}TK5f9fs=</pubKey>
        </item>
      </array>
    </dnssecKeys>
  </modifyDomainRequest>
</openXML>
<?xml version="1.0" encoding="UTF-8"?>
<openXML>
  <reply>
    <code>0</code>
    <desc></desc>
  </reply>
</openXML>
Views
Personal tools