API Module Domain modifyDomainRequest

From Openprovider API documentation

Revision as of 11:10, 23 March 2012 (view source) WikiSysop (Talk | contribs) ← Older edit		Revision as of 08:04, 13 December 2012 (view source) WikiSysop (Talk | contribs) Newer edit →
Line 23:		Line 23:
	*isLocked		*isLocked
	*autorenew ''( on | off | default )''		*autorenew ''( on | off | default )''
		+	*isDnssecEnabled (''0'' (default) or ''1'')
		+	*[[API Format DNSSEC Keys|dnssecKeys]]
	|- style="vertical-align:top;"		|- style="vertical-align:top;"
	|'''Output'''		|'''Output'''
Line 41:		Line 43:
	'extension' => 'nl'		'extension' => 'nl'
	),		),
-	'nsGroup' => 'MyServer'	+	'nsGroup' => 'MyServer',
		+	'isDnssecEnabled' => 1,
		+	'dnssecKeys' => array(
		+	array(
		+	'flags' => 256,
		+	'alg' => 8,
		+	'pubKey' => 'AwEAA{...}VNfPps3=',
		+	),
		+	array(
		+	'flags' => 257,
		+	'alg' => 8,
		+	'pubKey' => 'AwEAA{...}TK5f9fs=',
		+	),
		+	),
	));		));
Line 60:		Line 75:
	</domain>		</domain>
	<nsGroup>MyServer</nsGroup>		<nsGroup>MyServer</nsGroup>
		+	<isDnssecEnabled>1</isDnssecEnabled>
		+	<dnssecKeys>
		+	<array>
		+	<item>
		+	<flags>256</flags>
		+	<alg>8</alg>
		+	<pubKey>AwEAA{...}VNfPps3=</pubKey>
		+	</item>
		+	<item>
		+	<flags>257</flags>
		+	<alg>8</alg>
		+	<pubKey>AwEAA{...}TK5f9fs=</pubKey>
		+	</item>
		+	</array>
		+	</dnssecKeys>
	</modifyDomainRequest>		</modifyDomainRequest>
	</openXML>		</openXML>

---

Revision as of 08:04, 13 December 2012

Contents 1 Module Domain > Modify 2 Examples 2.1 Using PHP class 2.2 Raw XML

Module Domain > Modify

Module	domain
Command name	modifyDomainRequest
Use	Modifies the data of an existing domain
Input	domain ownerHandle adminHandle techHandle nsGroup nsTemplateName nameServers useDomicile isLocked autorenew ( on | off | default ) isDnssecEnabled (0 (default) or 1) dnssecKeys
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',
    'domain' => array(
      'name' => 'openprovider',
      'extension' => 'nl'
    ),
    'nsGroup' => 'MyServer',
    'isDnssecEnabled' => 1,
    'dnssecKeys' => array(
      array(
        'flags' => 256,
        'alg' => 8,
        'pubKey' => 'AwEAA{...}VNfPps3=',
      ),
      array(
        'flags' => 257,
        'alg' => 8,
        '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>
    <domain>
      <name>openprovider</name>
      <extension>nl</extension>
    </domain>
    <nsGroup>MyServer</nsGroup>
    <isDnssecEnabled>1</isDnssecEnabled>
    <dnssecKeys>
      <array>
        <item>
          <flags>256</flags>
          <alg>8</alg>
          <pubKey>AwEAA{...}VNfPps3=</pubKey>
        </item>
        <item>
          <flags>257</flags>
          <alg>8</alg>
          <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>