Delete a domain
Deletes the specified Domain Registration Order.
path Parameters
orderIdDelete a domain › Responses
OK
actionStatusStatus code of the queued domain action.
actionStatusDescHuman-readable description of the action status.
actionTypeDescHuman-readable description of the action type.
entityIdInternal entity identifier for the domain order.
eaqIdEntity action queue identifier for tracking the operation.
actionTypeAction type code for the queued operation.
currentActiondescriptionFree-text description of the action or domain row.
statusOverall operation status (for example, Success or Failed).
messageAdditional status or error message from the operation.
Register a new domain
Registers a domain name.
Register a new domain › Request Body
domainNameDomain name that you need to Register. For an Internationalized Domain Name, refer to the supported character sets per TLD (.ASIA, .BIZ, .CA, .CO, .COM/.NET, .DE, .ES, .EU, .IN.NET, .INFO, .NAME, .ORG, .PW, .TEL, CentralNic IDN TLDs, etc.). The domain name may be provided in Unicode (native language) or Punycode format.
yearsNumber of years for which you wish to Register this domain name. Note: .AI domains can only be registered for 2 years.
nsThe Name Servers of the domain name. Submitted as repeatable form field ns.
customerIdThe Customer for whom you wish to Register this domain name.
regContactIdThe Registrant Contact of the domain name.
adminContactIdThe Administrative Contact of the domain name. Note: Pass -1 for .EU, .RU, .UK.
techContactIdThe Technical Contact of the domain name. Note: Pass -1 for .EU, .FR, .RU, .UK.
billingContactIdThe Billing Contact of the domain name. Note: Pass -1 for .AT, .BERLIN, .CA, .EU, .FR, .NL, .NZ, .RU, .UK, .LONDON.
invoiceOptionControls how the Customer Invoice will be handled for this registration order.
Allowed values
| Value | Description |
|---|---|
| NoInvoice | No invoice; order executed immediately |
| PayInvoice | Raise invoice; pay from debit balance if sufficient, otherwise pending |
| KeepInvoice | Invoice for later payment; order executed |
| OnlyAdd | Invoice for later payment; registration pending until paid |
autoRenewEnables or disables the Auto Renewal setting for the domain name.
protectPrivacyEnables or disables the Privacy Protection setting for the domain name.
purchasePrivacyAdds the Privacy Protection service for the domain name. Not supported for .ASIA, .AT, .AU, .CA, .CL, .CN, .ORG.CO/.MIL.CO/.GOV.CO/.EDU.CO, .DE, .ES, .EU, .FR, .HN, .IN, .NL, .NZ, .PRO, .RU, .SX, .TEL, .UK, .US.
purchasePremiumDnsPurchase Premium DNS service.
Optional TLD-specific and phase-specific extra details. Each entry is a name/value pair for extensions such as IDN language codes, sunrise phase, or registry premium flags.
Supported attribute keys
- idnLanguageCode — IDN language code for the character set; codes vary by TLD (e.g. ko, de, latin).
- phase — Registration phase for sunrise, prega, or landrush.
Allowed values
| Value | Description |
|---|---|
| sunrise | Sunrise phase registration — requires smd attribute |
| prega | Regular pre-registration phase |
| landrush | Priority pre-registration (landrush) phase |
- smd — Content of the SMD file (sunrise phase).
- tm-claim — Trademark claim acceptance — use value accepted.
- cedcontactid — .ASIA Charter Eligibility Declaration Contact ID (Admin, Technical, Billing, or Registrant contact ID).
- id-type — .AU eligibility ID type.
Allowed values
| Value | Description |
|---|---|
| ACN | Australian Company Number |
| ABN | Australian Business Number |
| VIC BN | Victoria Business Number |
| NSW BN | New South Wales Business Number |
| SA BN | South Australia Business Number |
| NT BN | Northern Territory Business Number |
| WA BN | Western Australia Business Number |
| TAS BN | Tasmania Business Number |
| ACT BN | Australian Capital Territory Business Number |
| QLD BN | Queensland Business Number |
| TM | Trademark |
| ARBN | Australian Registered Body Number |
| Other | Other eligibility ID type — requires eligibilityType |
- id — .AU eligibility ID matching the selected id-type (number or string).
- policyReason — .AU eligibility reason when registering an .AU domain.
Allowed values
| Value | Description |
|---|---|
| 1 | Exact match, abbreviation, or acronym of domain name |
| 2 | Close and substantial connection to the domain name |
- isAUWarranty — .AU registrant warranty acceptance — must be true when sent.
Allowed values
| Value | Description |
|---|---|
| true | True |
| false | False |
- eligibilityType — .AU eligibility type — required for Trademark/Other id-type (e.g. Trademark Owner or Pending TM Owner, Other).
- eligibilityName — .AU eligibility name (company name) — required for Trademark id-type.
- registrantName — .AU registrant name — required for certain BN/Trademark/Other id-types; must be an individual proprietor.
- organisationId — .BR tax/organisation ID (CPF for individual, CNPJ for company).
- cnhosting — .CN hosting in China — true when domain will be hosted in China.
- cnhostingclause — .CN hosting terms acceptance — yes when registrant agrees.
- tnc — Terms and conditions acceptance — Y/y for European registrant data-sharing or gTLD TNC.
- intended-use — .QUEBEC / .SCOT intended use description (e.g. commercial use).
- whois-type — .TEL whois type for registrant.
Allowed values
| Value | Description |
|---|---|
| Natural | Individual registrant |
| Legal | Organization registrant |
- publish — .TEL publish contact details in WHOIS (required when whois-type is Natural).
Allowed values
| Value | Description |
|---|---|
| Y | Publish contact details in WHOIS |
| N | Do not publish contact details in WHOIS (required when whois-type is Natural) |
- service-contact — .UK service contact ID for non-UK registrant on 2nd level .UK domains.
- regulatorybody — Regulatory body for professional TLDs (.LAWYER, .DENTIST, etc.) when offering professional services.
- registrant-org-consent — Registrant organization consent for gTLDs with registrant organization value.
- premium — Registry premium domain registration — true.
Allowed values
| Value | Description |
|---|---|
| true | True |
| false | False |
- eap — Early Access Program registration — true.
Allowed values
| Value | Description |
|---|---|
| true | True |
| false | False |
Register a new domain › Responses
OK
actionStatusWorkflow status of the registration action.
actionStatusDescHuman-readable registration action status.
actionTypeDescHuman-readable description of the registration action type.
entityIdEntity identifier for the domain order.
eaqIdEAQ identifier for the registration action.
actionTypeRegistration action type key.
currentActionCurrent action identifier when present in the response.
descriptionRegistered domain name.
statusOverall workflow status (for example Success or PendingDomainVerification).
customerIdCustomer identifier for the registration.
orderIdDomain registration order identifier.
invoiceIdInvoice identifier when billing applies.
sellingAmountSelling amount for the registration.
unutilisedSellingAmountUnutilised selling amount for the registration.
sellingCurrencySymbolCurrency symbol for selling amounts.
errorAdvisory workflow message when the order is accepted but processing is delayed; not an HTTP error indicator.
Nested privacy protection purchase details when applicable.
Renew a domain
Renews the specified Domain Registration Order for specified number of years.
path Parameters
orderIdRenew a domain › Request Body
yearsNumber of years for which you want to Renew this Order. Note: .AI domains can only be renewed for 2 years.
expDateCurrent Expiry Date of the Order in UNIX epoch time format.
invoiceOptionControls how the Customer Invoice will be handled.
autoRenewEnables or disables the Auto Renewal setting for the domain name.
purchasePrivacyRenews the Privacy Protection service for the domain name. Not supported for .ASIA, .AT, .AU, .CA, .CN, .ORG.CO/.MIL.CO/.GOV.CO/.EDU.CO, .DE, .ES, .EU, .HN, .IN, .NL, .NZ, .PRO, .RU, .SX, .TEL, .UK, .US.
purchasePremiumDnsPurchase Premium DNS Service.
premiumRegistry premium domain renewal. Set to true when renewing a registry premium domain.
Renew a domain › Responses
OK
actionStatusStatus code of the queued domain action.
actionStatusDescHuman-readable description of the action status.
actionTypeDescHuman-readable description of the action type.
entityIdInternal entity identifier for the domain order.
eaqIdEntity action queue identifier for tracking the operation.
actionTypeAction type code for the queued operation.
currentActiondescriptionFree-text description of the action or domain row.
statusOverall operation status (for example, Success or Failed).
messageAdditional status or error message from the operation.
expiryDateHuman-readable or formatted domain expiry date after renewal.
fromAutoRenewWhether the renewal was triggered by the auto-renew scheduler.
isAutoRenewWhether automatic renewal is enabled for the domain order.
noOfYearsRegistration or renewal period in years.
sendInvoiceMailWhether an invoice email should be sent after renewal.
customerIddomainNamecustomerCostorderIdinvoiceIdnetCustomerCostendTimeRestore an expired domain
Returns the result of the domain operation, including action tracking metadata.
path Parameters
orderIdRestore an expired domain › Request Body
invoiceOptionControls how the Customer Invoice will be handled.
Restore an expired domain › Responses
OK
actionStatusStatus code of the queued domain action.
actionStatusDescHuman-readable description of the action status.
actionTypeDescHuman-readable description of the action type.
entityIdInternal entity identifier for the domain order.
eaqIdEntity action queue identifier for tracking the operation.
actionTypeAction type code for the queued operation.
currentActiondescriptionFree-text description of the action or domain row.
statusOverall operation status (for example, Success or Failed).
messageAdditional status or error message from the operation.