- Home
- API reference
- API documentation (JSON/XML)
- Tasks
- Domain tasks
Domain update plus
Function
With the task DomainUpdatePlus, in contrast to DomainUpdate, you can specify the data of a domain contact (handle) to have it created automatically. If a contact with this data already exists, no new one will be created, but the existing one will be used. Within the "Domain" element all keywords are possible, which you can also use with DomainUpdate. In the respective domain contact elements (ownerc, adminc, techc, zonec) you can use all keywords that are also valid when editing a domain contact.
If you do not specify certain keywords, they will be loaded from the database.
If a owner change is sent to the system, an existing AuthInfo1 is deleted. If there is a cancellation order of the type Preack in the system, then a new AuthInfo1 is automatically generated.
The description of the keywords for Domain can be found on the Object Domain page. The description of the keywords for Domain Contact (ownerc, adminc, techc, zonec) can be found on the Object Contact page. The description of DNSSec keywords can be found on the DNSSEC object page.
Description
Route: PUT /domain/{name}
{
"name": "example.com",
"ownerc": {
"address": [
"Example Street 25"
],
"fname": "John",
"lname": "Doe",
"pcode": "12345",
"city": "Example City",
"state": "By",
"country": "DE",
"type": "PERSON",
"email": "user@example.com",
"phone": "+49-500-5000",
"fax": "+49-500-6000"
},
"adminc": {
"id": 21642636
},
"techc": {
"id": 21642636
},
"nameServers": [
{
"name": "ns1.nameserver.com"
},
{
"name": "ns2.nameserver.com"
}
],
"confirmOwnerConsent": "true"
}{
"stid": "20201214-app2-dev-21464",
"messages": [
{
"text": "The DNS check was completed successfully.",
"objects": [
{
"type": "zone",
"value": "example.com"
}
],
"code": "S0206",
"status": "SUCCESS"
},
{
"text": "Domain contact has been successfully created.",
"objects": [
{
"type": "handle",
"value": "23278842"
}
],
"code": "S0301",
"status": "SUCCESS"
}
],
"status": {
"code": "N0102",
"text": "Domain update has been started successfully.",
"type": "NOTIFY"
},
"object": {
"type": "Domain",
"value": "example.com"
},
"data": [
{
"created": "2020-12-14T13:56:12.467+0100",
"updated": "2020-12-14T13:56:12.000+0100",
"owner": {
"context": 4,
"user": "exampleuser"
},
"updater": {
"context": 4,
"user": "exampleuser"
},
"status": "RUNNING",
"execution": "2020-12-14T13:56:11.000+0100",
"id": 4299135813
}
]
}Task code: 0102
Uses Domain object
Single request
<request>
<auth>
<user>customer</user>
<password>password</password>
<context>4</context>
</auth>
<task>
<code>0102</code>
<domain>
<name>example.com</name>
<ownerc>
<alias></alias>
<type>PERSON</type>
<fname>John</fname>
<lname>Doe</lname>
<title></title>
<organization>Example Company</organization>
<address>Example Street 20</address>
<pcode>12345</pcode>
<city>Example City</city>
<state></state>
<country>de</country>
<phone>+49-123-123</phone>
<fax>+49-123-123</fax>
<email>user@example.com</email>
<sip></sip>
<protection>B</protection>
<nic_ref>de</nic_ref>
<nic_ref>com</nic_ref>
<nic_ref>net</nic_ref>
<nic_ref>eu</nic_ref>
<remarks>Comment</remarks>
<extension>
<uk_type></uk_type>
<uk_trade_name></uk_trade_name>
<uk_company_no></uk_company_no>
</extension>
</ownerc>
<adminc>9925345</adminc>
<techc>9925346</techc>
<zonec>9925346</zonec>
<nserver>
<name>ns1.example.com</name>
</nserver>
<nserver>
<name>ns2.example.com</name>
<ip>172.16.100.1</ip>
<ip6>2001:0DB8::1</ip6>
</nserver>
<use_privacy>1</use_privacy>
<confirm_owner_consent>1</confirm_owner_consent>
<dnssec>
<flags>257</flags>
<protocol>3</protocol>
<algorithm>5</algorithm>
<publickey>key...</publickey>
</dnssec>
</domain>
<reply_to>customer@example.com</reply_to>
</task>
</request><response>
<result>
<data>
<domain_job>
<job>
<id>4395211756</id>
<status>NOT_SET</status>
</job>
</domain_job>
</data>
<status>
<code>N0102</code>
<text>Domain update has been started successfully.</text>
<type>notify</type>
<object>
<type>domain</type>
<value>example.com</value>
</object>
</status>
</result>
<stid>20201214-app2-19346</stid>
</response>Bulk request
<request>
<auth>
<user>customer</user>
<password>password</password>
<context>4</context>
</auth>
<task>
<code>0102</code>
<ctid></ctid>
<default>
<ownerc>9925345</ownerc>
<adminc>9925345</adminc>
<techc>9925345</techc>
<zonec>9925345</zonec>
<nserver>
<name>ns1.example.org</name>
<ip>172.16.100.1</ip>
</nserver>
<nserver>
<name>ns2.example.org</name>
<ip>172.16.100.2</ip>
</nserver>
<dns_checks>soa</dns_checks>
<confirm_owner_consent>1</confirm_owner_consent>
</default>
<domain>
<name>example.org</name>
</domain>
<domain>
<name>example.net</name>
</domain>
<domain>
<name>example.biz</name>
</domain>
<reply_to>customer@example.com</reply_to>
</task>
</request><response>
<result>
<msg>
<text>Domain update has been started successfully.</text>
<code>N0102</code>
<type>notify</type>
<object>
<type>domain</type>
<value>example.org</value>
</object>
</msg>
<msg>
<text>Domain update has been started successfully.</text>
<code>N0102</code>
<type>notify</type>
<object>
<type>domain</type>
<value>example.net</value>
</object>
</msg>
<msg>
<text>Domain update has been started successfully.</text>
<code>N0102</code>
<type>notify</type>
<object>
<type>domain</type>
<value>example.biz</value>
</object>
</msg>
<status>
<code>N0102001</code>
<text>Domain update has been started successfully.</text>
<type>notify</type>
</status>
</result>
<ctid/>
<stid>20180213-app3-10304</stid>
</response>.