API Module Domain modifyDomainRequest

From Openprovider API documentation

(Difference between revisions)
Jump to: navigation, search
 
(25 intermediate revisions not shown)
Line 9: Line 9:
|-
|-
|'''Use'''
|'''Use'''
-
|Modifies the data of an existing domain
+
|Used to modify the attributes of the domain existing in reseller account
|- style="vertical-align:top;"
|- style="vertical-align:top;"
|'''Input'''
|'''Input'''
|
|
*'''[[API Format Domain|domain]]'''
*'''[[API Format Domain|domain]]'''
-
*'''adminHandle'''
+
*[[API Format Handle|ownerHandle]] (customer unique identifier or [[API Format Handle|handle]])
-
*'''techHandle'''
+
*[[API Format Handle|adminHandle]] (customer unique identifier or [[API Format Handle|handle]])
-
*nsGroup
+
*[[API Format Handle|techHandle]] (customer unique identifier or [[API Format Handle|handle]])
 +
*[[API Format Handle|billingHandle]] (customer unique identifier or [[API Format Handle|handle]])
 +
*[[API Format Handle|resellerHandle]] (customer unique identifier or [[API Format Handle|handle]])
 +
*[[API Format nsGroup|nsGroup]] ('nameserver group', use ''dns-openprovider'' if you want to use our nameservers)
 +
*[[API Format nsTemplateName|nsTemplateName]] (name of the template to use to automatically create DNS zone on the domain; only applicable if nsGroup is ''dns-openprovider'')
*[[API Format Nameservers|nameServers]]
*[[API Format Nameservers|nameServers]]
-
*useDomicile
+
*[[API Format removeNses|removeNses]] (''0'' or ''1'')
-
*locked
+
*[[API Format isDnssecEnabled|isDnssecEnabled]] (''0'' (default) or ''1'')
 +
*[[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 isPrivateWhoisEnabled|isPrivateWhoisEnabled]] (''0'' or ''1'', default value is ''0'')
 +
*[[API Format isLocked|isLocked]] (''0'' or ''1'', default value is ''0'')
 +
*[[API Format autorenew|autorenew]] ''( on | off | default )''
 +
*[[API Format Transfer At|scheduledAt]] (only accepted by domains in status 'SCH')
 +
*acceptUpdateFee (required in case when domain update is not free; value is the price returned in the response for modifyDomainRequest without acceptUpdateFee)
|- style="vertical-align:top;"
|- style="vertical-align:top;"
|'''Output'''
|'''Output'''
Line 34: Line 45:
     'adminHandle' => 'SR003891-NL',
     'adminHandle' => 'SR003891-NL',
     'techHandle' => 'SR003891-NL',
     'techHandle' => 'SR003891-NL',
 +
    'billingHandle' => 'SR003891-NL',
     'domain' => array(
     'domain' => array(
       'name' => 'openprovider',
       'name' => 'openprovider',
       'extension' => 'nl'
       'extension' => 'nl'
     ),
     ),
-
     'nsGroup' => 'MyServer'
+
     '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===
===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 51: Line 79:
     <adminHandle>SR003891-NL</adminHandle>
     <adminHandle>SR003891-NL</adminHandle>
     <techHandle>SR003891-NL</techHandle>
     <techHandle>SR003891-NL</techHandle>
 +
    <billingHandle>SR003891-NL</billingHandle>
     <domain>
     <domain>
       <name>openprovider</name>
       <name>openprovider</name>
Line 56: Line 85:
     </domain>
     </domain>
     <nsGroup>MyServer</nsGroup>
     <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>
   </modifyDomainRequest>
  </openXML>
  </openXML>
Line 62: Line 108:
  <openXML>
  <openXML>
   <reply>
   <reply>
-
     < code>0</code>
+
     <nowiki><code>0</code></nowiki>
     <desc></desc>
     <desc></desc>
   </reply>
   </reply>
  </openXML>
  </openXML>

Current revision as of 16:10, 22 March 2021

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>
Retrieved from "https://doc.openprovider.eu/API_Module_Domain_modifyDomainRequest"
Views
Personal tools