Start
/
API-Referenz
/
API-Dokumentation (XML/ JSON)
/
Auftragstypen
/
Zone-Auftragstypen

Zone Update Bulk

API-Referenz (XML/JSON) · Aktualisiert 2023-09-07

Funktion

Der Auftragstyp ZoneUpdateBulk aktualisiert mehrere Zonen auf Nameservern, die vom System verwaltet werden, in einem Auftrag.

Beschreibung

Werte von Zonen-Einträgen hinzufügen und entfernen:
Mit dem Keyword resourceRecordsAdd kannst du einzelne Zonen-Einträge einer Subdomain ändern, mit dem Keyword resourceRecordsRem kannst du sie entfernen.

PATCH /bulk/zone

Beispiele für das Hinzufügen von Daten
In diesem Beispiel werden für die zwei Zonen bulk-1.test und bulk-2.test jeweils ein A-Record und ein MX-Record hinzugefügt. Für das Hinzufügen zu mehreren Zonen können mehrere Zonen-Blöcke eingefügt werden.

{
    "template": {
        "resourceRecordsAdd": [
            {
                "name": "sub1",
                "ttl": 600,
                "type": "A",
                "pref": 10,
                "value": "1.2.1.2"
			},
            {
                "name": "mail",
                "ttl": 600,
                "type": "MX",
                "pref": 10,
                "value": "1.2.1.2"
			}
		],
        "soa": {
            "refresh": 39940,
            "retry": 7200,
            "expire": 604800,
            "ttl": 86400,
            "email": "customer@example.com"
        }
    },

    "objects": [
        {
            "origin": "bulk-1.test",
            "virtualNameServer": "ns1.example.com"
		},
        {
            "origin": "bulk-2.test",
            "virtualNameServer": "ns1.example.com"
		}
	]
}

{
    "stid": "20201204-app1-24993",
    "object": {
        "type": "Zone",
        "summary": 2
    },
    "data": [
        {
            "status": {
                "code": "S0202",
                "text": "Zone was updated successfully on the name server.",
                "type": "SUCCESS"
            },
            "object": {
                "type": "Zone",
                "value": "bulk-1.test",
                "data": {
                    "origin": "bulk-1.test",
                    "virtualNameServer": "ns1.example.com",
                    "roid": 164728
                }
            }
        },
        {
            "status": {
                "code": "S0202",
                "text": "Zone was updated successfully on the name server.",
                "type": "SUCCESS"
            },
            "object": {
                "type": "Zone",
                "value": "bulk-2.test",
                "data": {
                    "origin": "bulk-2.test",
                    "virtualNameServer": "ns1.example.com",
                    "roid": 164729
                }
            }
        }
    ]
}

Beispiele für Suchen und Ersetzen von Werten
In diesem Beispiel wird nach dem TTL-Wert gesucht, das " * " bedeutet "Suche alle und ersetze mit dem Wert 1000". Dafür sind keine rr_add oder rr_rem Blöcke erforderlich.

{
	"modifiers": [
		{
			"type": "TTL",
			"search": "*",
			"replace": "1000"
		}
	],
    "objects": [
        {
            "origin": "bulk-1.test",
            "virtualNameServer": "ns1.example.com"
		},
        {
            "origin": "bulk-2.test",
            "virtualNameServer": "ns2.example.com"
		}
	]	
}

{
    "stid": "20201204-app1-25276",
    "object": {
        "type": "Zone",
        "summary": 2
    },
    "data": [
        {
            "status": {
                "code": "S0202",
                "text": "Zone was updated successfully on the name server.",
                "type": "SUCCESS"
            },
            "object": {
                "type": "Zone",
                "value": "bulk-1.test",
                "data": {
                    "origin": "bulk-1.test",
                    "virtualNameServer": "ns1.example.com",
                    "roid": 164728
                }
            }
        },
        {
            "status": {
                "code": "S0202",
                "text": "Zone was updated successfully on the name server.",
                "type": "SUCCESS"
            },
            "object": {
                "type": "Zone",
                "value": "bulk-2.test",
                "data": {
                    "origin": "bulk-2.test",
                    "virtualNameServer": "ns1.example.com",
                    "roid": 164729
                }
            }
        }
    ]
}

Die Authentifizierungsdaten für ein BasicSSL-Zertifikat in die Zone eintragen

{
    "template": {
        "resourceRecordsAdd": [
            {
                "name": "sa8ck1zhwhphl9y037wu4qnjs6m8mnbo.bulk.test.",
                "ttl": 600,
                "type": "CNAME",
                "value": "s20160419103010.bulk.test."
			}
		],

    },

    "objects": [
        {
            "origin": "bulk-1.test",
            "virtualNameServer": "ns1.example.com"
		}
	]
}

{
    "stid": "20201204-app1-1590",
    "object": {
        "type": "Zone",
        "summary": 1
    },
    "data": [
        {
            "status": {
                "code": "S0202",
                "text": "Zone was updated successfully on the name server.",
                "type": "SUCCESS"
            },
            "object": {
                "type": "Zone",
                "value": "bulk-1.test",
                "data": {
                    "origin": "bulk-1.test",
                    "virtualNameServer": "ns1.example.com",
                    "roid": 164728
                }
            }
        }
    ]
}

Die Authentifizierungsdaten eines BasicSSL-Zertifikates aus der Zone entfernen

{
    "template": {
        "resourceRecordsRem": [
            {
                "name": "sa8ck1zhwhphl9y037wu4qnjs6m8mnbo.bulk.test.",
                "ttl": 600,
                "type": "CNAME",
                "value": "s20160419103010.bulk.test."
			}
		],

    },

    "objects": [
        {
            "origin": "bulk-1.test",
            "virtualNameServer": "ns1.example.com"
		}
	]
}

{
    "stid": "20201204-app1-1680",
    "object": {
        "type": "Zone",
        "summary": 1
    },
    "data": [
        {
            "status": {
                "code": "S0202",
                "text": "Zone was updated successfully on the name server.",
                "type": "SUCCESS"
            },
            "object": {
                "type": "Zone",
                "value": "bulk-1.test",
                "data": {
                    "origin": "bulk-1.test",
                    "virtualNameServer": "ns1.example.com",
                    "roid": 164728
                }
            }
        }
    ]
}

Auftragstyp-Code: 0202001
Verwendet Objekt Zone

Werte von Zonen-Einträgen hinzufügen und entfernen:
Mit dem Keyword rr_add (resource record add) kannst du einzelne Zonen-Einträge einer Subdomain ändern, mit dem Keyword rr_rem (resource record remove) kannst du sie entfernen.

Werte von Zonen-Einträgen suchen und ersetzen:
Mit dem Keyword search_and_replace kannst du nach Werten suchen und diese mit einem anderen Wert ersetzen. Hierbei sind rr_add oder rr_rem Blöcke nicht erforderlich, können aber zusätzlich verwendet werden ohne die Funktionalität zu stören.

Beispiel für das Hinzufügen von Daten
In diesem Beispiel werden für die zwei Zonen example1.com und example2.com jeweils ein A-Record und ein MX-Record hinzugefügt.
Für das Hinzufügen zu mehreren Zonen können mehrere Zonen-Blöcke eingefügt werden.

<request>
	<auth>
		<user>customer</user>
		<password>passwort</password>
		<context>4</context>
	</auth>
	<task>
		<code>0202001</code>
		<default>
			<rr_add>
				<name>sub1</name>
				<type>A</type>
				<value>5.6.7.8</value>
			</rr_add>
			<rr_add>
				<name>mail</name>
				<type>MX</type>
				<value>mailserver.example.com</value>
			</rr_add>
			<soa>
				<refresh>39940</refresh>
				<retry>7200</retry>
				<expire>604800</expire>
				<ttl>86400</ttl>
			</soa>
		</default>
		<zone>
			<name>example1.com</name>
			<system_ns>ns1.example.com</system_ns>
		</zone>
		<zone>
			<name>example2.com</name>
			<system_ns>ns1.example.com</system_ns>
		</zone>
	</task>
</request>

<response>
	<result>
		<msg>
			<text>Zone wurde auf dem Nameserver aktualisiert.</text>
			<code>0202001</code>
			<type>success</type>
			<object>
				<type>zone</type>
				<value>example1.com</value>
			</object>
		</msg>
		<msg>
			<text>Zone wurde auf dem Nameserver aktualisiert.</text>
			<code>0202001</code>
			<type>success</type>
			<object>
				<type>zone</type>
				<value>example2.com</value>
			</object>
		</msg>
		<status>
			<code>S0202001</code>
			<text>Massenaktualisierung fuer Zonen wurde abgeschlossen.</text>
			<type>success</type>
		</status>
	</result>
	<stid>20130906-app1-7072</stid>
</response>

Beispiele für das Suchen und Ersetzen von Werten
In diesem Beispiel wird nach dem TTL-Wert gesucht, das " * " bedeutet "Suche alle und ersetze mit dem Wert 1000".
Dafür sind keine rr_add oder rr_rem Blöcke erforderlich.

<request>
     <auth>
         <user>customer</user>
         <password>passwort</password>
         <context>4</context>
     </auth>
     <task>
         <code>0202001</code>
         <default>
             <search_and_replace>
                 <search>*</search>
                 <type>TTL</type>
                 <replace>1000</replace>
             </search_and_replace>
             <soa>
                 <refresh>39940</refresh>
                 <retry>7200</retry>
                 <expire>604800</expire>
                 <ttl>86400</ttl>
             </soa>
         </default>
         <zone>
             <name>example.com</name>
             <system_ns>ns1.example.com</system_ns>
         </zone>
         <zone>
             <name>example2.com</name>
             <system_ns>ns1.example.com</system_ns>
         </zone>
     </task>
 </request>

<response>
	<result>
		<msg>
			<text>Zone wurde erfolgreich auf dem Nameserver aktualisiert.</text>
			<code>S0202</code>
			<type>success</type>
			<object>
				<type>zone</type>
				<value>example1.com</value>
			</object>
		</msg>
		<msg>
			<text>Zone wurde erfolgreich auf dem Nameserver aktualisiert.</text>
			<code>S0202</code>
			<type>success</type>
			<object>
				<type>zone</type>
				<value>example2.com</value>
			</object>
		</msg>
		<status>
			<code>S0202001</code>
			<text>Massenaktualisierung fuer Zonen wurde abgeschlossen.</text>
			<type>success</type>
		</status>
	</result>
	<stid>20130906-app1-7179</stid>
</response

Die Authentifizierungsdaten für ein BasicSSL-Zertifikat in die Zone eintragen

request>
<auth>
	<user>customer</user>
	<password>passwort</password>
	<context>4</context>
</auth>
<task>
	<code>0202001</code>
	<default>
		<rr_add>
			<name>sa8ck1zhwhphl9y037wu4qnjs6m8mnbo.example.com.</name>
			<type>CNAME</type>
			<ttl>300</ttl>
			<value>s20160419103010.example.com.</value>
		</rr_add>
	</default>
	<zone>
		<name>example.com</name>
		<system_ns>ns1.example.com</system_ns>
	</zone>
</task>
</request>

<response>
	<result>
		<msg>
			<text>Zone wurde auf dem Nameserver aktualisiert.</text>
			<code>S0202001</code>
			<type>success</type>
			<object>
				<type>zone</type>
				<value>example.com</value>
			</object>
		</msg>
		<status>
			<code>S0202001</code>
			<text>Massenaktualisierung fuer Zonen wurde abgeschlossen.</text>
			<type>success</type>
		</status>
	</result>
	<stid>20130906-7072</stid>
</response>

Die Authentifizierungsdaten eines BasicSSL-Zertifikates aus der Zone entfernen

<request>
	<auth>
		<user>customer</user>
		<password>passwort</password>
		<context>4</context>
	</auth>
	<task>
		<code>0202001</code>
		<default>
			<rr_rem>
				<name>sa8ck1zhwhphl9y037wu4qnjs6m8mnbo.example.com.</name>
				<type>CNAME</type>
				<ttl>600</ttl>
				<value>s20160419103010.example.com.</value>
			</rr_rem>
		</default>
		<zone>
			<name>example.com</name>
			<system_ns>ns1.example.com</system_ns>
		</zone>
	</task>
</request>

	<result>
		<msg>
			<text>Zone wurde auf dem Nameserver aktualisiert.</text>
			<code>S0202001</code>
			<type>success</type>
			<object>
				<type>zone</type>
				<value>example.com</value>
			</object>
		</msg>
		<status>
			<code>S0202001</code>
			<text>Massenaktualisierung fuer Zonen wurde abgeschlossen.</text>
			<type>success</type>
		</status>
	</result>
	<stid>20130906-7072</stid>
</response>

Beispiel: Main-IP entfernen oder ersetzen
Mit dem optionalen Keyword remove_main_ip kannst du beim Entfernen von Nameserver-Einträgen entscheiden, ob auch die Main-IP entfernt oder aber mit einer Suchen-Ersetzen-Abfrage durch eine andere ersetzt werden soll.

<request>
	<auth>
		<user>user</user>
		<password>password</password>
		<context>4</context>
	</auth>
	<task>
		<code>0202001</code>
		<default>
			<remove_main_ip>1</remove_main_ip>
			<search_and_replace>
				<search>1.2.3.4</search>
				<type>A</type>
				<replace></replace>
			</search_and_replace>
			<soa>
				<refresh>39940</refresh>
				<retry>7200</retry>
				<expire>604800</expire>
				<ttl>86400</ttl>
			</soa>
		</default>
		<zone>
			<name>examplezone.com</name>
			<system_ns>1.examplezone.de</system_ns>
			<main>
				<value>1.2.3.4</value>
				<ttl>86400</ttl>
			</main>
		</zone>
	</task>
</request>

<response> 
	<result>
		<msg>
			<text>Zone wurde erfolgreich auf dem Nameserver aktualisiert.</text>
			<code>S0202</code>
			<type>success</type>
			<object>
				<type>zone</type>
				<value>examplezone.com</value>
			</object>
		</msg>
		<status>
			<code>S0202001</code>
			<text>Massenaktualisierung fuer Zonen wurde abgeschlossen.</text>
			<type>success</type>
		</status>
	</result>
	<stid>20150429-app2-24590</stid>
</response>