Ihr Browser lässt keine Web-Fonts zu. Unsere Webseiten nutzen Web-Fonts basierte Icons. Um unseren Service zu verbessern, erlauben Sie bitte Ihrem Browser Web-Fonts zu benutzen.
Wir stellen ein!
Deutsch | English | Español

2.8. Domain

The domain object provides methods for creating, deleting, listing etc. of domains.

2.8.1. domain.check

Check the availability of domains.

2.8.1.1. Input

Table 2.83. Parameters

ParameterDescriptionTypeRequiredDefault
domainDomain name array_domain false 
sldSecond level domain name text64 false 
tldTop level domain array_text64 false 
regionCheck top level domains of the given groups array_identifier false 
wideMore detailed output int false1

2.8.1.2. Output

Table 2.84. Parameters

ParameterDescriptionTypeOptional
domain   
... domainDomain name token255  
... availDomain avaibility for registration boolean  
... statusDomain avaibility status text10 Yes
... checktimeDomain check time float Yes
... nameSecond level domain name text64 Yes
... tldTop level domain name text10 Yes
... checkmethodDomain check method text10 Yes
... priceDomain registration/transfer price float Yes

2.8.2. domain.create

Register a domain name.

2.8.2.1. Input

Table 2.85. Parameters

ParameterDescriptionTypeRequiredDefault
domainDomain name token255 true 
periodDomain registration/renewal period period false*
registrantDomain owner contact handle id int true 
adminDomain administrative contact handle id int true 
techDomain technical contact handle id int true 
billingDomain billing contact handle id int true 
nsList of nameserver nsList false 
transferLockLock domain boolean false1
renewalModeDomain renewal mode renewalMode falseAUTORENEW
whoisProviderWhois provider token0255 false 
whoisUrlWhois url token0255 false 
scDateTime of scheduled execution timestamp false 
extDataDomain extra data extData false 
asynchronAsynchron domain create boolean falsefalse
voucherVoucher code text64 false 
testingExecute command in testing mode boolean falsefalse

2.8.2.2. Output

Table 2.86. Parameters

ParameterDescriptionTypeOptional
roIdId (Repository Object Identifier) of the domain int  
priceIncurred expenses float  
currencyCurrency related to price value customercurrency  

2.8.3. domain.delete

Deletes a domain.

2.8.3.1. Input

Table 2.87. Parameters

ParameterDescriptionTypeRequiredDefault
domainDomain name token255 true 
scDateTime of scheduled execution timestamp false 
testingExecute command in testing mode boolean falsefalse

2.8.3.2. Output

No additional return parameters

2.8.4. domain.getdomainprice

Check the availability of domains.

2.8.4.1. Input

Table 2.88. Parameters

ParameterDescriptionTypeRequiredDefault
domainDomain name array_domain true 
pricetypeType to get the price for text64 true 
periodperiod for the requested action text64 false 
voucherVoucher code text64 false 

2.8.4.2. Output

Table 2.89. Parameters

ParameterDescriptionTypeOptional
domain   
... typeThe type of the perfomed action for this item, most likely the same value as pricetype text64  
... periodThe value of the period, that is required for this item, will usually match period from request text64  
... priceThe price of this item and action float  
... currencyThe currency belonging to the price customercurrency  
... promoFlag, if the given price is promo boolean  
... premiumFlag, if the given price is premium boolean  

2.8.5. domain.getPrices

Get the domain prices.

2.8.5.1. Input

Table 2.90. Parameters

ParameterDescriptionTypeRequiredDefault
tldTop level domain array_text64 false 
vatPrices with vat boolean falsetrue
vatCC2-letter ISO country code country false 
voucherVoucher code text64 false 

2.8.5.2. Output

Table 2.91. Parameters

ParameterDescriptionTypeOptional
price   
... tldTop level domain name text64  
... currencyCurrency of the price text10  
... createPriceDomain registration price/year float  
... monthlyCreatePriceDomain registration price/month float Yes
... transferPriceDomain transfer price/year float  
... renewalPriceDomain renewal price/year float  
... monthlyRenewalPriceDomain renewal price/month float Yes
... updatePriceDomain update price float  
... tradePriceDomain trade price float  
... trusteePriceDomain trustee service price/year float  
... monthlyTrusteePriceDomain trustee service price/month float Yes
... createPeriodDomain creation period in years int  
... transferPeriodDomain transfer period in years int  
... renewalPeriodDomain renewal period in years int  
... tradePeriodDomain trade period in years int  
... vatAdded value tax rate according to vat and vatCC settings float Yes
... promo  Yes
... ... currencyCurrency of the promo price text10  
... ... limitedNumberNumber of limited promos int  
... ... limitedRemainingNumber of remaining promo prices for limited promos int  
... ... startTimePromo start time dateTime  
... ... endTimePromo end time dateTime  
... ... periodThe period the promo offer applies to text10  
... ... tradePricetrade promo price float Yes
... ... trusteePricetrustee promo price float Yes
... ... createPriceDomain registration price/year float Yes
... ... monthlyCreatePriceDomain registration price/month float Yes
... ... transferPriceDomain transfer price/year float Yes
... ... renewalPriceDomain renewal price/year float Yes
... ... monthlyRenewalPriceDomain renewal price/month float Yes
... ... chargedPrice  Yes
... ... ... currencyCurrency of the promo price text10  
... ... ... createPriceDomain registration price/year float  
... ... ... monthlyCreatePriceDomain registration price/month float Yes
... ... ... transferPriceDomain transfer price/year float  
... ... ... renewalPriceDomain renewal price/year float  
... ... ... monthlyRenewalPriceDomain renewal price/month float Yes
... ... ... updatePriceDomain update price float  
... ... ... tradePriceDomain trade price float  
... ... ... trusteePriceDomain trustee service price/year float  
... ... ... monthlyTrusteePriceDomain trustee service price/month float Yes
... chargedPrice  Yes
... ... currencyCurrency of the promo price text10  
... ... createPriceDomain registration price/year float  
... ... monthlyCreatePriceDomain registration price/month float Yes
... ... transferPriceDomain transfer price/year float  
... ... renewalPriceDomain renewal price/year float  
... ... monthlyRenewalPriceDomain renewal price/month float Yes
... ... updatePriceDomain update price float  
... ... tradePriceDomain trade price float  
... ... trusteePriceDomain trustee service price/year float  
... ... monthlyTrusteePriceDomain trustee service price/month float Yes
... eur  Yes
... ... createPriceDomain registration price/year float  
... ... monthlyCreatePriceDomain registration price/month float Yes
... ... transferPriceDomain transfer price/year float  
... ... renewalPriceDomain renewal price/year float  
... ... monthlyRenewalPriceDomain renewal price/month float Yes
... ... updatePriceDomain update price float  
... ... tradePriceDomain trade price float  
... ... trusteePriceDomain trustee service price/year float  
... ... monthlyTrusteePriceDomain trustee service price/month float Yes

2.8.6. domain.getRules

Get TLD rules.

2.8.6.1. Input

Table 2.92. Parameters

ParameterDescriptionTypeRequiredDefault
tldTop level domain name array_text64 false 

2.8.6.2. Output

Table 2.93. Parameters

ParameterDescriptionTypeOptional
rules   
... tldTop level domain name text64  
... ccTLD country country  
... regionAll TLD groups this domain is part of array_identifier  
... timeRegistrationTime for registration text64  
... localOwnerLocal domain owner contact needed boolean  
... localAdminLocal domain administrative contact needed boolean  
... ownerTypeAllowed domain owner contact types text64  
... adminTypeAllowed domain administrative contact types text64  
... techTypeAllowed domain technical contact types text64  
... billingTypeAllowed domain billing contact types text64  
... billingFaxNeededDomain billing contact needs a fax number boolean  
... companyAllowedDomain owner contact can be a company boolean  
... personAllowedDomain owner contact can be a natural person boolean  
... companyNeededDomain owner contact has to be a company boolean  
... personNeededDomain owner contact has to be a natural person boolean  
... VATNeededVat number is needed boolean  
... IDNeededIdentification is needed boolean  
... markNeededTrademark is needed boolean  
... idnDomain name can contain idn chars boolean  
... idnCharsAllowed domain name idn characters token255  
... minLengthMinimal domain name length int  
... maxLengthMaximal domain name length int  
... minNSMinimum amount of nameservers int  
... maxNSMaximum amount of nameservers int  
... dnssecWhich type of DNSSEC record type is supported text64  
... registrationPeriodAllowed domain registration periods text64  
... renewalPeriodAllowed domain renewal periods text64  
... restorePeriod1Allowed restore period 1 in days int  
... restorePeriod2Allowed restore period 2 in days int  
... trusteeTrustee service available boolean  
... whoisProtectionWhois protection service available boolean  
... authCodeAuth code required/needed text10  
... transferLockTLD registry supports transfer lock boolean  
... renewAllowedManual domain renewal is allowed text10  
... tradeAllowedDomain trade is allowed text10  
... pushAllowedDomain push is allowed text10  
... updateAllowedDomain update is allowed text10  
... updateAuthcodeAllowedUpdate domain auth code is allowed text10  
... transferAllowedDomain transfer is allowed text10  
... transferOutAllowedDomain transfer out is allowed text10  
... restoreAllowedDomain restore is allowed text10  
... paperworkDomain action requires additional paperwork int  
... restorePossibilityDomain restore possibility int  
... blacklistNot allowed second level domain names text  
... defaultRegistrationPeriodDefault Registration Period text  
... defaultRenewalPeriodDefault Renewal Period text  

2.8.7. domain.getTldGroups

Get groups for TLD

2.8.7.1. Input

Table 2.94. Parameters

ParameterDescriptionTypeRequiredDefault
tldTop level domain array_text64 false 

2.8.7.2. Output

Table 2.95. Parameters

ParameterDescriptionTypeOptional
groupsAll TLD groups this domain is part of array_identifier  

2.8.8. domain.info

Get domain details.

2.8.8.1. Input

Table 2.96. Parameters

ParameterDescriptionTypeRequiredDefault
domainDomain name token255 false 
roIdDomain id (Repository Object Identifier) int false 
wideMore detailed output int false1

2.8.8.2. Output

Table 2.97. Parameters

ParameterDescriptionTypeOptional
roIdId (Repository Object Identifier) of the domain int  
domainDomain name text64  
domain-aceDomain ace name text64  
periodDomain registration/renewal period period Yes
crDateTime of domain creation dateTime Yes
exDateTime of domain expiration dateTime Yes
upDateTime of last domain update dateTime Yes
reDateTime of domain renewal dateTime Yes
scDateTime of scheduled execution dateTime Yes
transferLockDomain is locked boolean Yes
statusStatus of the domain text64 Yes
authCodeDomain auth code text064 Yes
renewalModeDomain renewal mode renewalMode Yes
transferModeDomain transfer mode transferMode Yes
registrantDomain owner contact handle id int Yes
adminDomain administrative contact handle id int Yes
techDomain technical contact handle id int Yes
billingDomain billing contact handle id int Yes
nsList of nameserver nsList Yes
noDelegationDomain delegation status boolean Yes
contact  Yes
... registrantRegistrant contact handle details contact  
... adminAdministrative contact handle details contact  
... techTechnical contact handle details contact  
... billingBilling contact handle details contact  
extDataDomain extra data extData Yes
verificationStatusContact Verification Status text64 Yes
registrantVerificationStatusContact Verification Status text64 Yes

2.8.9. domain.list

List all available customers domains.

2.8.9.1. Input

Table 2.98. Parameters

ParameterDescriptionTypeRequiredDefault
domainFilter by domain name search string array_text255 false*
roIdFilter by domain id (Repository Object Identifier) array_int false 
statusFilter by domain status array_text64 false 
registrantFilter by registrant ids array_int false 
adminFilter by admin ids array_int false 
techFilter by tech ids array_int false 
billingFilter by billing ids array_int false 
renewalModeFilter by renewal mode renewalMode false 
transferLockFilter by transfer lock boolean false 
noDelegationFilter by delegation status boolean false 
tagFilter by tag ids array_int false 
wideMore detailed output int false1
orderSort order of result list domainOrder falseDOMAINASC
pagePage number for paging int false1
pagelimitMax number of results per page int false20
withPrivacyFilter by Privacy option (1 is true) int false 

2.8.9.2. Output

Table 2.99. Parameters

ParameterDescriptionTypeOptional
countTotal number of preregistrations int  
domain   
... roIdId (Repository Object Identifier) of the domain int  
... domainDomain name token255  
... domain-aceDomain ace name token255  
... periodDomain registration/renewal period period Yes
... crDateTime of domain creation dateTime Yes
... exDateTime of domain expiration dateTime Yes
... upDateTime of last domain update dateTime Yes
... reDateTime of domain renewal dateTime Yes
... scDateTime of scheduled execution dateTime Yes
... transferLockDomain is locked boolean Yes
... statusStatus of the domain text64 Yes
... authCodeDomain auth code token255 Yes
... renewalModeDomain renewal mode renewalMode Yes
... transferModeDomain transfer mode transferMode Yes
... registrantDomain owner contact handle id int Yes
... adminDomain administrative contact handle id int Yes
... techDomain technical contact handle id int Yes
... billingDomain billing contact handle id int Yes
... nsList of nameserver nsList Yes
... noDelegationDomain delegation status boolean Yes
... contact  Yes
... ... registrantRegistrant contact handle details contact  
... ... adminAdministrative contact handle details contact  
... ... techTechnical contact handle details contact  
... ... billingBilling contact handle details contact  
... extDataDomain extra data extData Yes
... verificationStatusContact Verification Status text64 Yes

2.8.10. domain.log

Log of changes to a domain.

2.8.10.1. Input

Table 2.100. Parameters

ParameterDescriptionTypeRequiredDefault
domainFilter result by domain name token255 false 
statusFilter result by status text64 false 
invoiceFilter result by invoice id text64 false 
dateFromLog start date timestamp false 
dateToLog end date timestamp false 
priceMinMinimum price of log entry float false0.0
priceMaxMaximum price of log entry float false 
orderordering of the results domainLogOrder falseLOGTIMEDESC
pagePage number for paging int false1
pagelimitMax number of results per page int false20

2.8.10.2. Output

Table 2.101. Parameters

ParameterDescriptionTypeOptional
countTotal number of log entries int  
sumSum of amount float  
domain   
... dateLog timestamp dateTime  
... roIdId (Repository Object Identifier) of the domain int  
... domainDomain name token255  
... statusDomain status text64  
... priceIncurred expenses of the domain action float  
... invoiceInvoice id text64  
... remoteAddrIp address of executing client ip  
... userTextDomain action description text255  
... logIdID of the log entry int  

2.8.11. domain.push

Return domain to registry (if supported by TLD).

2.8.11.1. Input

Table 2.102. Parameters

ParameterDescriptionTypeRequiredDefault
domainDomain name token255 true 
targetTarget registrar (if supported) text64 false 
scDateScheduled execution date timestamp false 
testingExecute command in testing mode boolean falsefalse

2.8.11.2. Output

No additional return parameters

2.8.12. domain.renew

Manual domain renewal.

2.8.12.1. Input

Table 2.103. Parameters

ParameterDescriptionTypeRequiredDefault
domainDomain name token255 true 
periodDomain renewal period period true 
expirationDate of current expiration date true 
asynchronAsynchron domain renew boolean falsefalse
testingExecute command in testing mode boolean falsefalse

2.8.12.2. Output

Table 2.104. Parameters

ParameterDescriptionTypeOptional
exDateTime of domain expiration dateTime  
reDateTime of next domain renewal dateTime  

2.8.13. domain.resettransferrequest

Reset the transfer status of a domain to resend the FOA email.

2.8.13.1. Input

Table 2.105. Parameters

ParameterDescriptionTypeRequiredDefault
domainDomain name token255 true 

2.8.13.2. Output

No additional return parameters

2.8.14. domain.restore

Restores an expired/deleted domain (if supported).

2.8.14.1. Input

Table 2.106. Parameters

ParameterDescriptionTypeRequiredDefault
domainDomain name token255 true 
renewalModeDomain renewal mode renewalMode false 
testingExecute command in testing mode boolean falsefalse

2.8.14.2. Output

No additional return parameters

2.8.15. domain.stats

Get registered domain TLD statistics.

2.8.15.1. Input

No parameters allowed

2.8.15.2. Output

Table 2.107. Parameters

ParameterDescriptionTypeOptional
tld  Yes
... countTotal number of registered TLD int  

2.8.16. domain.trade

Change domain owner (if supported).

2.8.16.1. Input

Table 2.108. Parameters

ParameterDescriptionTypeRequiredDefault
domainDomain name token255 true 
registrantNew domain owner contact handle id int true 
adminNew administrative contact handle id int true 
techNew technical contact handle id int true 
billingNew billing contact handle id int true 
nsList of nameserver nsList false 
authCodeAuthorization code (if supported) text64 false 
whoisProviderWhois provider token0255 false 
whoisUrlWhois url token0255 false 
scDateScheduled execution date timestamp false 
extDataDomain trade extra data extDataTrade false 
asynchronAsynchron domain trade boolean falsefalse
testingExecute command in testing mode boolean falsefalse

2.8.16.2. Output

Table 2.109. Parameters

ParameterDescriptionTypeOptional
roIdId (Repository Object Identifier) of the domain int  
priceIncurred expenses float  
currencyCurrency related to price value customercurrency  

2.8.17. domain.transfer

Transfer domain to another registrar or user.

2.8.17.1. Input

Table 2.110. Parameters

ParameterDescriptionTypeRequiredDefault
domainDomain name token255 true 
registrantDomain owner contact handle id int false 
adminDomain administrative contact handle id int false 
techDomain technical contact handle id int false 
billingDomain billing contact handle id int false 
nsList of nameserver nsList false 
nsTakeoverKeep existing nameservers boolean falsefalse
contactTakeoverTransfer also data related to the transfered gTLD boolean falsefalse
transferLockLock domain boolean false1
authCodeAuthorization code (if supported) text64 false 
renewalModeDomain renewal mode renewalMode falseAUTORENEW
whoisProviderWhois provider token0255 false 
whoisUrlWhois url token0255 false 
extDataDomain extra data extDataTransfer false 
scDateTime of scheduled execution timestamp false 
asynchronAsynchron domain transfer boolean falsefalse
voucherVoucher code text64 false 
testingExecute command in testing mode boolean falsefalse

2.8.17.2. Output

Table 2.111. Parameters

ParameterDescriptionTypeOptional
roIdId (Repository Object Identifier) of the domain int  
priceIncurred expenses float  
currencyCurrency related to price value customercurrency  

2.8.18. domain.transfercancel

Cancel the transfer of a domain to another registrar or user.

2.8.18.1. Input

Table 2.112. Parameters

ParameterDescriptionTypeRequiredDefault
domainDomain name token255 true 

2.8.18.2. Output

No additional return parameters

2.8.19. domain.transferOut

Allow or deny outgoing transfer requests.

2.8.19.1. Input

Table 2.113. Parameters

ParameterDescriptionTypeRequiredDefault
domainDomain name token255 true 
answerAcknowledge or deny the domain request transferAnswer true 
testingExecute command in testing mode boolean falsefalse

2.8.19.2. Output

No additional return parameters

2.8.20. domain.update

Update domain data.

2.8.20.1. Input

Table 2.114. Parameters

ParameterDescriptionTypeRequiredDefault
domainDomain name token255 true 
registrantNew owner contact handle id int false 
adminNew administrative contact handle id int false 
techNew technical contact handle id int false 
billingNew billing contact handle id int false 
nsList of nameserver nsList false 
transferLockLock domain boolean false 
periodDomain registration/renewal period period false 
authCodeAuthorization code (if supported) text64 false 
scDateTime of scheduled execution timestamp false 
renewalModeDomain renewal mode renewalMode false 
transferModeDomain transfer mode transferMode false 
whoisProviderWhois provider token0255 false 
whoisUrlWhois url token0255 false 
extDataDomain extra data extData false 
asynchronAsynchron domain update boolean falsefalse
testingExecute command in testing mode boolean falsefalse

2.8.20.2. Output

Table 2.115. Parameters

ParameterDescriptionTypeOptional
priceIncurred expenses float  

2.8.21. domain.whois

Get the whois information of a domain.

2.8.21.1. Input

Table 2.116. Parameters

ParameterDescriptionTypeRequiredDefault
domainDomain name text64 true 

2.8.21.2. Output

Table 2.117. Parameters

ParameterDescriptionTypeOptional
whoisWhois output text