The domain object provides methods for creating, deleting, listing etc. of domains.
Check the availability of domains.
Table 2.97. Parameters
Parameter | Description | Type | Required | Default |
---|---|---|---|---|
domain | Domain name | array_domain | false | |
sld | Second level domain name | text64 | false | |
tld | Top level domain | array_text64 | false | |
region | Check top level domains of the given groups | array_identifier | false | |
wide | More detailed output | int | false | 1 |
Table 2.98. Parameters
Parameter | Description | Type | Optional |
---|---|---|---|
domain | |||
... domain | Domain name | token255 | |
... avail | Domain availability for registration | int | |
... status | Domain availability status | text10 | Yes |
... reason | Reason of the domain invalid status | text | Yes |
... checktime | Domain check time | float | Yes |
... name | Second level domain name | text64 | Yes |
... tld | Top level domain name | text10 | Yes |
... checkmethod | Domain check method | text10 | Yes |
... price | Domain registration/transfer price | float | Yes |
Register a domain name.
Table 2.99. Parameters
Parameter | Description | Type | Required | Default |
---|---|---|---|---|
domain | Domain name | token255 | true | |
period | Domain registration/renewal period | period | false | * |
registrant | Domain owner contact handle id | int | true | |
admin | Domain administrative contact handle id | int | false | |
tech | Domain technical contact handle id | int | false | |
billing | Domain billing contact handle id | int | false | |
ns | List of nameserver | nsList | false | |
transferLock | Lock domain | boolean | false | 1 |
renewalMode | Domain renewal mode | renewalMode | false | |
whoisProvider | Whois provider | token0255 | false | |
whoisUrl | Whois url | token0255 | false | |
scDate | Time of scheduled execution | timestamp | false | |
extData | Domain extra data | extData | false | |
asynchron | Asynchron domain create | boolean | false | false |
voucher | Voucher code | text64 | false | |
testing | Execute command in testing mode | boolean | false | false |
Table 2.100. Parameters
Parameter | Description | Type | Optional |
---|---|---|---|
roId | Id (Repository Object Identifier) of the domain | int | |
price | Incurred expenses | float | |
currency | Currency related to price value | customercurrency | |
notifications | Information about not required contact types | array | Yes |
Get all domain prices (e.g. reg, renewal) for a specified domain.
Table 2.102. Parameters
Parameter | Description | Type | Required | Default |
---|---|---|---|---|
domain | Domain name | array_domain | true | |
period | period for the requested action | text64 | false | |
voucher | Voucher code | text64 | false |
Table 2.103. Parameters
Parameter | Description | Type | Optional |
---|---|---|---|
domain | |||
... premium | Flag, if the given price is premium | boolean | |
... currency | The currency belonging to the prices | customercurrency | |
... period | The value of the period, that is required for this item, will usually match period from request | text64 | |
... promo | Flag, if the given price is promo | boolean | |
... promoPrice | The Promo price of this item | float | |
... promoType | The type of the perfomed action for this promo action | text64 | |
... regPrice | The registration price of this item | float | |
... updatePrice | The update price of this item | float | |
... transferPrice | The transfer price of this item | float | |
... tradePrice | The trading price of this item | float | |
... renewalPrice | The renewal price of this item | float | |
... restorePrice | The restore price of this item | float |
Get the domain price by type (e.g. reg, renewal) for a specified domain.
Table 2.104. Parameters
Parameter | Description | Type | Required | Default |
---|---|---|---|---|
domain | Domain name | array_domain | true | |
pricetype | Type to get the price for. (Options: reg | renewal | transfer | update | trade | restore ) | text64 | true | |
period | period for the requested action | text64 | false | |
voucher | Voucher code | text64 | false |
Table 2.105. Parameters
Parameter | Description | Type | Optional |
---|---|---|---|
domain | |||
... type | The type of the perfomed action for this item, most likely the same value as pricetype | text64 | |
... period | The value of the period, that is required for this item, will usually match period from request | text64 | |
... price | The price of this item and action | float | |
... currency | The currency belonging to the price | customercurrency | |
... promo | Flag, if the given price is promo | boolean | |
... premium | Flag, if the given price is premium | boolean |
Get extra rules for one or all TLDs.
Table 2.107. Parameters
Parameter | Description | Type | Optional |
---|---|---|---|
rules | List with rules and constraints of the top level domains | array_text255 |
Get the domain prices.
Table 2.108. Parameters
Parameter | Description | Type | Required | Default |
---|---|---|---|---|
tld | Top level domain | array_text64 | false | |
vat | Prices with vat | boolean | false | true |
vatCC | 2-letter ISO country code | country | false | |
voucher | Voucher code | text64 | false | |
page | Page number for paging | int | false | 1 |
pagelimit | Max number of results per page. Default is unlimited | int | false |
Table 2.109. Parameters
Parameter | Description | Type | Optional |
---|---|---|---|
price | |||
... tld | Top level domain name | text64 | |
... currency | Currency of the price | text10 | |
... createPrice | Domain registration price/year | float | |
... monthlyCreatePrice | Domain registration price/month | float | Yes |
... transferPrice | Domain transfer price/year | float | |
... renewalPrice | Domain renewal price/year | float | |
... monthlyRenewalPrice | Domain renewal price/month | float | Yes |
... updatePrice | Domain update price | float | |
... tradePrice | Domain trade price | float | |
... trusteePrice | Domain trustee service price/year | float | |
... monthlyTrusteePrice | Domain trustee service price/month | float | Yes |
... createPeriod | Domain creation period in years | int | |
... transferPeriod | Domain transfer period in years | int | |
... renewalPeriod | Domain renewal period in years | int | |
... tradePeriod | Domain trade period in years | int | |
... vat | Added value tax rate according to vat and vatCC settings | float | Yes |
... promo | Yes | ||
... ... currency | Currency of the promo price | text10 | |
... ... limitedNumber | Number of limited promos | int | |
... ... limitedRemaining | Number of remaining promo prices for limited promos | int | |
... ... startTime | Promo start time | dateTime | |
... ... endTime | Promo end time | dateTime | |
... ... period | The period the promo offer applies to | text10 | |
... ... tradePrice | trade promo price | float | Yes |
... ... trusteePrice | trustee promo price | float | Yes |
... ... createPrice | Domain registration price/year | float | Yes |
... ... monthlyCreatePrice | Domain registration price/month | float | Yes |
... ... transferPrice | Domain transfer price/year | float | Yes |
... ... renewalPrice | Domain renewal price/year | float | Yes |
... ... monthlyRenewalPrice | Domain renewal price/month | float | Yes |
... ... chargedPrice | Yes | ||
... ... ... currency | Currency of the promo price | text10 | |
... ... ... createPrice | Domain registration price/year | float | |
... ... ... monthlyCreatePrice | Domain registration price/month | float | Yes |
... ... ... transferPrice | Domain transfer price/year | float | |
... ... ... renewalPrice | Domain renewal price/year | float | |
... ... ... monthlyRenewalPrice | Domain renewal price/month | float | Yes |
... ... ... updatePrice | Domain update price | float | |
... ... ... tradePrice | Domain trade price | float | |
... ... ... trusteePrice | Domain trustee service price/year | float | |
... ... ... monthlyTrusteePrice | Domain trustee service price/month | float | Yes |
... chargedPrice | Yes | ||
... ... currency | Currency of the promo price | text10 | |
... ... createPrice | Domain registration price/year | float | |
... ... monthlyCreatePrice | Domain registration price/month | float | Yes |
... ... transferPrice | Domain transfer price/year | float | |
... ... renewalPrice | Domain renewal price/year | float | |
... ... monthlyRenewalPrice | Domain renewal price/month | float | Yes |
... ... updatePrice | Domain update price | float | |
... ... tradePrice | Domain trade price | float | |
... ... trusteePrice | Domain trustee service price/year | float | |
... ... monthlyTrusteePrice | Domain trustee service price/month | float | Yes |
... eur | Yes | ||
... ... createPrice | Domain registration price/year | float | |
... ... monthlyCreatePrice | Domain registration price/month | float | Yes |
... ... transferPrice | Domain transfer price/year | float | |
... ... renewalPrice | Domain renewal price/year | float | |
... ... monthlyRenewalPrice | Domain renewal price/month | float | Yes |
... ... updatePrice | Domain update price | float | |
... ... tradePrice | Domain trade price | float | |
... ... trusteePrice | Domain trustee service price/year | float | |
... ... monthlyTrusteePrice | Domain trustee service price/month | float | Yes |
Get promo prices of TLDs.
Table 2.110. Parameters
Parameter | Description | Type | Required | Default |
---|---|---|---|---|
tlds | List of specific TLDs to check for promos | array_text64 | false | |
promoType | Domain action (e.g. REG, RENEWAL) | text64 | false | REG |
period | Domain period | int | false | 1 |
periodUnit | Domain period unit (e.g. Y for years or M for months) | text10 | false | Y |
executionDate | Date of promo request | text64 | false | |
voucher | Voucher code | text64 | false |
Table 2.111. Parameters
Parameter | Description | Type | Optional |
---|---|---|---|
promos | |||
... tld | TLD name | text64 | |
... ... netPrice | Net promotional price | float | |
... ... currency | Currency of net price | customercurrency | |
... ... endTime | End time of the promo | dateTime |
Get TLD rules.
Table 2.112. Parameters
Parameter | Description | Type | Required | Default |
---|---|---|---|---|
tld | Top level domain name | array_text64 | false |
Table 2.113. Parameters
Parameter | Description | Type | Optional |
---|---|---|---|
rules | |||
... tld | Top level domain name | text64 | |
... cc | TLD country | country | |
... region | All TLD groups this domain is part of | array_identifier | |
... timeRegistration | Time for registration | text64 | |
... localOwner | Local domain owner contact needed | boolean | |
... localAdmin | Local domain administrative contact needed | boolean | |
... localTech | Local domain technical contact needed | boolean | |
... ownerType | Allowed domain owner contact types | text64 | |
... adminType | Allowed domain administrative contact types | text64 | |
... techType | Allowed domain technical contact types | text64 | |
... billingType | Allowed domain billing contact types | text64 | |
... billingFaxNeeded | Domain billing contact needs a fax number | boolean | |
... companyAllowed | Domain owner contact can be a company | boolean | |
... personAllowed | Domain owner contact can be a natural person | boolean | |
... companyNeeded | Domain owner contact has to be a company | boolean | |
... personNeeded | Domain owner contact has to be a natural person | boolean | |
... VATNeeded | Vat number is needed | boolean | |
... IDNeeded | Identification is needed | boolean | |
... markNeeded | Trademark is needed | boolean | |
... idn | Domain name can contain idn chars | boolean | |
... idnChars | Allowed domain name idn characters | token255 | |
... minLength | Minimal domain name length | int | |
... maxLength | Maximal domain name length | int | |
... minNS | Minimum amount of nameservers | int | |
... maxNS | Maximum amount of nameservers | int | |
... dnssec | Which type of DNSSEC record type is supported | text64 | |
... registrationPeriod | Allowed domain registration periods | text64 | |
... renewalPeriod | Allowed domain renewal periods | text64 | |
... restorePeriod1 | Number of days after a EXPIRE INITIATED event in which a restore is possible | int | |
... restorePeriod2 | Number of days after a DELETE INITIATED event in which a restore is possible | int | |
... trustee | Trustee service available | boolean | |
... privacyLevel | Jurisdiction provides data protection for whois data | text | |
... whoisExposure | Personal information is publicly available through whois | text | |
... whoisProtection | Whois protection service available | boolean | |
... authCode | Auth code required/needed/optional | text10 | |
... minAuthLength | Minimal auth code length | int | |
... maxAuthLength | Maximal auth code length | int | |
... transferLock | TLD registry supports transfer lock | boolean | |
... renewAllowed | Manual domain renewal is allowed | text10 | |
... tradeAllowed | Domain trade is allowed | text10 | |
... pushAllowed | Domain push is allowed | text10 | |
... updateAllowed | Domain update is allowed | text10 | |
... updateAuthcodeAllowed | Update domain auth code is allowed | text10 | |
... transferAllowed | Domain transfer is allowed | text10 | |
... transferOutAllowed | Domain transfer out ack is allowed | text10 | |
... restoreAllowed | Domain restore is allowed | text10 | |
... paperwork | Domain action requires additional paperwork | int | |
... restorePossibility | Domain restore possibility | int | |
... blacklist | Not allowed second level domain names | text | |
... defaultRegistrationPeriod | Default Registration Period | text | |
... defaultRenewalPeriod | Default Renewal Period | text | |
... accreditation | Accreditation | text | |
... tldAce | Unicode TLD | text |
Get groups for TLD
Table 2.114. Parameters
Parameter | Description | Type | Required | Default |
---|---|---|---|---|
tld | Top level domain | array_text64 | false |
Table 2.115. Parameters
Parameter | Description | Type | Optional |
---|---|---|---|
groups | All TLD groups this domain is part of | array_identifier |
Get domain details.
Table 2.117. Parameters
Parameter | Description | Type | Optional |
---|---|---|---|
roId | Id (Repository Object Identifier) of the domain | int | |
domain | Domain name | text64 | |
domain-ace | Domain ace name | text64 | |
period | Domain registration/renewal period | period | Yes |
crDate | Time of domain creation | dateTime | Yes |
exDate | Time of domain expiration | dateTime | Yes |
upDate | Time of last domain update | dateTime | Yes |
reDate | Time of domain renewal | dateTime | Yes |
scDate | Time of scheduled execution | dateTime | Yes |
transferLock | Domain is locked | boolean | Yes |
status | Status of the domain | text64 | Yes |
domainFlags | Domain status flags | array | Yes |
authCode | Domain auth code | token255 | Yes |
renewalMode | Domain renewal mode | renewalMode | Yes |
transferMode | Domain transfer mode | transferMode | Yes |
registrant | Domain owner contact handle id | int | Yes |
admin | Domain administrative contact handle id | int | Yes |
tech | Domain technical contact handle id | int | Yes |
billing | Domain billing contact handle id | int | Yes |
ns | List of nameserver | nsList | Yes |
noDelegation | Domain delegation status | boolean | Yes |
contact | Yes | ||
... registrant | Registrant contact handle details | contact | |
... admin | Administrative contact handle details | contact | |
... tech | Technical contact handle details | contact | |
... billing | Billing contact handle details | contact | |
extData | Domain extra data | extData | Yes |
verificationStatus | Contact Verification Status | text64 | Yes |
registrantVerificationStatus | Contact Verification Status | text64 | Yes |
List all available customers domains.
Table 2.118. Parameters
Parameter | Description | Type | Required | Default |
---|---|---|---|---|
domain | Filter by domain name search string | array_text255 | false | * |
roId | Filter by domain id (Repository Object Identifier) | array_int | false | |
status | Filter by domain status | array_text64 | false | |
registrant | Filter by registrant ids | array_int | false | |
admin | Filter by admin ids | array_int | false | |
tech | Filter by tech ids | array_int | false | |
billing | Filter by billing ids | array_int | false | |
renewalMode | Filter by renewal mode | renewalMode | false | |
transferLock | Filter by transfer lock | boolean | false | |
noDelegation | Filter by delegation status | boolean | false | |
tag | Filter by tag ids | array_int | false | |
wide | More detailed output | int | false | 1 |
order | Sort order of result list | domainOrder | false | DOMAINASC |
page | Page number for paging | int | false | 1 |
pagelimit | Max number of results per page | int | false | 20 |
withPrivacy | Filter by Privacy option (1 is true) | int | false |
Table 2.119. Parameters
Parameter | Description | Type | Optional |
---|---|---|---|
count | Total number of preregistrations | int | |
domain | |||
... roId | Id (Repository Object Identifier) of the domain | int | |
... domain | Domain name | token255 | |
... domain-ace | Domain ace name | token255 | |
... period | Domain registration/renewal period | period | Yes |
... crDate | Time of domain creation | dateTime | Yes |
... exDate | Time of domain expiration | dateTime | Yes |
... upDate | Time of last domain update | dateTime | Yes |
... reDate | Time of domain renewal | dateTime | Yes |
... scDate | Time of scheduled execution | dateTime | Yes |
... transferLock | Domain is locked | boolean | Yes |
... status | Status of the domain | text64 | Yes |
... authCode | Domain auth code | token255 | Yes |
... renewalMode | Domain renewal mode | renewalMode | Yes |
... transferMode | Domain transfer mode | transferMode | Yes |
... registrant | Domain owner contact handle id | int | Yes |
... admin | Domain administrative contact handle id | int | Yes |
... tech | Domain technical contact handle id | int | Yes |
... billing | Domain billing contact handle id | int | Yes |
... ns | List of nameserver | nsList | Yes |
... noDelegation | Domain delegation status | boolean | Yes |
... contact | Yes | ||
... ... registrant | Registrant contact handle details | contact | |
... ... admin | Administrative contact handle details | contact | |
... ... tech | Technical contact handle details | contact | |
... ... billing | Billing contact handle details | contact | |
... extData | Domain extra data | extData | Yes |
... verificationStatus | Contact Verification Status | text64 | Yes |
Log of changes to a domain.
Table 2.120. Parameters
Parameter | Description | Type | Required | Default |
---|---|---|---|---|
domain | Filter result by domain name | token255 | false | |
status | Filter result by status | text64 | false | |
invoice | Filter result by invoice id | text64 | false | |
dateFrom | Log start date | timestamp | false | |
dateTo | Log end date | timestamp | false | |
priceMin | Minimum price of log entry | float | false | 0.0 |
priceMax | Maximum price of log entry | float | false | |
order | ordering of the results | domainLogOrder | false | LOGTIMEDESC |
page | Page number for paging | int | false | 1 |
pagelimit | Max number of results per page | int | false | 20 |
Table 2.121. Parameters
Parameter | Description | Type | Optional |
---|---|---|---|
count | Total number of log entries | int | |
sum | Sum of amount | float | |
domain | |||
... date | Log timestamp | dateTime | |
... roId | Id (Repository Object Identifier) of the domain | int | |
... domain | Domain name | token255 | |
... status | Domain status | text64 | |
... price | Incurred expenses of the domain action | float | |
... invoice | Invoice id | text64 | |
... remoteAddr | Ip address of executing client | ip | |
... userText | Domain action description | text255 | |
... logId | ID of the log entry | int |
Get changes of domain prices.
Table 2.122. Parameters
Parameter | Description | Type | Optional |
---|---|---|---|
futureChanges | |||
... tld | Top level domain name | text64 | |
... affectsCustomer | Customer has active domains for the TLD | boolean | |
... currency | Currency of the price | text10 | |
... changeDate | Date of the price's change | dateTime | |
... createPrice | Domain registration price/year | float | |
... monthlyCreatePrice | Domain registration price/month | float | Yes |
... transferPrice | Domain transfer price/year | float | |
... renewalPrice | Domain renewal price/year | float | |
... monthlyRenewalPrice | Domain renewal price/month | float | Yes |
... updatePrice | Domain update price | float | |
... tradePrice | Domain trade price | float | Yes |
... trusteePrice | Domain trustee service price/year | float | Yes |
... monthlyTrusteePrice | Domain trustee service price/month | float | Yes |
... restorePrice | Domain restore price | float | Yes |
pastChanges | |||
... tld | Top level domain name | text64 | |
... currency | Currency of the price | text10 | |
... changeDate | Date of the price's change | dateTime | |
... createPrice | Domain registration price/year | float | |
... monthlyCreatePrice | Domain registration price/month | float | Yes |
... transferPrice | Domain transfer price/year | float | |
... renewalPrice | Domain renewal price/year | float | |
... monthlyRenewalPrice | Domain renewal price/month | float | Yes |
... updatePrice | Domain update price | float | |
... tradePrice | Domain trade price | float | Yes |
... trusteePrice | Domain trustee service price/year | float | Yes |
... monthlyTrusteePrice | Domain trustee service price/month | float | Yes |
... restorePrice | Domain restore price | float | Yes |
Manual domain renewal.
Table 2.125. Parameters
Parameter | Description | Type | Optional |
---|---|---|---|
roId | Id (Repository Object Identifier) of the domain | int | |
price | Incurred expenses | float | |
currency | Currency related to price value | customercurrency | |
exDate | Time of domain expiration | dateTime | |
reDate | Time of next domain renewal | dateTime |
Restores an expired/deleted domain (if supported).
Table 2.126. Parameters
Parameter | Description | Type | Required | Default |
---|---|---|---|---|
domain | Domain name | token255 | true | |
renewalMode | Domain renewal mode | renewalMode | false | |
testing | Execute command in testing mode | boolean | false | false |
Get registered domain TLD statistics.
Table 2.128. Parameters
Parameter | Description | Type | Optional |
---|---|---|---|
tld | Yes | ||
... count | Total number of registered TLD | int |
Change domain owner (if supported).
Table 2.129. Parameters
Parameter | Description | Type | Required | Default |
---|---|---|---|---|
domain | Domain name | token255 | true | |
registrant | New domain owner contact handle id | int | true | |
admin | New administrative contact handle id | int | false | |
tech | New technical contact handle id | int | false | |
billing | New billing contact handle id | int | false | |
ns | List of nameserver | nsList | false | |
authCode | Authorization code (if supported) | token255 | false | |
whoisProvider | Whois provider | token0255 | false | |
whoisUrl | Whois url | token0255 | false | |
scDate | Scheduled execution date | timestamp | false | |
extData | Domain trade extra data | extData | false | |
asynchron | Asynchron domain trade | boolean | false | false |
testing | Execute command in testing mode | boolean | false | false |
Table 2.130. Parameters
Parameter | Description | Type | Optional |
---|---|---|---|
roId | Id (Repository Object Identifier) of the domain | int | |
price | Incurred expenses | float | |
currency | Currency related to price value | customercurrency | |
notifications | Information about not required contact types | array | Yes |
Transfer domain from another registrar or user to you.
Table 2.131. Parameters
Parameter | Description | Type | Required | Default |
---|---|---|---|---|
domain | Domain name | token255 | true | |
registrant | Domain owner contact handle id | int | false | |
admin | Domain administrative contact handle id | int | false | |
tech | Domain technical contact handle id | int | false | |
billing | Domain billing contact handle id | int | false | |
ns | List of nameserver | nsList | false | |
nsTakeover | Keep existing nameservers | boolean | false | false |
contactTakeover | Transfer also data related to the transfered gTLD | boolean | false | false |
transferLock | Lock domain | boolean | false | 1 |
authCode | Authorization code (if supported) | token255 | false | |
renewalMode | Domain renewal mode | renewalMode | false | |
whoisProvider | Whois provider | token0255 | false | |
whoisUrl | Whois url | token0255 | false | |
extData | Domain extra data | extData | false | |
scDate | Time of scheduled execution | timestamp | false | |
asynchron | Asynchron domain transfer | boolean | false | false |
voucher | Voucher code | text64 | false | |
testing | Execute command in testing mode | boolean | false | false |
Table 2.132. Parameters
Parameter | Description | Type | Optional |
---|---|---|---|
roId | Id (Repository Object Identifier) of the domain | int | |
price | Incurred expenses | float | |
currency | Currency related to price value | customercurrency | |
notifications | Information about not required contact types | array | Yes |
Cancel the transfer of a domain to another registrar or user.
Allow or deny outgoing transfer requests.
Table 2.134. Parameters
Parameter | Description | Type | Required | Default |
---|---|---|---|---|
domain | Domain name | token255 | true | |
answer | Acknowledge or deny the domain request | transferAnswer | true | |
testing | Execute command in testing mode | boolean | false | false |
Update domain data.
Table 2.135. Parameters
Parameter | Description | Type | Required | Default |
---|---|---|---|---|
domain | Domain name | token255 | true | |
registrant | New owner contact handle id | int | false | |
admin | New administrative contact handle id | int | false | |
tech | New technical contact handle id | int | false | |
billing | New billing contact handle id | int | false | |
ns | List of nameserver | nsList | false | |
transferLock | Lock domain | boolean | false | |
period | Domain registration/renewal period | period | false | |
authCode | Authorization code (if supported) | token255 | false | |
scDate | Time of scheduled execution | timestamp | false | |
renewalMode | Domain renewal mode | renewalMode | false | |
transferMode | Domain transfer mode | transferMode | false | |
whoisProvider | Whois provider | token0255 | false | |
whoisUrl | Whois url | token0255 | false | |
extData | Domain extra data | extData | false | |
asynchron | Asynchron domain update | boolean | false | false |
testing | Execute command in testing mode | boolean | false | false |
Table 2.136. Parameters
Parameter | Description | Type | Optional |
---|---|---|---|
price | Incurred expenses | float | |
currency | Currency related to price value | customercurrency | |
notifications | Information about not required contact types | array | Yes |