API Module Nameserver deleteZoneDnsRequest

From Openprovider API documentation

Revision as of 09:32, 14 July 2010 (view source) WikiSysop (Talk | contribs) ← Older edit		Current revision as of 03:11, 9 September 2021 (view source) WikiSysop (Talk | contribs)
(3 intermediate revisions not shown)
Line 9:		Line 9:
	|-		|-
	|'''Use'''		|'''Use'''
-	|Deletes an existing DNS zone object	+	|Deletes existing DNS zone object
	|- style="vertical-align:top;"		|- style="vertical-align:top;"
	|'''Input'''		|'''Input'''
	|		|
	*'''[[API Format Domain|domain]]'''		*'''[[API Format Domain|domain]]'''
		+	*provider (''openprovider'' or ''sectigo'', default value is ''openprovider'') - in case you have a premium DNS zone, parameter has to be specified to operate over it
	|- style="vertical-align:top;"		|- style="vertical-align:top;"
	|'''Output'''		|'''Output'''
Line 33:		Line 34:
	===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 50:		Line 52:
	<openXML>		<openXML>
	<reply>		<reply>
-	< code>0</code>	+	<nowiki><code>0</code></nowiki>
	<desc></desc>		<desc></desc>
	<data>1</data>		<data>1</data>
	</reply>		</reply>
	</openXML>		</openXML>

---

Current revision as of 03:11, 9 September 2021

Contents 1 Module DNS zone > Delete 2 Examples 2.1 Using PHP class 2.2 Raw XML

Module DNS zone > Delete

Module	DNS zone
Command name	deleteZoneDnsRequest
Use	Deletes existing DNS zone object
Input	domain provider (openprovider or sectigo, default value is openprovider) - in case you have a premium DNS zone, parameter has to be specified to operate over it
Output	-

Examples

Using PHP class

$request = new OP_Request;
$request->setCommand('deleteZoneDnsRequest')
  ->setAuth(array('username' => 'username', 'password' => 'password'))
  ->setArgs(array(
    'domain' => array(
      'name' => 'demozone',
      'extension' => 'com'
    ),
  ));

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>
  <deleteZoneDnsRequest>
    <domain>
      <name>demozone</name>
      <extension>com</extension>
    </domain>
  </deleteZoneDnsRequest>
</openXML>

<?xml version="1.0" encoding="UTF-8"?>
<openXML>
  <reply>
    <code>0</code>
    <desc></desc>
    <data>1</data>
  </reply>
</openXML>