API v1  |  API v2

The Dynadot API allows you to search for, register, and delete domain names programatically, using your own software and server. With version 2, you can also set name servers and renew domains in your account. This API v2 is still under development, and will probably change over the next few months. The API is available to all accounts.

Overview

Requests to the API are sent to the following url. Note that requests should be sent over https (secure socket) for security. API version 2 uses a different url path than version 1, and doesn't require a version parameter.

     https://api.dynadot.com/api2.html

Only one request can be processed at a time. So please wait for your current request to finish before sending another request. The request should have the following parameters.

Request Parameter	Explanation
key	Your key to access the API, available in your account control panel
command	'search', 'register', 'delete', 'renew', and 'set_ns'

The results are sent as a comma delimited text file. The first line is the result of the command. This line has 2 fields.

Result Field	Explanation
1	The result of this API call.   ok - the command was successful   error - the command was not successful
2	More information about the result. Only used when result is 'error'.

The second line is empty. Subsequent lines are the results of the command, for example your search results.

Search Command

If calling the search command, the following parameters should be included:

Search Request Parameter	Explanation
domain0 - domain99	The domain name you are searching for; you can specify up to 100 domains
language0 - language99(optional)	The language tag for the respective domain; only use this for IDNs

There will be one result line for each domain submitted. Each line will have 5 fields.

Search Result Field	Explanation
1	The domain parameter. For example: domain0
2	The domain name searched for. For example: mydomain.com
3	The language if any. For example: spa
4	The result of the search:   yes - the domain is available   no - the domain is not available   offline - the central registry for this domain is currently offline   system_busy - all connections are busy   over_quota - see quota details below   error - there was a syntax or registry error processing this domain
5	More information about the result. Only used when result is 'error'.

Search Example

Request

https://api.dynadot.com/api2.html?key=8S7I2s6Qd8g&
command=search&domain0=mydomain.com&domain1=mydomain.net

Response

ok,

domain0,mydomain.com,,no,
domain1,mydomain.net,,yes,

Register Command

Calling the register command will create and process a registration order. You must have enough account balance to pay for the order. If calling the register command, the following parameters should be included:

Register Request Parameter	Explanation
domain	The domain name you want to register; only one domain can be registered per request
language	The language tag for the requested domain; only needed if the domain is an IDN
duration	How long to register the domain for
option0 (if necessary)	The UK, EU, or BE registrant name
option1 (if necessary)	The UK registrant type code or EU/BE registrant organization name (optional)
option2 (if necessary)	The UK company number if required by the selected option1 UK registrant type

There will be one result line for each request submitted. Each line will have 3 fields.

Register Result Field	Explanation
1	The result of the register request:   success - the domain was successfully registered   not_available - the domain is not available   insufficient_funds - not enough account balance to process this registration   offline - the central registry for this domain is currently offline   system_busy - all connections are busy   over_quota - see quota details below   error - there was a syntax or registry error processing this request
2	More information about the result. Only used when result is 'error'.
3	Expiration date in unix time (milliseconds since midnight UTC of January 1, 1970). Only used when result is 'success'.

Register Example

Request

https://api.dynadot.com/api2.html?key=8S7I2s6Qd8g&
command=register&domain=mydomain.com&duration=1

Response

ok,

success,,1180897681932

Delete Command

Calling the delete command will delete a domain that is still in the grace period. Your account balance will be credited back the registration fee. Domains with privacy, that have been renewed, or that have been moved to a new account cannot be deleted through the API. If calling the delete command, the following parameters should be included:

Delete Request Parameter	Explanation
domain	The domain name you want to delete; only one domain can be deleted per request

There will be one result line for each request submitted. Each line will have 2 fields.

Delete Result Field	Explanation
1	The result of the delete request:   success - the domain was successfully deleted   grace_expired - the grace period has already expired   too_soon - cannot delete a domain the first hour after registration   offline - the central registry for this domain is currently offline   error - there was a syntax or registry error processing this request
2	More information about the result. Only used when result is 'error'.

Delete Example

Request

https://api.dynadot.com/api2.html?key=8S7I2s6Qd8g&
command=delete&domain=mydomain.com

Response

ok,

success,

Renew Command

Calling the renew command will create and process a renewal order. If the domain has privacy, the renew command will also renew the privacy. You must have enough account balance to pay for the order. If calling the renew command, the following parameters should be included:

Renew Request Parameter	Explanation
domain	The domain name you want to renew; only one domain can be renewed per request
duration	How many years to renew the domain for
year (optional)	The current year the domain expires

There will be one result line for each request submitted. Each line will have 3 fields.

Renew Result Field	Explanation
1	The result of the renew request:   success - the domain was successfully renewed   insufficient_funds - not enough account balance to process this renewal   offline - the central registry for this domain is currently offline   error - there was a syntax or registry error processing this request
2	More information about the result. Only used when result is 'error'.
3	Expiration date in unix time (milliseconds since midnight UTC of January 1, 1970). Only used when result is 'success'.

Renew Example

Request

https://api.dynadot.com/api2.html?key=8S7I2s6Qd8g&
command=renew&domain=mydomain.com&duration=1

Response

ok,

success,,1180897681932

Get Nameservers Command

If calling the get nameservers command, the following parameters should be included:

Set Nameservers Request Parameter	Explanation
domain	The domain that you want to get its nameservers info. Only one domain's nameservers info per request.

There will be one result line for each request submitted. Each line will have 2 fields.

Get Nameservers Result Field	Explanation
1	The result of the get nameservers request:   success - the nameservers were successfully return   offline - the central registry for this domain is currently offline   error - there was a syntax or registry error processing this request
2	The details information of the nameservers(ns0 - ns12) or more information about the result if the result is 'error'.
3	More information about the nameservers setting. Only used when result is 'success'

Get Nameservers Example

Request

https://api.dynadot.com/api2.html?key=8S7I2s6Qd8g&
command=get_ns&domain=mydomain.com

Response

ok,

success,ns1.dynadot.com,ns2.dynadot.com,,,,,,,,,,,,Dynadot Forwarding

Set Nameservers Command

If calling the set nameservers command, the following parameters should be included:

Set Nameservers Request Parameter	Explanation
domain	The domain name to update; only one domain can be set per request
ns0 - ns12	The name servers to set your domain to use; you can specify up to 13 nameservers, but they must already be in your account.

There will be one result line for each request submitted. Each line will have 2 fields.

Set Nameservers Result Field	Explanation
1	The result of the set nameservers request:   success - the nameservers were successfully set   offline - the central registry for this domain is currently offline   error - there was a syntax or registry error processing this request
2	More information about the result. Only used when result is 'error'.

Set Nameservers Example

Request

https://api.dynadot.com/api2.html?key=8S7I2s6Qd8g&
command=set_ns&domain=mydomain.com&ns0=ns1.hostns.com&ns1=ns2.hostns.com

Response

ok,

success,

Set Renew Options Command

If calling the set renew options command, the following parameters should be included:

Set Renew Options Request Parameter	Explanation
domain	The domain name to update; only one domain can be set per request
renew-option	reset - reset the domain's renew option to "no renew option" donot - set the domain's renew option to "do not renew" auto - set the domain's renew option to "auto-renew"

There will be one result line for each request submitted. Each line will have 2 fields.

Set Renew Options Result Field	Explanation
1	The result of the set renew options request:   success - the renew options were successfully set   error - there was a syntax error processing this request
2	More information about the result. Only used when result is 'error'.

Set Renew Options Example

Request

https://api.dynadot.com/api2.html?key=8S7I2s6Qd8g&
command=set_renew_option&domain=mydomain.com&renew-option=donot

Response

ok,

success,

Set Folder Command

If calling the set folder command, the following parameters should be included:

Set Folder Request Parameter	Explanation
domain	The domain name to update; only one domain can be set per request
folder	The folder name that you want to move your domain in. Use "Default" as the folder name if you want to move the domain to the default folder. Folder name is case sensitive. For example, "Folder1" and "folder1" are two different folder names.

There will be one result line for each request submitted. Each line will have 2 fields.

Set Folder Result Field	Explanation
1	The result of the set folder request:   success - the folder were successfully set   error - there was a syntax error processing this request
2	More information about the result. Only used when result is 'error'.

Set Folder Example

Request

https://api.dynadot.com/api2.html?key=8S7I2s6Qd8g&
command=set_folder&domain=mydomain.com&folder=folder1

Response

ok,

success,

Languages

Afrikaans:afr Albanian:alb Arabic:ara Aragonese:arg Armenian:arm Assamese:asm Asturian:ast Avestan:ave Awadhi:awa Azerbaijani:aze Balinese:ban Baluchi:bal Basa:bas Bashkir:bak Basque:baq Belarusian:bel Bengali:ben Bhojpuri:bho Bosnian:bos Bulgarian:bul Burmese:bur Carib:car Catalan:cat Chechen:che Chinese:chi Chinese-Simplified:zh-cn Chinese-Traditional:zh-tw Chuvash:chv Coptic:cop Corsican:cos Croatian:scr Czech:cze Danish:dan Divehi:div Dogri:doi Dutch:dut Estonian:est Faroese:fao Fijian:fij Finnish:fin French:fre Frisian:fry Gaelic:gla Georgian:geo German:ger Gondi:gon Greek:gre Gujarati:guj Hebrew:heb Hindi:hin Hungarian:hun Icelandic:ice Indic:inc Indonesian:ind Ingush:inh Irish:gle Italian:ita Japanese:jpn Javanese:jav Kashmiri:kas Kazakh:kaz Khmer:khm Kirghiz:kir Korean:kor Kurdish:kur Lao:lao Latvian:lav Lithuanian:lit Luxembourgish:ltz Macedonian:mac Malayalam:mal Malay:may Maltese:mlt Maori:mao Moldavian:mol Mongolian:mon Nepali:nep Norwegian:nor Oriya:ori Ossetian:oss Panjabi:pan Persian:per Polish:pol Portuguese:por Pushto:pus Rajasthani:raj Romanian:rum Russian:rus Samoan:smo Sanskrit:san Sardinian:srd Serbian:scc Sindhi:snd Sinhalese:sin Slovak:slo Slovenian:slv Somali:som Spanish:spa Swahili:swa Swedish:swe Syriac:syr Tajik:tgk Tamil:tam Telugu:tel Thai:tha Tibetan:tib Turkish:tur Ukrainian:ukr Urdu:urd Uzbek:uzb Vietnamese:vie Welsh:wel Yiddish:yid