API
ListDomains
ListDomains returns all domains in the account. It omits some information that can be retrieved from GetDomain.
Endpoint: GET /v4/domains
Parameters:
perPage
int32
Per Page is the number of records to return per request. Per Page defaults to 1,000.
page
int32
Page is which page to return
Response:
nextPage
int32
NextPage is the identifier for the next page of results. It is only populated if there is another page of results after the current page.
lastPage
int32
LastPage is the identifier for the final page of results. It is only populated if there is another page of results after the current page.
Example:
curl -u 'username:token' 'https://api.dev.name.com/v4/domains'
{
"domains": [
{
"domainName": "example.org",
"locked": true,
"autorenewEnabled": true,
"expireDate": "2018-11-13T22:58:35Z",
"createDate": "2017-11-13T22:58:35Z"
}
]
}
GetDomain
GetDomain returns details about a specific domain
Endpoint: GET /v4/domains/{domainName}
Parameters:
domainName
(path parameters)
string
DomainName is the domain to retrieve.
Response:
domainName
string
DomainName is the punycode encoded value of the domain name.
nameservers
[]string
Nameservers is the list of nameservers for this domain. If unspecified it defaults to your account default nameservers.
privacyEnabled
bool
PrivacyEnabled reflects if Whois Privacy is enabled for this domain.
locked
bool
Locked indicates that the domain cannot be transferred to another registrar.
autorenewEnabled
bool
AutorenewEnabled indicates if the domain will attempt to renew automatically before expiration.
expireDate
(read only)
string
ExpireDate is the date the domain will expire.
createDate
(read only)
string
CreateDate is the date the domain was created at the registry.
renewalPrice
(read only)
float64
RenewalPrice is the price to renew the domain. It may be required for the RenewDomain command.
Example:
curl -u 'username:token' 'https://api.dev.name.com/v4/domains/example.org'
{
"domainName": "example.org",
"nameservers": [
"ns1.name.com",
"ns2.name.com"
],
"contacts": {
"registrant": {
"firstName": "Jane",
"lastName": "Doe",
"address1": "123 Main St.",
"city": "Denver",
"state": "CO",
"country": "US",
"phone": "+1.3035551212",
"email": "admin@example.net"
},
"admin": {
"firstName": "Jane",
"lastName": "Doe",
"address1": "123 Main St.",
"city": "Denver",
"state": "CO",
"country": "US",
"phone": "+1.3035551212",
"email": "admin@example.net"
},
"tech": {
"firstName": "Jane",
"lastName": "Doe",
"address1": "123 Main St.",
"city": "Denver",
"state": "CO",
"country": "US",
"phone": "+1.3035551212",
"email": "admin@example.net"
},
"billing": {
"firstName": "Jane",
"lastName": "Doe",
"address1": "123 Main St.",
"city": "Denver",
"state": "CO",
"country": "US",
"phone": "+1.3035551212",
"email": "admin@example.net"
}
},
"privacyEnabled": true,
"locked": true,
"autorenewEnabled": true,
"expireDate": "2018-11-13T22:58:35Z",
"createDate": "2017-11-13T22:58:35Z",
"renewalPrice": 12.99
}
CreateDomain
CreateDomain purchases a new domain. Domains that are not regularly priced require the purchase_price field to be specified.
Endpoint: POST /v4/domains
Parameters:
domain
*Domain
(Model Definition)
Domain is the domain object to create. If privacy_enabled is set, Whois Privacy will also be purchased for an additional amount.
purchasePrice
float64
PurchasePrice is the amount to pay for the domain. If privacy_enabled is set, the regular price for whois protection will be added automatically. If VAT tax applies, it will also be added automatically. PurchasePrice is required if purchase_type is not "registration" or if it is a premium domain.
purchaseType
string
PurchaseType defaults to "registration" but should be copied from the result of a search command otherwise.
years
int32
Years is for how many years to register the domain for. Years defaults to 1 if not passed and cannot be more than 10. If passing purchase_price make sure to adjust it accordingly.
tldRequirements
map[string]string
TLDRequirements is a way to pass additional data that is required by some registries.
promoCode
string
PromoCode is not yet implemented.
Response:
order
int32
Order is an identifier for this purchase.
totalPaid
float64
TotalPaid is the total amount paid, including VAT and whois protection.
Example:
curl -u 'username:token' 'https://api.dev.name.com/v4/domains' -X POST -H 'Content-Type: application/json' --data '{"domain":{"domainName":"example.org"},"purchasePrice":12.99}'
{
"domain": {
"domainName": "example.org",
"nameservers": [
"ns1.name.com",
"ns2.name.com"
],
"contacts": {
"registrant": {
"firstName": "Jane",
"lastName": "Doe",
"address1": "123 Main St.",
"city": "Denver",
"state": "CO",
"country": "US",
"phone": "+1.3035551212"
},
"admin": {
"firstName": "Jane",
"lastName": "Doe",
"address1": "123 Main St.",
"city": "Denver",
"state": "CO",
"country": "US",
"phone": "+1.3035551212"
},
"tech": {
"firstName": "Jane",
"lastName": "Doe",
"address1": "123 Main St.",
"city": "Denver",
"state": "CO",
"country": "US",
"phone": "+1.3035551212"
},
"billing": {
"firstName": "Jane",
"lastName": "Doe",
"address1": "123 Main St.",
"city": "Denver",
"state": "CO",
"country": "US",
"phone": "+1.3035551212"
}
},
"locked": true,
"autorenewEnabled": true,
"expireDate": "2018-11-13T22:58:35Z",
"createDate": "2017-11-13T22:58:35Z",
"renewalPrice": 12.99
},
"order": 123456,
"totalPaid": 12.99
}
EnableWhoisPrivacy
EnableWhoisPrivacy enables the domain to be private
Endpoint: POST /v4/domains/{domainName}:enableWhoisPrivacy
Parameters:
domainName
(path parameters)
string
DomainName is the domain name to enable whoisprivacy for.
Response:
domainName
string
DomainName is the punycode encoded value of the domain name.
nameservers
[]string
Nameservers is the list of nameservers for this domain. If unspecified it defaults to your account default nameservers.
privacyEnabled
bool
PrivacyEnabled reflects if Whois Privacy is enabled for this domain.
locked
bool
Locked indicates that the domain cannot be transferred to another registrar.
autorenewEnabled
bool
AutorenewEnabled indicates if the domain will attempt to renew automatically before expiration.
expireDate
(read only)
string
ExpireDate is the date the domain will expire.
createDate
(read only)
string
CreateDate is the date the domain was created at the registry.
renewalPrice
(read only)
float64
RenewalPrice is the price to renew the domain. It may be required for the RenewDomain command.
Example:
curl -u 'username:token' 'https://api.dev.name.com/v4/domains/example.org:enableWhoisPrivacy' -X POST -H 'Content-Type: application/json'
{
"domainName": "example.org",
"nameservers": [
"ns1.name.com",
"ns2.name.com"
],
"contacts": {
"registrant": {
"firstName": "Jane",
"lastName": "Doe",
"address1": "123 Main St.",
"city": "Denver",
"state": "CO",
"country": "US",
"phone": "+1.3035551212",
"email": "admin@example.net"
},
"admin": {
"firstName": "Jane",
"lastName": "Doe",
"address1": "123 Main St.",
"city": "Denver",
"state": "CO",
"country": "US",
"phone": "+1.3035551212",
"email": "admin@example.net"
},
"tech": {
"firstName": "Jane",
"lastName": "Doe",
"address1": "123 Main St.",
"city": "Denver",
"state": "CO",
"country": "US",
"phone": "+1.3035551212",
"email": "admin@example.net"
},
"billing": {
"firstName": "Jane",
"lastName": "Doe",
"address1": "123 Main St.",
"city": "Denver",
"state": "CO",
"country": "US",
"phone": "+1.3035551212",
"email": "admin@example.net"
}
},
"privacyEnabled": true,
"locked": true,
"autorenewEnabled": true,
"expireDate": "2018-11-13T22:58:35Z",
"createDate": "2017-11-13T22:58:35Z",
"renewalPrice": 12.99
}
DisableWhoisPrivacy
DisableWhoisPrivacy disables domain privacy
Endpoint: POST /v4/domains/{domainName}:disableWhoisPrivacy
Parameters:
domainName
(path parameters)
string
DomainName is the domain name to disable whoisprivacy for.
Response:
domainName
string
DomainName is the punycode encoded value of the domain name.
nameservers
[]string
Nameservers is the list of nameservers for this domain. If unspecified it defaults to your account default nameservers.
privacyEnabled
bool
PrivacyEnabled reflects if Whois Privacy is enabled for this domain.
locked
bool
Locked indicates that the domain cannot be transferred to another registrar.
autorenewEnabled
bool
AutorenewEnabled indicates if the domain will attempt to renew automatically before expiration.
expireDate
(read only)
string
ExpireDate is the date the domain will expire.
createDate
(read only)
string
CreateDate is the date the domain was created at the registry.
renewalPrice
(read only)
float64
RenewalPrice is the price to renew the domain. It may be required for the RenewDomain command.
Example:
curl -u 'username:token' 'https://api.dev.name.com/v4/domains/example.org:disableWhoisPrivacy' -X POST -H 'Content-Type: application/json'
{
"domainName": "example.org",
"nameservers": [
"ns1.name.com",
"ns2.name.com"
],
"contacts": {
"registrant": {
"firstName": "Jane",
"lastName": "Doe",
"address1": "123 Main St.",
"city": "Denver",
"state": "CO",
"country": "US",
"phone": "+1.3035551212",
"email": "admin@example.net"
},
"admin": {
"firstName": "Jane",
"lastName": "Doe",
"address1": "123 Main St.",
"city": "Denver",
"state": "CO",
"country": "US",
"phone": "+1.3035551212",
"email": "admin@example.net"
},
"tech": {
"firstName": "Jane",
"lastName": "Doe",
"address1": "123 Main St.",
"city": "Denver",
"state": "CO",
"country": "US",
"phone": "+1.3035551212",
"email": "admin@example.net"
},
"billing": {
"firstName": "Jane",
"lastName": "Doe",
"address1": "123 Main St.",
"city": "Denver",
"state": "CO",
"country": "US",
"phone": "+1.3035551212",
"email": "admin@example.net"
}
},
"privacyEnabled": true,
"locked": true,
"autorenewEnabled": true,
"expireDate": "2018-11-13T22:58:35Z",
"createDate": "2017-11-13T22:58:35Z",
"renewalPrice": 12.99
}
EnableAutorenew
EnableAutorenew enables the domain to be automatically renewed when it gets close to expiring.
Endpoint: POST /v4/domains/{domainName}:enableAutorenew
Parameters:
domainName
(path parameters)
string
DomainName is the domain name to enable autorenew for.
Response:
domainName
string
DomainName is the punycode encoded value of the domain name.
nameservers
[]string
Nameservers is the list of nameservers for this domain. If unspecified it defaults to your account default nameservers.
privacyEnabled
bool
PrivacyEnabled reflects if Whois Privacy is enabled for this domain.
locked
bool
Locked indicates that the domain cannot be transferred to another registrar.
autorenewEnabled
bool
AutorenewEnabled indicates if the domain will attempt to renew automatically before expiration.
expireDate
(read only)
string
ExpireDate is the date the domain will expire.
createDate
(read only)
string
CreateDate is the date the domain was created at the registry.
renewalPrice
(read only)
float64
RenewalPrice is the price to renew the domain. It may be required for the RenewDomain command.
Example:
curl -u 'username:token' 'https://api.dev.name.com/v4/domains/example.org:enableAutorenew' -X POST -H 'Content-Type: application/json'
{
"domainName": "example.org",
"nameservers": [
"ns1.name.com",
"ns2.name.com"
],
"contacts": {
"registrant": {
"firstName": "Jane",
"lastName": "Doe",
"address1": "123 Main St.",
"city": "Denver",
"state": "CO",
"country": "US",
"phone": "+1.3035551212",
"email": "admin@example.net"
},
"admin": {
"firstName": "Jane",
"lastName": "Doe",
"address1": "123 Main St.",
"city": "Denver",
"state": "CO",
"country": "US",
"phone": "+1.3035551212",
"email": "admin@example.net"
},
"tech": {
"firstName": "Jane",
"lastName": "Doe",
"address1": "123 Main St.",
"city": "Denver",
"state": "CO",
"country": "US",
"phone": "+1.3035551212",
"email": "admin@example.net"
},
"billing": {
"firstName": "Jane",
"lastName": "Doe",
"address1": "123 Main St.",
"city": "Denver",
"state": "CO",
"country": "US",
"phone": "+1.3035551212",
"email": "admin@example.net"
}
},
"privacyEnabled": true,
"locked": true,
"autorenewEnabled": true,
"expireDate": "2018-11-13T22:58:35Z",
"createDate": "2017-11-13T22:58:35Z",
"renewalPrice": 12.99
}
DisableAutorenew
DisableAutorenew disables automatic renewals, thus requiring the domain to be renewed manually.
Endpoint: POST /v4/domains/{domainName}:disableAutorenew
Parameters:
domainName
(path parameters)
string
DomainName is the domain name to disable autorenew for.
Response:
domainName
string
DomainName is the punycode encoded value of the domain name.
nameservers
[]string
Nameservers is the list of nameservers for this domain. If unspecified it defaults to your account default nameservers.
privacyEnabled
bool
PrivacyEnabled reflects if Whois Privacy is enabled for this domain.
locked
bool
Locked indicates that the domain cannot be transferred to another registrar.
autorenewEnabled
bool
AutorenewEnabled indicates if the domain will attempt to renew automatically before expiration.
expireDate
(read only)
string
ExpireDate is the date the domain will expire.
createDate
(read only)
string
CreateDate is the date the domain was created at the registry.
renewalPrice
(read only)
float64
RenewalPrice is the price to renew the domain. It may be required for the RenewDomain command.
Example:
curl -u 'username:token' 'https://api.dev.name.com/v4/domains/example.org:disableAutorenew' -X POST -H 'Content-Type: application/json'
{
"domainName": "example.org",
"nameservers": [
"ns1.name.com",
"ns2.name.com"
],
"contacts": {
"registrant": {
"firstName": "Jane",
"lastName": "Doe",
"address1": "123 Main St.",
"city": "Denver",
"state": "CO",
"country": "US",
"phone": "+1.3035551212",
"email": "admin@example.net"
},
"admin": {
"firstName": "Jane",
"lastName": "Doe",
"address1": "123 Main St.",
"city": "Denver",
"state": "CO",
"country": "US",
"phone": "+1.3035551212",
"email": "admin@example.net"
},
"tech": {
"firstName": "Jane",
"lastName": "Doe",
"address1": "123 Main St.",
"city": "Denver",
"state": "CO",
"country": "US",
"phone": "+1.3035551212",
"email": "admin@example.net"
},
"billing": {
"firstName": "Jane",
"lastName": "Doe",
"address1": "123 Main St.",
"city": "Denver",
"state": "CO",
"country": "US",
"phone": "+1.3035551212",
"email": "admin@example.net"
}
},
"privacyEnabled": true,
"locked": true,
"autorenewEnabled": true,
"expireDate": "2018-11-13T22:58:35Z",
"createDate": "2017-11-13T22:58:35Z",
"renewalPrice": 12.99
}
RenewDomain
RenewDomain will renew a domain. Purchase_price is required if the renewal is not regularly priced.
Endpoint: POST /v4/domains/{domainName}:renew
Parameters:
domainName
(path parameters)
string
DomainName is the domain to renew.
purchasePrice
float64
PurchasePrice is the amount to pay for the domain renewal. If VAT tax applies, it will also be added automatically. PurchasePrice is required if this is a premium domain.
years
int32
Years is for how many years to renew the domain for. Years defaults to 1 if not passed and cannot be more than 10.
promoCode
string
PromoCode is not yet implemented.
Response:
order
int32
Order is an identifier for this purchase
totalPaid
float64
TotalPaid is the total amount paid, including VAT.
Example:
curl -u 'username:token' 'https://api.dev.name.com/v4/domains/example.org:renew' -X POST -H 'Content-Type: application/json' --data '{"purchasePrice":12.99}'
{
"domain": {
"domainName": "example.org",
"nameservers": [
"ns1.name.com",
"ns2.name.com"
],
"contacts": {
"registrant": {
"firstName": "Jane",
"lastName": "Doe",
"address1": "123 Main St.",
"city": "Denver",
"state": "CO",
"country": "US",
"phone": "+1.3035551212"
},
"admin": {
"firstName": "Jane",
"lastName": "Doe",
"address1": "123 Main St.",
"city": "Denver",
"state": "CO",
"country": "US",
"phone": "+1.3035551212"
},
"tech": {
"firstName": "Jane",
"lastName": "Doe",
"address1": "123 Main St.",
"city": "Denver",
"state": "CO",
"country": "US",
"phone": "+1.3035551212"
},
"billing": {
"firstName": "Jane",
"lastName": "Doe",
"address1": "123 Main St.",
"city": "Denver",
"state": "CO",
"country": "US",
"phone": "+1.3035551212"
}
},
"locked": true,
"autorenewEnabled": true,
"expireDate": "2019-11-13T22:58:35Z",
"createDate": "2017-11-13T22:58:35Z",
"renewalPrice": 12.99
},
"order": 123456,
"totalPaid": 12.99
}
GetPricingForDomain
GetDomainPricing returns pricing of a taken or available domain.
Endpoint: GET /v4/domains/{domainName}:getPricing
Parameters:
domainName
(path parameters)
string
DomainName is the domain to retrieve.
years
int32
Years is for how many years to get pricing for the domain. Years defaults to 1 if not passed and cannot be more than 10.
Response:
purchasePrice
float64
PurchasePrice is the price you will pay to register a domain. Can be passed in the CreateDomain request.
renewalPrice
float64
RenewalPrice is the price you will pay to renew a domain. Can be passed in the RenewDomain request.
transferPrice
float64
TransferPrice is the price you will pay to transfer a domain. Can be passed in the CreateTransfer request. The TransferPrice is always for 1 year regardless of the years input.
premium
bool
Premium indicates that this pricing is a premium result and the respective prices must be passed in create, renew or transfer commands.
Example:
curl -u 'username:token' 'https://api.dev.name.com/v4/domains/example.org:getPricing'
{
"purchasePrice": 4.9900000000000002,
"renewalPrice": 4.9900000000000002,
"transferPrice": 4.9900000000000002
}
GetAuthCodeForDomain
GetAuthCodeForDomain returns the Transfer Authorization Code for the domain.
Endpoint: GET /v4/domains/{domainName}:getAuthCode
Parameters:
domainName
(path parameters)
string
DomainName is the domain name to retrieve the authorization code for.
Response:
authCode
string
AuthCode is the authorization code needed to transfer a domain to another registrar. If you are storing auth codes, be sure to store them in a secure manner.
Example:
curl -u 'username:token' 'https://api.dev.name.com/v4/domains/example.org:getAuthCode'
{
"authCode": "Authc0de"
}
PurchasePrivacy
PurchasePrivacy will add Whois Privacy protection to a domain or will an renew existing subscription.
Endpoint: POST /v4/domains/{domainName}:purchasePrivacy
Parameters:
domainName
(path parameters)
string
DomainName is the domain to purchase Whois Privacy for.
purchasePrice
float64
PurchasePrice is the amount you expect to pay.
years
int32
Years is the number of years you wish to purchase Whois Privacy for. Years defaults to 1 and cannot be more then the domain expiration date.
promoCode
string
PromoCode is not yet implemented
Response:
domain
Domain is the status of the domain after the purchase of Whois Privacy.
order
int32
Order is an identifier for this purchase.
totalPaid
float64
TotalPaid is the total amount paid, including VAT.
Example:
curl -u 'username:token' 'https://api.dev.name.com/v4/domains/example.org:purchasePrivacy' -X POST -H 'Content-Type: application/json' --data '{"purchasePrice":4.9900000000000002}'
{
"domain": {
"domainName": "example.org",
"nameservers": [
"ns1.name.com",
"ns2.name.com"
],
"contacts": {
"registrant": {
"firstName": "Jane",
"lastName": "Doe",
"address1": "123 Main St.",
"city": "Denver",
"state": "CO",
"country": "US",
"phone": "+1.3035551212"
},
"admin": {
"firstName": "Jane",
"lastName": "Doe",
"address1": "123 Main St.",
"city": "Denver",
"state": "CO",
"country": "US",
"phone": "+1.3035551212"
},
"tech": {
"firstName": "Jane",
"lastName": "Doe",
"address1": "123 Main St.",
"city": "Denver",
"state": "CO",
"country": "US",
"phone": "+1.3035551212"
},
"billing": {
"firstName": "Jane",
"lastName": "Doe",
"address1": "123 Main St.",
"city": "Denver",
"state": "CO",
"country": "US",
"phone": "+1.3035551212"
}
},
"privacyEnabled": true,
"locked": true,
"autorenewEnabled": true,
"expireDate": "2019-11-13T22:58:35Z",
"createDate": "2017-11-13T22:58:35Z",
"renewalPrice": 12.99
},
"order": 123456,
"totalPaid": 4.9900000000000002
}
SetNameservers
SetNameservers will set the nameservers for the Domain.
Endpoint: POST /v4/domains/{domainName}:setNameservers
Parameters:
domainName
(path parameters)
string
DomainName is the domain name to set the nameservers for.
nameservers
[]string
Namesevers is a list of the nameservers to set. Nameservers should already be set up and hosting the zone properly as some registries will verify before allowing the change.
Response:
domainName
string
DomainName is the punycode encoded value of the domain name.
nameservers
[]string
Nameservers is the list of nameservers for this domain. If unspecified it defaults to your account default nameservers.
privacyEnabled
bool
PrivacyEnabled reflects if Whois Privacy is enabled for this domain.
locked
bool
Locked indicates that the domain cannot be transferred to another registrar.
autorenewEnabled
bool
AutorenewEnabled indicates if the domain will attempt to renew automatically before expiration.
expireDate
(read only)
string
ExpireDate is the date the domain will expire.
createDate
(read only)
string
CreateDate is the date the domain was created at the registry.
renewalPrice
(read only)
float64
RenewalPrice is the price to renew the domain. It may be required for the RenewDomain command.
Example:
curl -u 'username:token' 'https://api.dev.name.com/v4/domains/example.org:setNameservers' -X POST -H 'Content-Type: application/json' --data '{"nameservers":["ns1.name.com","ns2.name.com"]}'
{
"domainName": "example.org",
"nameservers": [
"ns1.name.com",
"ns2.name.com"
],
"contacts": {
"registrant": {
"firstName": "Jane",
"lastName": "Doe",
"address1": "123 Main St.",
"city": "Denver",
"state": "CO",
"country": "US",
"phone": "+1.3035551212",
"email": "admin@example.net"
},
"admin": {
"firstName": "Jane",
"lastName": "Doe",
"address1": "123 Main St.",
"city": "Denver",
"state": "CO",
"country": "US",
"phone": "+1.3035551212",
"email": "admin@example.net"
},
"tech": {
"firstName": "Jane",
"lastName": "Doe",
"address1": "123 Main St.",
"city": "Denver",
"state": "CO",
"country": "US",
"phone": "+1.3035551212",
"email": "admin@example.net"
},
"billing": {
"firstName": "Jane",
"lastName": "Doe",
"address1": "123 Main St.",
"city": "Denver",
"state": "CO",
"country": "US",
"phone": "+1.3035551212",
"email": "admin@example.net"
}
},
"privacyEnabled": true,
"locked": true,
"autorenewEnabled": true,
"expireDate": "2018-11-13T22:58:35Z",
"createDate": "2017-11-13T22:58:35Z",
"renewalPrice": 12.99
}
SetContacts
SetContacts will set the contacts for the Domain.
Endpoint: POST /v4/domains/{domainName}:setContacts
Parameters:
domainName
(path parameters)
string
DomainName is the domain name to set the contacts for.
Response:
domainName
string
DomainName is the punycode encoded value of the domain name.
nameservers
[]string
Nameservers is the list of nameservers for this domain. If unspecified it defaults to your account default nameservers.
privacyEnabled
bool
PrivacyEnabled reflects if Whois Privacy is enabled for this domain.
locked
bool
Locked indicates that the domain cannot be transferred to another registrar.
autorenewEnabled
bool
AutorenewEnabled indicates if the domain will attempt to renew automatically before expiration.
expireDate
(read only)
string
ExpireDate is the date the domain will expire.
createDate
(read only)
string
CreateDate is the date the domain was created at the registry.
renewalPrice
(read only)
float64
RenewalPrice is the price to renew the domain. It may be required for the RenewDomain command.
Example:
curl -u 'username:token' 'https://api.dev.name.com/v4/domains/example.org:setContacts' -X POST -H 'Content-Type: application/json' --data '{"contacts":{"registrant":{"firstName":"Jane","lastName":"Doe","address1":"123 Main St.","city":"Denver","state":"CO","country":"US","phone":"+1.3035551212","email":"admin@example.net"},"admin":{"firstName":"Jane","lastName":"Doe","address1":"123 Main St.","city":"Denver","state":"CO","country":"US","phone":"+1.3035551212","email":"admin@example.net"},"tech":{"firstName":"Jane","lastName":"Doe","address1":"123 Main St.","city":"Denver","state":"CO","country":"US","phone":"+1.3035551212","email":"admin@example.net"},"billing":{"firstName":"Jane","lastName":"Doe","address1":"123 Main St.","city":"Denver","state":"CO","country":"US","phone":"+1.3035551212","email":"admin@example.net"}}}'
{
"domainName": "example.org",
"nameservers": [
"ns1.name.com",
"ns2.name.com"
],
"contacts": {
"registrant": {
"firstName": "Jane",
"lastName": "Doe",
"address1": "123 Main St.",
"city": "Denver",
"state": "CO",
"country": "US",
"phone": "+1.3035551212",
"email": "admin@example.net"
},
"admin": {
"firstName": "Jane",
"lastName": "Doe",
"address1": "123 Main St.",
"city": "Denver",
"state": "CO",
"country": "US",
"phone": "+1.3035551212",
"email": "admin@example.net"
},
"tech": {
"firstName": "Jane",
"lastName": "Doe",
"address1": "123 Main St.",
"city": "Denver",
"state": "CO",
"country": "US",
"phone": "+1.3035551212",
"email": "admin@example.net"
},
"billing": {
"firstName": "Jane",
"lastName": "Doe",
"address1": "123 Main St.",
"city": "Denver",
"state": "CO",
"country": "US",
"phone": "+1.3035551212",
"email": "admin@example.net"
}
},
"privacyEnabled": true,
"locked": true,
"autorenewEnabled": true,
"expireDate": "2018-11-13T22:58:35Z",
"createDate": "2017-11-13T22:58:35Z",
"renewalPrice": 12.99
}
LockDomain
LockDomain will lock a domain so that it cannot be transferred to another registrar.
Endpoint: POST /v4/domains/{domainName}:lock
Parameters:
domainName
(path parameters)
string
DomainName is the domain name to lock.
Response:
domainName
string
DomainName is the punycode encoded value of the domain name.
nameservers
[]string
Nameservers is the list of nameservers for this domain. If unspecified it defaults to your account default nameservers.
privacyEnabled
bool
PrivacyEnabled reflects if Whois Privacy is enabled for this domain.
locked
bool
Locked indicates that the domain cannot be transferred to another registrar.
autorenewEnabled
bool
AutorenewEnabled indicates if the domain will attempt to renew automatically before expiration.
expireDate
(read only)
string
ExpireDate is the date the domain will expire.
createDate
(read only)
string
CreateDate is the date the domain was created at the registry.
renewalPrice
(read only)
float64
RenewalPrice is the price to renew the domain. It may be required for the RenewDomain command.
Example:
curl -u 'username:token' 'https://api.dev.name.com/v4/domains/example.org:lock' -X POST -H 'Content-Type: application/json'
{
"domainName": "example.org",
"nameservers": [
"ns1.name.com",
"ns2.name.com"
],
"contacts": {
"registrant": {
"firstName": "Jane",
"lastName": "Doe",
"address1": "123 Main St.",
"city": "Denver",
"state": "CO",
"country": "US",
"phone": "+1.3035551212",
"email": "admin@example.net"
},
"admin": {
"firstName": "Jane",
"lastName": "Doe",
"address1": "123 Main St.",
"city": "Denver",
"state": "CO",
"country": "US",
"phone": "+1.3035551212",
"email": "admin@example.net"
},
"tech": {
"firstName": "Jane",
"lastName": "Doe",
"address1": "123 Main St.",
"city": "Denver",
"state": "CO",
"country": "US",
"phone": "+1.3035551212",
"email": "admin@example.net"
},
"billing": {
"firstName": "Jane",
"lastName": "Doe",
"address1": "123 Main St.",
"city": "Denver",
"state": "CO",
"country": "US",
"phone": "+1.3035551212",
"email": "admin@example.net"
}
},
"privacyEnabled": true,
"locked": true,
"autorenewEnabled": true,
"expireDate": "2018-11-13T22:58:35Z",
"createDate": "2017-11-13T22:58:35Z",
"renewalPrice": 12.99
}
UnlockDomain
UnlockDomain will unlock a domain so that it can be transferred to another registrar.
Endpoint: POST /v4/domains/{domainName}:unlock
Parameters:
domainName
(path parameters)
string
DomainName is the domain name to unlock.
Response:
domainName
string
DomainName is the punycode encoded value of the domain name.
nameservers
[]string
Nameservers is the list of nameservers for this domain. If unspecified it defaults to your account default nameservers.
privacyEnabled
bool
PrivacyEnabled reflects if Whois Privacy is enabled for this domain.
locked
bool
Locked indicates that the domain cannot be transferred to another registrar.
autorenewEnabled
bool
AutorenewEnabled indicates if the domain will attempt to renew automatically before expiration.
expireDate
(read only)
string
ExpireDate is the date the domain will expire.
createDate
(read only)
string
CreateDate is the date the domain was created at the registry.
renewalPrice
(read only)
float64
RenewalPrice is the price to renew the domain. It may be required for the RenewDomain command.
Example:
curl -u 'username:token' 'https://api.dev.name.com/v4/domains/example.org:unlock' -X POST -H 'Content-Type: application/json'
{
"domainName": "example.org",
"nameservers": [
"ns1.name.com",
"ns2.name.com"
],
"contacts": {
"registrant": {
"firstName": "Jane",
"lastName": "Doe",
"address1": "123 Main St.",
"city": "Denver",
"state": "CO",
"country": "US",
"phone": "+1.3035551212",
"email": "admin@example.net"
},
"admin": {
"firstName": "Jane",
"lastName": "Doe",
"address1": "123 Main St.",
"city": "Denver",
"state": "CO",
"country": "US",
"phone": "+1.3035551212",
"email": "admin@example.net"
},
"tech": {
"firstName": "Jane",
"lastName": "Doe",
"address1": "123 Main St.",
"city": "Denver",
"state": "CO",
"country": "US",
"phone": "+1.3035551212",
"email": "admin@example.net"
},
"billing": {
"firstName": "Jane",
"lastName": "Doe",
"address1": "123 Main St.",
"city": "Denver",
"state": "CO",
"country": "US",
"phone": "+1.3035551212",
"email": "admin@example.net"
}
},
"privacyEnabled": true,
"locked": true,
"autorenewEnabled": true,
"expireDate": "2018-11-13T22:58:35Z",
"createDate": "2017-11-13T22:58:35Z",
"renewalPrice": 12.99
}
CheckAvailability
CheckAvailability will check a list of domains to see if they are purchasable. A Maximum of 50 domains can be specified.
Endpoint: POST /v4/domains:checkAvailability
Parameters:
domainNames
[]string
DomainNames is the list of domains to check if they are available.
promoCode
string
PromoCode is not implemented yet.
Response:
results
Results of the search are returned here, the order should not be relied upon.
Example:
curl -u 'username:token' 'https://api.dev.name.com/v4/domains:checkAvailability' -X POST -H 'Content-Type: application/json' --data '{"domainNames":["example.org"]}'
{
"results": [
{
"domainName": "example.org",
"sld": "example",
"tld": "org",
"purchasable": true,
"purchasePrice": 12.99,
"purchaseType": "registration",
"renewalPrice": 12.99
}
]
}
Search
Search will perform a search for specified keywords.
Endpoint: POST /v4/domains:search
Parameters:
timeout
int32
Timeout is a value in milliseconds on how long to perform the search for. Valid timeouts are between 500ms to 5,000ms. If not specified, timeout defaults to 1,000ms. Since some additional processing is performed on the results, a response may take longer then the timeout.
keyword
string
Keyword is the search term to search for. It can be just a word, or a whole domain name.
tldFilter
[]string
TLDFilter will limit results to only contain the specified TLDs.
promoCode
string
PromoCode is not implemented yet.
Response:
results
Results of the search are returned here, the order should not be relied upon.
Example:
curl -u 'username:token' 'https://api.dev.name.com/v4/domains:search' -X POST -H 'Content-Type: application/json' --data '{"keyword":"example"}'
{
"results": [
{
"domainName": "example.org",
"sld": "example",
"tld": "org",
"purchasable": true,
"purchasePrice": 12.99,
"purchaseType": "registration",
"renewalPrice": 12.99
}
]
}
SearchStream
SearchStream will return JSON encoded SearchResults as they are received from the registry. The SearchResults are separated by newlines. This can allow clients to react to results before the search is fully completed.
Endpoint: POST /v4/domains:searchStream
Parameters:
timeout
int32
Timeout is a value in milliseconds on how long to perform the search for. Valid timeouts are between 500ms to 5,000ms. If not specified, timeout defaults to 1,000ms. Since some additional processing is performed on the results, a response may take longer then the timeout.
keyword
string
Keyword is the search term to search for. It can be just a word, or a whole domain name.
tldFilter
[]string
TLDFilter will limit results to only contain the specified TLDs.
promoCode
string
PromoCode is not implemented yet.
Response:
domainName
string
DomainName is the punycode encoding of the result domain name.
sld
string
SLD is first portion of the domain_name.
tld
string
TLD is the rest of the domain_name after the SLD.
purchasable
bool
Purchaseable indicates whether the search result is available for purchase.
premium
bool
Premium indicates that this search result is a premium result and the purchase_price needs to be passed to the DomainCreate command.
purchasePrice
float64
PurchasePrice is the price for purchasing this domain for 1 year. Purchase_price is always in USD.
purchaseType
string
PurchaseType indicates what kind of purchase this result is for. It should be passed to the DomainCreate command.
renewalPrice
float64
RenewalPrice is the annual renewal price for this domain as it may be different then the purchase_price.
Example:
curl -u 'username:token' 'https://api.dev.name.com/v4/domains:searchStream' -X POST -H 'Content-Type: application/json' --data '{"keyword":"example"}'
{
"domainName": "example.org",
"sld": "example",
"tld": "org",
"purchasable": true,
"purchasePrice": 12.99,
"purchaseType": "registration",
"renewalPrice": 12.99
}