API Module Domain modifyDomainRequest
From Openprovider API documentation
(Difference between revisions)
(→Module Domain > Modify) |
(→Module Domain > Modify) |
||
| Line 14: | Line 14: | ||
| | | | ||
*'''[[API Format Domain|domain]]''' | *'''[[API Format Domain|domain]]''' | ||
| - | *ownerHandle | + | *[[API Format Handle|ownerHandle]] (customer unique identifier or [[API Format Handle|handle]]) |
| - | *adminHandle | + | *[[API Format Handle|adminHandle]] (customer unique identifier or [[API Format Handle|handle]]) |
| - | *techHandle | + | *[[API Format Handle|techHandle]] (customer unique identifier or [[API Format Handle|handle]]) |
| - | *billingHandle | + | *[[API Format Handle|billingHandle]] (customer unique identifier or [[API Format Handle|handle]]) |
| - | *resellerHandle | + | *[[API Format Handle|resellerHandle]] (customer unique identifier or [[API Format Handle|handle]]) |
| - | *nsGroup | + | *'''[[API Format nsGroup|nsGroup]]''' |
| - | *nsTemplateName | + | *[[API Format nsTemplateName|nsTemplateName]] |
*[[API Format Nameservers|nameServers]] | *[[API Format Nameservers|nameServers]] | ||
| - | *isDnssecEnabled (''0'' (default) or ''1'' - Only | + | *[[API Format isDnssecEnabled|isDnssecEnabled]] (''0'' (default) or ''1'' - Only accepted when nameservers of Openprovider are used) |
| - | *useDomicile | + | *[[API Format useDomicile|useDomicile]] (''0'' (default) or ''1'') |
| - | + | *[[API Format isPrivateWhoisEnabled|isPrivateWhoisEnabled]] (''0'' or ''1'', default value is ''0'') | |
*isLocked | *isLocked | ||
*autorenew ''( on | off | default )'' | *autorenew ''( on | off | default )'' | ||
*[[API Format DNSSEC Keys|dnssecKeys]] | *[[API Format DNSSEC Keys|dnssecKeys]] | ||
| - | *scheduledAt | + | *[[API Format Transfer At|scheduledAt]] |
** format: 'Y-m-d H:i:s' | ** format: 'Y-m-d H:i:s' | ||
** example: '2016-04-13 00:00:00' | ** example: '2016-04-13 00:00:00' | ||
Revision as of 07:26, 16 June 2016
Contents |
Module Domain > Modify
| Module | domain |
| Command name | modifyDomainRequest |
| Use | Modifies the data of an existing domain |
| 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>