API Module Domain modifyDomainRequest
From Openprovider API documentation
(Difference between revisions)
(→Module Domain > Modify) |
|||
| (11 intermediate revisions not shown) | |||
| Line 9: | Line 9: | ||
|- | |- | ||
|'''Use''' | |'''Use''' | ||
| - | | | + | |Used to modify the attributes of the domain existing in reseller account |
|- style="vertical-align:top;" | |- style="vertical-align:top;" | ||
|'''Input''' | |'''Input''' | ||
| Line 19: | Line 19: | ||
*[[API Format Handle|billingHandle]] (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 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]] | + | *[[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]] | ||
| - | *[[API Format isDnssecEnabled|isDnssecEnabled]] (''0'' (default) or ''1'' | + | *[[API Format removeNses|removeNses]] (''0'' or ''1'') |
| + | *[[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 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'') | ||
| - | *isLocked | + | *[[API Format isLocked|isLocked]] (''0'' or ''1'', default value is ''0'') |
| - | *autorenew ''( on | off | default )'' | + | *[[API Format autorenew|autorenew]] ''( on | off | default )'' |
| - | + | *[[API Format Transfer At|scheduledAt]] (only accepted by domains in status 'SCH') | |
| - | *[[API Format Transfer At|scheduledAt]] | + | *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 108: | 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>