Revision as of 10:21, 20 October 2014

Domain Name Registration API

Public API to manage domain name registration records including domain availability check, domain registration, renewal, transfer, whois editing, name server changes, host record creation, locking, additional features, special; registration attributes, domain security, supported TLDs and more.

download this selection of articles as a PDF book

Top level domains

Get a list of available tlds

• GET /domains/tlds - Get a list of available tlds.

Get a list of registry agreements

• GET /domains/tlds/registryagreement - Get a list of registry agreements

Get the additional TLD parameters

• GET /domains/tlds/{tld}/extparams - Get info on the extra parameters (if any) for the tld

Domain Name Availability Check

Check availability of a domain

• GET /domains/{domainName} - Check a domain name for availability

Name suggestions search (Name Spinner)

• GET /domains/{domainName}/namespinner - Get availability results for suggested names

Domain Name Transfers

Check transferability of a domain

• GET /domains/{domainName}/transfer - Check a domain name for transferability

Get status of pending transfer

• GET /accounts/{accountNumber}/domains/transfer/{domainName} - Check transfer status for a domain

Reset/Retry domain transfer

• PUT /accounts/{accountNumber}/domains/transfer/{domainName} - Reset a domain transfer that is blocked for various reasons

Ordering domain

Ordering API

• Ordering Domain - Order domain name using the Ordering API
• Ordering Transfer Domain - Order transfer domain name using the Ordering API

Order domain shortcut

Register

• PUT /accounts/{accountId}/domains/{domainName} - Order domain name for an existing account using the "shortcut" command

Transfer

• PUT /accounts/{accountId}/domains/{domainName} - Order transfer domain name for an existing account using the "shortcut" command

Domain Name Management

Search for domains in account

• GET /accounts/{accountNumber}/domains - Search for domains in client's account.

Get domain details

• GET /domains/{domainName}/details - Get information about the given domain name such as creation date, name servers, lock status and whois info.

Lock / Unlock

• GET /domains/{domainName}/lock - Get the current lock status of a domain name
• PUT /domains/{domainName}/lock - Place a lock on a domain name that prevents unauthorized transfer or changes
• DELETE /domains/{domainName}/lock - Remove a lock on a domain

Hold / Unhold

• GET /domains/{domainName}/hold - Get the current domain hold status.
• PUT /domains/{domainName}/hold - Place a hold on a domain name that prevents the domain from resolving
• DELETE /domains/{domainName}/hold - Remove a hold on a domain

Name Servers

• GET /domains/{domainName}/nameservers - Get the name servers used to serve the DNS of the domain
• PUT /domains/{domainName}/nameservers - Change the name servers used to serve the DNS of the domain

Whois contacts

• GET /domains/{domainName}/{contactType} - Gets the contact info for the specified contact
• PUT /domains/{domainName}/{contactType} - Changes the contact info of a domain name

Domain authorization code

• GET /domains/{domainName}/authInfo - Gets the authorization code (authInfo).
• PUT /domains/{domainName}/authInfo - Sets or generates the authorization info

Auto-renewal status

• GET /domains/{domainName}/autoRenew - Gets the current auto-renewal status
• PUT /domains/{domainName}/autoRenew - Sets the auto-renewal status
• OPTIONS /domains/{domainName}/autoRenew - Check whether the auto-renewal status can be set.

Domain hosts

• GET /domains/{domainName}/hosts - Gets the current hosts
• PUT /domains/{domainName}/hosts - Replace the hosts
• POST /domains/{domainName}/hosts - Add or update hosts
• DELETE /domains/{domainName}/hosts/{hostName} - Delete a host

Domain contact verification

• GET /domains/{domainName}/contactverification - Gets the status of the contact verification for {domainName} or Send email contact verification for {domainName}

Private registration

• GET /domains/{domainName}/privateregistration - Gets the privateregistration info for the domain
• POST /domains/{domainName}/privateregistration - Update the privateregistration - change forwarding e-mail address, upgrade or downgrade between "full" and "light" version of the privateregistration product.
• DELETE /domains/{domainName}/privateregistration - Remove the privateregistration

Renew Domain

• GET /domains/{domainName}/renewTerms - get available renewal terms and pricing
• POST /domains/{domainName}/renew - renew a domain for a specific registration period

Domain Pricing

• GET /domains/{domainName}/prices - get domain prices
• GET /domains/{domainName}/prices/register - get domain register prices
• GET /domains/{domainName}/prices/renew - get domain renew prices
• GET /domains/{domainName}/prices/transfer - get domain transfer prices

Private Registration Availability By TLD

• GET /domains/privateregistration - Is private registration available for tld's

See also

• Common Features