DNS Provider::GetDNSZone

  • Article

The GetDNSZone procedure allows you to return all data from a requested zone as a tree of properties, including operational status, Start of Authority (SOA) record information, and all resource record data.

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 }

  • {PropertyTree} - Varies by resource record.
Output argument Description

OperationStatus

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

PropertyTree

Returns all data from a requested zone, including resource record and SOA data.

Remarks

No remarks.

Sample Code

Example XML Request

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

<?xml version="1.0" encoding="iso-8859-1" ?> 
 
<request> 
 
       <data> 
 
            <serverIdentifier>100.100.100.125</serverIdentifier> 
 
                <userName>myuser</userName> 
 
         <password>password</password> 
 
               <zoneName>mydomain.com</zoneName> 
 
           <debugLevel logging="high" check-only="on"/> 
 
      </data> 
 
   <properties> 
 
              <property name="MasterServers"></property> 
 
          <property name="DataFile">mydomain.com.dns</property> 
 
               <property name="SecondaryServers>100.100.100.10</property> 
 
  </properties> 
 
     <procedure> 
 
               <execute namespace="DNS Provider" procedure="GetDNSZone"> 
 
                 <before source="data" destination="executeData" mode="merge"/> 
 
                    <before source="executeData" destination="data" mode="insert"/> 
 
           </execute> 
 
        </procedure> 
 
</request>

Example XML Response

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

<?xml version="1.0" encoding="iso-8859-1" ?> 
<response> 
 
     <data> 
 
            <operationStatus>Success</operationStatus> 
 
          <properties> 
 
                      <property name="zoneType" value="primary" /> 
 
                      <property name="adminEmail" value="admin@mydomain.com /> 
 
                  <property name="MasterServers"> 
 
                           <value>100.100.100.12</value> 
 
                               <value>100.100.100.10</value>        
 
                        </property> 
 
               </properties> 
 
             <resourceRecords> 
 
                 <resourceRecord> 
 
                          <rrName>mail</rrName> 
 
                               <rrType>MX</rrType> 
 
                 </resourceRecord> 
 
                 <resourceRecord> 
 
                          <rrName>www</rrName> 
 
                                <rrType>NS</rrType> 
 
                 </resourceRecord> 
 
         </resourceRecords> 
 
        </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::DeleteDNSZone
DNS Provider::ModifyDNSZone