DNS Provider::DeleteDNSZone

  • Article

The DeleteDNSZone procedure allows you to delete a requested zone on a specified server. If this is a secondary server for the deleted zone, you must instruct the primary server to pause the zone or to remove this server as a secondary prior to calling the DeleteDNSZone method; otherwise, the zone can be refreshed back into existence.

Note

Before using this procedure, security must be carfully considered. For detailed information about MPS DNS provider security, see DNS Provider Architecture.

Arguments

Input argument Required Description

ServerIdentifier

Yes

A string containing the dotted-quad IP address or the Fully Qualified Domain Nname (FQDN) of the server.

{Credentials}

No

Optional authentication credentials for the target DNS server.

ZoneName

Yes

A string containing the FQDN of the zone.

{DebugLevel}

No

A string to control tracing and other debugging functionality. Values are:

  • Logging = { HIGH | MEDIUM | LOW }

  • Check-only = { ON | OFF }
Output argument Description

OperationStatus

A string containing a success/failure indication, any error messages, and input parameter validity flags.

Remarks

For the DeleteDNSZone method, the following condition applies:

  • If the DeleteDNSZone method call fails due to a noticeably incorrect input parameter, the associated validity flag is returned as set.

Sample Code

Example XML Request

Following is an example of an XML request for the DeleteDNSZone method of the DNS Provider:

<?xml version="1.0" encoding="iso-8859-1" ?> 
<request>  
 
<data> 
 
             <serverIdentifier>dns1.shastadns.local</serverIdentifier>  
 
                  <userName>SHASTADNS\Administrator</userName>  
 
               <password>eQuest123</password>  
 
             <zoneName>acme.com</zoneName>  
 
              <debugLevel logging="high" check-only="on" />  
 
</data> 
 
<procedure> 
 
<execute namespace="DNS Provider" procedure="DeleteDNSZone"> 
 
<before source="data" destination="executeData" mode="merge" />   
 
<after source="executeData" sourcePath="operationStatus" destination="data" mode="insert" />  
 
                  </execute>  
 
</procedure> 
 
</request>

Example XML Response

Following is an example of an XML response for the DeleteDNSZone method of the DNS Provider:

<?xml version="1.0" encoding="iso-8859-1" ?> 
<response> 
 
        <data> 
 
            <operationStatus>Success</operationStatus> 
 
  </data> 
 
</response>

Applies To

DNS Provider API for:

  • Hosted Messaging and Collaboration version 4.5

  • Hosted Messaging and Collaboration version 4.0

  • Hosted Messaging and Collaboration version 3.5

  • Hosted Messaging and Collaboration version 3.0

  • Windows-based Hosting version 4.5

  • Windows-based Hosting version 4.0

  • Windows-based Hosting version 3.5

  • Windows-based Hosting for Applications version 1.0

See also

Tasks

DNS Provider::CreateDNSZone
DNS Provider::ModifyDNSZone
DNS Provider::GetResourceRecord