Home
/
API reference
/
API documentation (JSON/XML)
/
Tasks
/
Zone tasks

Zone import

API reference (XML/JSON) · Updated 2023-09-19

Function

The ZoneImport task imports zones to name servers managed by the system.

The ZoneImport task can be used for external and internal zone import. For internal import the key sourceVirtualHostname (for Json) and source_system_ns (for XML) must be used, for external import the key source.

Description

Route: POST /zone/{name}/{systemNameServer}/_import

Example for an internal import

{  
  "origin": "example.com",
  "soa": {     
    "refresh": 3600,
    "retry": 7200,
    "expire": 604800,
    "ttl": 600,
    "email": "customer@example.com"
  },
  "dnssec": true,
  "allowTransfer": true,
  "sourceVirtualHostname": "myexample.de",
  "nameServers": [
    {
      "name": "ns1.example.com",
      "ttl": 600,
      "ipAddresses": [
        "1.2.3.4"
      ]
    },
    {
      "name": "ns2.example.com",
      "ttl": 600,
      "ipAddresses": [
        "4.3.2.1"
      ]
    }
  ],  
  "main": {
    "address": "7.7.7.7",
    "ttl": 86000
  },
  "wwwInclude": true,
  "action": "PRIMARY",
  "resourceRecords": [
    {
      "name": "subdomainexample",
      "ttl": 600,
      "type": "A",
      "value": "1.3.5.7"
    }
  ]
}

{
   "stid": "20190701-app-11942",
   "status": {
      "code": "S0204",
      "text": "Zone import has been completed successfully.",
      "type": "SUCCESS"
   },
   "object": {
      "type": "Zone",
      "value": "example.com"
   }
}

Example for an external import

{  
  "origin": "example.com",
  "soa": {     
    "refresh": 3600,
    "retry": 7200,
    "expire": 604800,
    "ttl": 600,
    "email": "customer@example.com"
  },
  "dnssec": true,
  "allowTransfer": true,
  "source": "9.8.7.6",
  "nameServers": [
    {
      "name": "ns1.example.com",
      "ttl": 600,
      "ipAddresses": [
        "1.2.3.4"
      ]
    },
    {
      "name": "ns2.example.com",
      "ttl": 600,
      "ipAddresses": [
        "4.3.2.1"
      ]
    }
  ],  
  "main": {
    "address": "7.7.7.7",
    "ttl": 86000
  },
  "wwwInclude": true,
  "action": "PRIMARY",
  "resourceRecords": [
    {
      "name": "subdomainexample",
      "ttl": 600,
      "type": "A",
      "value": "1.3.5.7"
    }
  ]
}

{
   "stid": "20190701-app-12345",
   "status": {
      "code": "S0204",
      "text": "Zone import has been completed successfully.",
      "type": "SUCCESS"
   },
   "object": {
      "type": "Zone",
      "value": "example.com"
   }
}

Task code: 0204
Used object Zone

Example for an internal import

<request>
    <auth>
        <user>customer</user>
        <password>password</password>
        <context>4</context>
    </auth>
    <task>
        <code>0204</code>
        <default>
            <source_system_ns>myexample.de</source_system_ns>
            <ns_action>primary</ns_action>
            <soa>
                <email>email@example.de</email>
            </soa>
            <nserver>
                <name>ns1.example.com</name>
            </nserver>
            <nserver>
                <name>ns2.example.com</name>
            </nserver>
        </default>
        <zone>
            <name>example.com</name>
        </zone>
        <zone>
            <name>example.com</name>
        </zone>
        <reply_to>mail@example.com</reply_to>
    </task>
</request>

<response>
	<result>
		<status>
			<code>S0204</code>
			<text>Zone import has been completed successfully.</text>
			<type>success</type>
			<object>
				<type>zone</type>
				<value>example.com</value>
			</object>
		</status>
	</result>
</response>

Example for an external import

<request>
    <auth>
        <user>customer</user>
        <password>password</password>
        <context>4</context>
    </auth>
    <task>
        <code>0204</code>
        <default>
            <source>9.8.7.6</source>
            <ns_action>primary</ns_action>
            <soa>
                <email>email@example.de</email>
            </soa>
            <nserver>
                <name>ns1.example.com</name>
            </nserver>
            <nserver>
                <name>ns2.example.com</name>
            </nserver>
        </default>
        <zone>
            <name>example.com</name>
        </zone>
        <zone>
            <name>example.com</name>
        </zone>
        <reply_to>mail@example.com</reply_to>
    </task>
</request>

<response>
	<result>
		<status>
			<code>S0204</code>
			<text>Zone import has been completed successfully.</text>
			<type>success</type>
			<object>
				<type>zone</type>
				<value>example.com</value>
			</object>
		</status>
	</result>
</response>