Advanced Domain API

Advanced Domain API from Dynadot - Manage Domains with Your Own Software

Looking for more features from our Domain API? Look no further than our Advanced Domain API. This version of our API allows you to use your own software and servers to do over 50 commands including create folders, set Whois, set privacy, set email forwarding, and more! Our Advanced Domain API is available to all accounts, so get started today by following the directions below.

Looking for a more simple way to use our API? Check out our Domain API page!

Getting Started With Our Advanced Domain API

Requests to our Advanced Domain API are sent to the following URL:

https://api.dynadot.com/api3.xml

Note that requests should be sent over https (secure socket) for security. Only 1 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
KeyYour key to access the API, available in your account control panel
Commandsearch, register, delete, renew

domain_info, set_whois, set_ns, set_parking, set_forwarding, set_stealth, set_hosting, set_dns, set_free_hosting, set_email_forward, set_clear_domain_setting, set_folder, set_note, set_renew_option, set_privacy, list_domain

create_contact, edit_contact, delete_contact, contact_list, get_contact

add_ns, register_ns, set_ns_ip, delete_ns, server_list

account_info, set_default_whois, set_default_ns, set_default_parking, set_default_forwarding, set_default_stealth, set_default_hosting, set_default_dns, set_default_free_hosting, set_default_email_forward, set_clear_default_setting, set_default_renew_option

create_folder, delete_folder, set_folder_whois, set_folder_ns, set_folder_parking, set_folder_forwarding, set_folder_stealth, set_folder_hosting, set_folder_dns, set_folder_free_hosting, set_folder_email_forward, set_clear_folder_setting, set_folder_name, set_folder_renew_option, folder_list

add_backorder_request, delete_backorder_request, backorder_request_list

get_open_auctions, get_auction_details, place_auction_bid, get_closed_auctions

is_processing

get_open_backorder_auctions, get_backorder_auction_details, place_backorder_auction_bid, get_closed_backorder_auctions

Our Advanced Domain API will return results in an XML format. Your request should contain 2 or 3 of the following fields:

XML Tagname
Explanation
<SuccessCode></SuccessCode>If the operation is successful, "0" for success, "-1" for failure
<Status></Status>The status of request
<Error></Error>Error information about the request, only used when status is "error"
 

Search Command

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

Search Request Parameter
Explanation
domain0 - domain99The 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
show_price (optional)If you want to show the price in your account currency, set it equal to "1".
Result XML tag
Explanation
<Results></Results>The root node of the XML response of search command
<SearchResponse></SearchResponse>Tag of search response
<SearchHeader></SearchHeader>Tag of search header
<SuccessCode></SuccessCode>If the operation is successful, "0" for success, "-1" for failure
<Status></Status>The status of request
<Error></Error>Error information about the request, only used when status is "error"
<DomainName></DomainName>The domain name you have just searched
<Available></Available>If the domain name is available
<Price></Price>If you set"show_price" equal to "1", this will tell you the price info if this domain is available.
<Language></Language>Language information about the domain name

Search Example

Request

https://api.dynadot.com/api3.xml?key=mykey&command=search&domain0=mydomain.com&domain1=mydomain.net&show_price=1

Response
<Results>
  <SearchResponse>
    <SearchHeader>
      <SuccessCode>0</SuccessCode>
      <DomainName>mydomain.com</DomainName>
      <Status>success</Status>
      <Available>yes</Available>
      <Price>10.99 in USD</Price>
    </SearchHeader>
  </SearchResponse>
  <SearchResponse>
    <SearchHeader>
      <SuccessCode>0</SuccessCode>
      <DomainName>mydomain.net</DomainName>
      <Status>success</Status>
      <Available>yes</Available>
      <Price>9.99 in USD</Price>
    </SearchHeader>
  </SearchResponse>
</Results>
 

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
domainThe domain name you want to register, only 1 domain can be registered per request
language (optional)The language tag for the requested domain, only needed if the domain is an IDN
durationHow long to register the domain for
option0 (if necessary)The .UK registrant name or organization
The .AT, .BE, .LT, or .PH registrant name
option1 (if necessary)The .AT, .BE, .LT, or .PH registrant organization (optional)
For .AT, you can specify either option0, option1, or both
option2 (if necessary)
Result XML tag
Explanation
<RegisterResponse></RegisterResponse>Tag of register response
<RegisterHeader></RegisterHeader>Tag of register header
<SuccessCode></SuccessCode>If the operation is successful, "0" for success, "-1" for failure
<Status></Status>The status of request
<Error></Error>Error information about the request, only used when status is "error"
<RegisterContent></RegisterContent>The tag of register content
<Expiration></Expiration>Expiration date in Unix time (milliseconds since midnight UTC of January 1, 1970), only used when result is "success"
<Registration></Registration>Registration 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/api3.xml?key=mykey&command=register&domain=domain1.net&duration=3

Response
<RegisterResponse>
  <RegisterHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </RegisterHeader>
  <RegisterContent>
    <Expiration>1458379145266</Expiration>
  </RegisterContent>
</RegisterResponse>
 

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 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
domainThe domain name you want to delete, only 1 domain can be deleted per request
Result XML tag
Explanation
<DeleteResponse></DeleteResponse>Tag of delete response
<DeleteHeader></DeleteHeader>Tag of delete header
<SuccessCode></SuccessCode>If the operation is successful, "0" for success, "-1" for failure
<Status></Status>The status of request
<Error></Error>Error information about the request, only used when status is "error"

Delete Example

Request

https://api.dynadot.com/api3.xml?key=mykey&command=delete&domain=domain1.com

Response
<DeleteResponse>
  <DeleteHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </DeleteHeader>
</DeleteResponse>
 

Renew Command

Calling the renew command will create and process a renewal order. 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
domainThe domain name you want to renew, only 1 domain can be renewed per request
durationHow many years to renew the domain for
year (optional)The current year the domain expires
Result XML tag
Explanation
<RenewResponse></RenewResponse>Tag of renew response, it's the root node of the response XML document
<RenewHeader></RenewHeader>Renew header
<SuccessCode></SuccessCode>If the operation is successful, "0" for success, "-1" for failure
<Status></Status>The status of request
<Error></Error>Error information about the request, only used when status is "error"
<RenewContent></RenewContent>Tag of renew content, it's only used when status is "success"
<Expiration></Expiration>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/api3.xml?key=50&domain=domian1.com&command=renew&duration=1

Response
<RenewResponse>
  <RenewHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </RenewHeader>
  <RenewContent>
    <Expiration>73984579834</Expiration>
  </RenewContent>
</RenewResponse>
 

Domain Info Command

This command is only available in XML format:

Domain Info Request Parameter
Explanation
domainOnly 1 domain permited per request
Result XML tag
Explanation
<DomainInfoResponse></DomainInfoResponse>Root node of the response XML document
<DomainInfoResponseHeader></DomainInfoResponseHeader>Response header
<SuccessCode></SuccessCode>If the operation is successful, "0" for success, "-1" for failure
<Status></Status>The status of request
<Error></Error>Error information about the request, only used when status is "error"
<DomainInfoContent></DomainInfoContent>Response content
<Domain></Domain>Domain
<Name></Name>Domain's name
<Expiration></Expiration>Domain expiration date in Unix time (milliseconds since midnight UTC of January 1, 1970)
<NameServerSettings></NameServerSettings>Domain's name server settings
<Type></Type>Domain's name server type
<WithAds></WithAds>If you want a parking page for your domain
<Whois></Whois>Whois information
<Registrant></Registrant>Registrant information
<ContactId></ContactId>Contact Id
<Admin></Admin>Admin information
<Technical></Technical>Technical information
<Billing></Billing>Billing information
<Locked></Locked>Locked or not
<Disabled></Disabled>Enable status
<UdrpLocked></UdrpLocked>Udrp locked or not
<UdrpLocked></UdrpLocked>Udrp locked or not
<RegistrantUnverified></RegistrantUnverified>Registrant unverified
<Hold></Hold>Hold
<Privacy></Privacy>Privacy status
<isForSale></isForSale>Sale status
<RenewOption></RenewOption>Renew option
<Note></Note>Note
<Folder></Folder>Folder information
<FolderId></FolderId>Folder ID
<FolderName></FolderName>Folder name

Domain Information Example

Request

https://api.dynadot.com/api3.xml?key=mykey&command=domain_info&domain=domain1.com

Response
<DomainInfoResponse>
  <DomainInfoResponseHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </DomainInfoResponseHeader>
  <DomainInfoContent>
    <Domain>
      <Name>domain1.com</Name>
      <Expiration>1370056762789</Expiration>
      <NameServerSettings>
        <Type>Dynadot Parking</Type>
        <WithAds>yes</WithAds>
      </NameServerSettings>
      <Whois>
        <Registrant>
          <ContactId>0</ContactId>
        </Registrant>
        <Admin>
          <ContactId>0</ContactId>
        </Admin>
        <Technical>
          <ContactId>0</ContactId>
        </Technical>
        <Billing>
          <ContactId>0</ContactId>
        </Billing>
      </Whois>
      <Locked>yes</Locked>
      <Disabled>no</Disabled>
      <UdrpLocked>no</UdrpLocked>
      <RegistrantUnverified>no</RegistrantUnverified>
      <Hold>no</Hold>
      <Privacy>none</Privacy>
      <isForSale>yes</isForSale>
      <RenewOption>no renew option</RenewOption>
      <Note></Note>
      <Folder>
        <FolderId>-1</FolderId>
        <FolderName>(no folder)</FolderName>
      </Folder>
    </Domain>
  </DomainInfoContent>
</DomainInfoResponse>
 

Set Whois Command

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

Set Whois Request Parameter
Explanation
domainThe domain name you want to set, 100 domains can be set per request, make sure they are separated by commas
registrant_contactThe registrant's information of the domain
admin_contactThe administrator's information of the domain
technical_contactThe technical information of the domain
billing_contactThe billing information of the domain
Result XML tag
Explanation
<SetWhoisResponse></SetWhoisResponse>Root node of the response XML document
<SetWhoisHeader></SetWhoisHeader>Response header
<SuccessCode></SuccessCode>If the operation is successful, "0" for success, "-1" for failure
<Status></Status>The status of request
<Error></Error>Error information about the request, only used when status is "error"

Set Whois Example

Request

https://api.dynadot.com/api3.xml?key=mykey&command=set_whois&domain=domain4.com&registrant_contact=0&admin_contact=0&technical_contact=0&billing_contact=0

Response
<SetWhoisResponse>
  <SetWhoisHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetWhoisHeader>
</SetWhoisResponse>
 

Set Name Servers Command

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

Set Name Servers Request Parameter
Explanation
domainThe domain name you want to set, 100 domains can be set per request, make sure they are separated by commas
ns0 - ns12The name servers to set your domain to use, you can specify up to 13 name servers, but they must already be in your account
Result XML tag
Explanation
<SetNsResponse></SetNsResponse>Tag of set name server response, it's the root node of the response XML document
<SetNsHeader></SetNsHeader>Tag of set name server response header
<SuccessCode></SuccessCode>If the operation is successful, "0" for success, "-1" for failure
<Status></Status>The status of request
<Error></Error>Error information about the request, only used when status is "error"

Set Name Server Example

Request

https://api.dynadot.com/api3.xml?key=mykey&command=set_ns&domain=domain1.com,domain2.com&ns0=ns1.hostns.com&ns1=ns2.hostns.com

Response
<SetNsResponse>
  <SetNsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetNsHeader>
</SetNsResponse>
 

Set Parking Command

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

Set Parking Request Parameter
Explanation
domainThe domain name you want to set, 100 domains can be set per request, make sure they are separated by commas
with_ads (optional)If you do not want a 3rd-party ads, you can use this parameter with "no"
Result XML tag
Explanation
<SetParkingResponse></SetParkingResponse>Tag of set parking response, it's the root node of the response XML document
<SetParkingHeader></SetParkingHeader>Set parking folder header
<SuccessCode></SuccessCode>If the operation is successful, "0" for success, "-1" for failure
<Status></Status>The status of request
<Error></Error>Error information about the request, only used when status is "error"

Set Parking Example

Request

https://api.dynadot.com/api3.xml?key=mykey&command=set_parking&domain=domain1.com&with_ads=no

Response

<SetParkingResponse><SetParkingHeader><SuccessCode>0</SuccessCode><Status>success</Status></SetParkingHeader></SetParkingResponse>

 

Set Forwarding Command

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

Set Forwarding Request Parameter
Explanation
domainThe domain name you want to set, 100 domains can be set per request, make sure they are separated by commas
forward_urlThe URL you want your domain forward to
is_temp (optional)Forward status of your domain you want, default value is "temporary", if you want to forward permanently, use this parameter with "no"
Result XML tag
Explanation
<SetForwardingResponse></SetForwardingResponse>Root node of the response XML document
<SetForwardingHeader></SetForwardingHeader>Response header
<SuccessCode></SuccessCode>If the operation is successful, "0" for success, "-1" for failure
<Status></Status>The status of request
<Error></Error>Error information about the request, only used when status is "error"

Set Forwarding Example

Request

https://api.dynadot.com/api3.xml?key=mykey&command=set_forwarding&forward_url=http://www.mydomain.com&domain=domain1.com,domain2.com

Response

<SetForwardingResponse><SetForwardingHeader><SuccessCode>0</SuccessCode><Status>success</Status></SetForwardingHeader></SetForwardingResponse>

 

Set Stealth Command

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

Set Stealth Request Parameter
Explanation
domainThe domain name you want to set, 100 domains can be set per request, make sure they are separated by commas
stealth_urlThe URL you want your domain forward to
stealth_title (optional)The title of the page
Result XML tag
Explanation
<SetStealthResponse></SetStealthResponse>Root node of the response XML document
<SetStealthHeader></SetStealthHeader>Response header
<SuccessCode></SuccessCode>If the operation is successful, "0" for success, "-1" for failure
<Status></Status>The status of request
<Error></Error>Error information about the request, only used when status is "error"

Set Stealth Example

Request

https://api.dynadot.com/api3.xml?key=mykey&command=set_stealth&domain=domain1.com&stealth_title=obama's shop&stealth_url=http://www.obamashop.com

Response

<SetStealthResponse><SetStealthHeader><SuccessCode>0</SuccessCode><Status>success</Status></SetStealthHeader></SetStealthResponse>

 

Set Hosting Command

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

Set Hosting Request Parameter
Explanation
domainThe domain name you want to set, 100 domains can be set per request, make sure they are separated by commas
hosting_typeType of the hosting you want, you can select in "advanced" and "basic"
mobile_view_onOnly when hosting_type is "advanced", can you use this parameter as "yes"
Result XML tag
Explanation
<SetHostingResponse></SetHostingResponse>Root node of the response XML document
<SetHostingHeader></SetHostingHeader>Response header
<SuccessCode></SuccessCode>If the operation is successful, "0" for success, "-1" for failure
<Status></Status>The status of request
<Error></Error>Error information about the request, only used when status is "error"

Set Hosting Example

Request

https://api.dynadot.com/api3.xml?key=mykey&command=set_hosting&domain=domain8.com&hosting_type=advanced&mobile_view_on=yes

Response

<SetHostingResponse><SetHostingHeader><SuccessCode>0</SuccessCode><Status>success</Status></SetHostingHeader></SetHostingResponse>

 

Set DNS Command

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

Set DNS Request Parameter
Explanation
domainThe domain name you want to set, 100 domains can be set per request, make sure they are separated by commas
main_record_typeMain record type
main_recordSpecify a DNS record for your domain
main_txt1 - main_txt4 (optional)Specify a TXT records for your domain. If your main_record_type is aaaa and specified a main_record2, you can set upto 3 main_txts, otherwise, you can set upto 4 main_txts.
main_record2Main record 2, only used when "main_record_type" is "aaaa". Its value must be in ipv4 format.
subdomain0 - subdomain20 (optional)Subdomain records (optional)
sub_record_type0 - sub_record_type20 (optional)Subdomain records type
sub_record0 - sub_record20 (optional)IP address or target host
mx_host0 - mx_host2 (optional)Specify the mail host for your domain, distance0 is the highest priority.
mx_distance0 - mx_distance2 (optional)Distance0 is the highest priority
ttl (optional)Time to live
Result XML tag
Explanation
<SetDnsResponse></SetDnsResponse>Root node of the response XML document
<SetDnsHeader></SetDnsHeader>Response header
<SuccessCode></SuccessCode>If the operation is successful, "0" for success, "-1" for failure
<Status></Status>The status of request
<Error></Error>Error information about the request, only used when status is "error"

Set DNS Example

Request

https://api.dynadot.com/api3.xml?key=mykey&command=set_dns&domain=domain1.com&main_record_type=aaaa&main_record=0:0:0:0:0:0:0:1

Response

<SetDnsResponse><SetDnsHeader><SuccessCode>0</SuccessCode><Status>success</Status></SetDnsHeader></SetDnsResponse>

 

Set Free Hosting Command

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

Set Free Hosting Request Parameter
Explanation
domainThe domain name you want to set, 100 domains can be set per request, make sure they are separated by commas
style (optional)The style of the free page
titleThe title of the free page
bodyThe main part of the page, HTML is allowed but the following tags should not be included: <html>,<title>, <body>, <meta>, <script>; please note that any HTML entered in the body is not validated
Result XML tag
Explanation
<SetFreeHostResponse></SetFreeHostResponse>Tag of set free host response, it's the root node of the response XML document
<SetFreeHostHeader></SetFreeHostHeader>Set free host header
<SuccessCode></SuccessCode>If the operation is successful, "0" for success, "-1" for failure
<Status></Status>The status of request
<Error></Error>Error information about the request, only used when status is "error"

Set Free Hosting Example

Request

https://api.dynadot.com/api3.xml?key=mykey&command=set_free_hosting&domain=domain1.com,domain2.com&title=Obama's shop&body=<div>this is obama's shop</div>

Response

<SetFreeHostResponse><SetFreeHostHeader><SuccessCode>0</SuccessCode><Status>success</Status></SetFreeHostHeader></SetFreeHostResponse>

 

Set Email Forward Command

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

Set Email Forward Request Parameter
Explanation
domainThe domain name you want to set, 100 domains can be set per request, make sure they are separated by commas
forward_typeForward type, it can be "donot": Do not forward email, "mx": Deliver email to another mail host (MX record), "forward": Deliver email to another mail host
username0 - username9Username, only used when "forward_type" is "forward"
exist_email0 - exist_email9Existing email address, only used when "forward_type" is "forward"
mx_host0 - mx_host2Mail host, only used when "forward_type" is "mx"
mx_distance0 - mx_distance2Distance0 is the highest priority, only used when "forward_type" is "mx"
Result XML tag
Explanation
<SetEmailForwardingResponse></SetEmailForwardingResponse>Root node of the response XML document
<SetEmailForwardingHeader></SetEmailForwardingHeader>Response header
<SuccessCode></SuccessCode>If the operation is successful, "0" for success, "-1" for failure
<Status></Status>The status of request
<Error></Error>Error information about the request, only used when status is "error"

Set Email Forward Example

Request

https://api.dynadot.com/api3.xml?key=mykey&command=set_email_forward&domain=domain1.com&forward_type=forward&username0=peter&exist_email0=Alex@dynadot.com

Response

<SetEmailForwardingResponse><SetEmailForwardingHeader><SuccessCode>0</SuccessCode><Status>success</Status></SetEmailForwardingHeader></SetEmailForwardingResponse>

 

Set Clear Domain Setting Command

If calling the set clear domain setting command, the following parameters should be included:

Set Clear Domain Setting Request Parameter
Explanation
domainThe domain name you want to set, 100 domains can be set per request, make sure they are separated by commas
serviceThe service you want to clear, it can be "forward", "stealth", "email_forwarding", "free_hosting", "dns", and "nameservers"
Result XML tag
Explanation
<SetClearDomainSettingResponse></SetClearDomainSettingResponse>Root node of the response XML document
<SetClearDomainSettingHeader></SetClearDomainSettingHeaderr>Response header
<SuccessCode></SuccessCode>If the operation is successful, "0" for success, "-1" for failure
<Status></Status>The status of request
<Error></Error>Error information about the request, only used when status is "error"

Set Clear Domain Setting Example

Request

https://api.dynadot.com/api3.xml?key=mykey&command=set_clear_domain_setting&domain=exp2.com&service=nameservers

Response

<SetClearDomainSettingResponse><SetClearDomainSettingHeader><SuccessCode>0</SuccessCode><Status>success</Status></SetClearDomainSettingHeader></SetClearDomainSettingResponse>

 

Set Folder Command

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

Set Folder Request Parameter
Explanation
domainThe domain name to update, only 1 domain can be set per request
folderThe 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.
folder_id (optional)The folder ID that you want to move your domain to
Result XML tag
Explanation
<SetFolderResponse></SetFolderResponse>Tag of set folder response, it's the root node of the response XML document
<SetFolderHeader></SetFolderHeader>Set folder header
<SuccessCode></SuccessCode>If the operation is successful, "0" for success, "-1" for failure
<Status></Status>The status of request
<Error></Error>Error information about the request, only used when status is "error"

Set Folder Example

Request

https://api.dynadot.com/api3.xml?key=mykey&command=set_folder&domain=domian1.com&folder=folder1

Response

<SetFolderResponse><SetFolderHeader><SuccessCode>0</SuccessCode><Status>success</Status></SetFolderHeader></RenewResponse>

 

Set Renew Option

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

Set Renew Option Request Parameter
Explanation
domainThe domain name you want to set, 100 domains can be set per request, make sure they are separated by commas
renew_optionIt can be "donot", "auto", "reset"
Result XML tag
Explanation
<SetRenewOptionResponse></SetRenewOptionResponse>Root node of the response XML document
<SetRenewOptionHeader></SetRenewOptionHeader>Response header
<SuccessCode></SuccessCode>If the operation is successful, "0" for success, "-1" for failure
<Status></Status>The status of request
<Error></Error>Error information about the request, only used when status is "error"

Set Renew Option Example

Request

https://api.dynadot.com/api3.xml?key=mykey&command=set_renew_option&domain=domain1.com&renew_option=auto

Response

<SetRenewOptionResponse><SetRenewOptionHeader><SuccessCode>0</SuccessCode><Status>success</Status></SetRenewOptionHeader></SetRenewOptionResponse>

 

Set Note Command

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

Set Note Request Parameter
Explanation
domainThe domain you want to set, only 1 domain can be set per request
noteNote you want to set to the domain, can be null
Result XML tag
Explanation
<SetNoteResponse></SetNoteResponse>Root node of the response XML document
<SetNoteHeader></SetNoteHeader>Response heade
<SuccessCode></SuccessCode>If the operation is successful, "0" for success, "-1" for failure
<Status></Status>The status of request
<Error></Error>Error information about the request, only used when status is "error"

Set Note Example

Request

https://api.dynadot.com/api3.xml?key=mykey&command=set_note&domain=domain1.com&note=Do not modify any information

Response

<SetNoteResponse><SetNoteHeader><SuccessCode>0</SuccessCode><Status>success</Status></SetNoteHeader></SetNoteResponse>

 

Set Privacy Command

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

Set Privacy Request Parameter
Explanation
domainThe domain name you want to set, 100 domains can be set per request, make sure they are separated by commas
optionThe privacy status of the domain you want to set, it can be "full", "partial", or "off"
Result XML tag
Explanation
<SetPrivacyResponse></SetPrivacyResponse>Root node of the response XML document
<SetPrivacyHeader></SetPrivacyHeader>Response header
<SuccessCode></SuccessCode>If the operation is successful, "0" for success, "-1" for failure
<Status></Status>The status of request
<Error></Error>Error information about the request, only used when status is "error"

Set Privacy Example

Request

https://api.dynadot.com/api3.xml?key=mykey&command=set_privacy&domain=domain1.com&option=off

Response
<SetPrivacyResponse>
  <SetPrivacyHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetPrivacyHeader>
</SetPrivacyResponse>
 

List Domain Command

This feature is only available in XML format:

List Domain Request Parameter
Explanation
N/ANo extra parameter needed
Result XML tag
Explanation
<ListDomainInfoResponse></ListDomainInfoResponse>Root node of the response XML document
<ListDomainInfoHeader></ListDomainInfoHeader>Response header
<SuccessCode></SuccessCode>If the operation is successful, "0" for success, "-1" for failure
<Status></Status>The status of request
<Error></Error>Error information about the request, only used when status is "error"
<ListDomainInfoContent></ListDomainInfoContent>Response content
<DomainInfoList></DomainInfoList>Domain information list
<DomainInfo></DomainInfo>Domain information
<Domain></Domain>Domain
<Name></Name>Domain name
<Expiration></Expiration>Domain expiration date in Unix time (milliseconds since midnight UTC of January 1, 1970)
<NameServerSettings></NameServerSettings>Name server settings
<Type></Type>Name server setting type
<WithAds></WithAds>With ads or not
<Whois></Whois>Whois information
<Registrant></Registrant>Registrant information
<ContactId></ContactId>Contact Id
<Admin></Admin>Admin information
<Technical></Technical>Technical information
<Billing></Billing>Billing information
<Locked></Locked>Locked or not
<Disabled></Disabled>Enable status
<Hold></Hold>Hold
<Privacy></Privacy>Privacy status
<isForSale></isForSale>Sale status
<RenewOption></RenewOption>Renew option
<Note></Note>Note
<Folder></Folder>Folder information
<FolderId></FolderId>Folder ID
<FolderName></FolderName>Folder name

List Domain Example

Request

https://api.dynadot.com/api3.xml?key=mykey&command=list_domain

Response
<ListDomainInfoResponse>
  <ListDomainInfoHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </ListDomainInfoHeader>
  <ListDomainInfoContent>
    <DomainInfoList>
      <DomainInfo>
        <Domain>
          <Name>domain-exp140.com</Name>
          <Expiration>1361430589062</Expiration>
          <NameServerSettings>
            <Type>Dynadot Parking</Type>
            <WithAds>yes</WithAds>
          </NameServerSettings>
          <Whois>
            <Registrant>
              <ContactId>0</ContactId>
            </Registrant>
            <Admin>
              <ContactId>0</ContactId>
            </Admin>
            <Technical>
              <ContactId>0</ContactId>
            </Technical>
            <Billing>
              <ContactId>0</ContactId>
            </Billing>
          </Whois>
          <Locked>yes</Locked>
          <Disabled>no</Disabled>
          <Hold>no</Hold>
          <Privacy>none</Privacy>
          <isForSale>no</isForSale>
          <RenewOption>no renew option</RenewOption>
          <Note></Note>
          <Folder>
            <FolderId>-1</FolderId>
            <FolderName>(no folder)</FolderName>
          </Folder>
        </Domain>
      </DomainInfo>
      <DomainInfo>
        <Domain>
          <Name>domain-exp141.com</Name>
          <Expiration>1361430589062</Expiration>
          <NameServerSettings>
            <Type>Dynadot Parking</Type>
            <WithAds>yes</WithAds>
          </NameServerSettings>
          <Whois>
            <Registrant>
              <ContactId>0</ContactId>
            </Registrant>
            <Admin>
              <ContactId>0</ContactId>
            </Admin>
            <Technical>
              <ContactId>0</ContactId>
            </Technical>
            <Billing>
              <ContactId>0</ContactId>
            </Billing>
          </Whois>
          <Locked>yes</Locked>
          <Disabled>no</Disabled>
          <Hold>no</Hold>
          <Privacy>none</Privacy>
          <isForSale>no</isForSale>
          <RenewOption>no renew option</RenewOption>
          <Note></Note>
          <Folder>
            <FolderId>-1</FolderId>
            <FolderName>(no folder)</FolderName>
          </Folder>
        </Domain>
      </DomainInfo>
    </DomainInforList>
  </ListDomainInfoContent>
</ListDomainInfoResponse>
 

Create Contact Command

If calling create contact command, the following parameters should be included:

Create Contact Request Parameter
Explanation
organization (optional)The organization information
nameName
emailEmail
phonenumPhone number
phoneccPhone country code
faxnum (optional)Fax number
faxcc (optional)Fax country code
address1Address1
address2 (optional)Address 2
cityCity
stateState
zipZip code
countryCountry
Result XML tag
Explanation
<CreateContactResponse></CreateContactResponse>Root node of the response XML document
<CreateContactHeader></CreateContactHeader>Response header
<SuccessCode></SuccessCode>If the operation is successful, "0" for success, "-1" for failure
<Status></Status>The status of request
<Error></Error>Error information about the request, only used when status is "error"
<CreateContactContent></CreateContactContent>&lt;ContactId&gt;New Contact ID&lt;/ContactId&gt;, only used when status is "success"

Create Contact Example

Request

https://api.dynadot.com/api3.xml?key=mykey&command=create_contact&name=Webb&email=myemail@email.com&phonenum=8662623399&phonecc=1&address1=PO Box 345&city=San Mateo&state=America&zip=94401&country=US

Response
<CreateContactResponse>
  <CreateContactHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </CreateContactHeader>
  <CreateContactContent>
    <ContactId>1234</ContactId>
  </CreateContactContent>
</CreateContactResponse>
 

Edit Contact Command

If calling edit contact command, the following parameters should be included:

Edit Contact Request Parameter
Explanation
contact_idThe contact's ID you want to edit
organization (optional)The organization information
nameName
emailEmail
phonenumPhone number
phoneccPhone country code
phoneccPhone country code
faxnum (optional)Fax number
faxcc (optional)Fax country code
address1Address 1
address2 (optional)Address 2
cityCity
stateState
zipZip code
countryCountry
Result XML tag
Explanation
<EditContactResponse></EditContactResponse>Root node of the response XML document
<EditContactHeader></EditContactHeader>Response header
<SuccessCode></SuccessCode>If the operation is successful, "0" for success, "-1" for failure
<Status></Status>The status of request
<Error></Error>Error information about the request, only used when status is "error"
<EditContactContent></EditContactContent>Response content
<ContactId></ContactId>ID of the contact

Edit Contact Example

Request

https://api.dynadot.com/api3.xml?key=mykey&command=edit_contact&contact_id=0&name=Webb&email=myemail@email.com&phonenum=8662623399&phonecc=1&address1=PO Box 345&city=San Mateo&state=U.S&zip=94401&country=US

Response
<EditContactResponse>
  <EditContactHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </EditContactHeader>
  <EditContactContent>
    <ContactId>0</ContactId>
  </EditContactContent>
</EditContactResponse>
 

Delete Contact Command

If calling delete contact command, the following parameters should be included:

Delete Contact Request Parameter
Explanation
contact_idThe ID of the contact you want to delete, make sure they are separated by commas
Result XML tag
Explanation
<DeleteContactResponse></DeleteContactResponse>Root node of the response XML document
<DeleteContactHeader></DeleteContactHeader>Response header
<SuccessCode></SuccessCode>If the operation is successful, "0" for success, "-1" for failure
<Status></Status>The status of request
<Error></Error>Error information about the request, only used when status is "error"

Delete Contact Example

Request

https://api.dynadot.com/api3.xml?key=mykey&command=delete_contact&contact_id=0

Response
<DeleteContactResponse>
  <DeleteContactHeader>
    <SuccessCode>-1</SuccessCode>
    <Status>error</Status>
    <Error>cannot delete these contacts (Jack Slater). Because they are in use.</Error>
  </DeleteContactHeader>
</DeleteContactResponse>
 

Contact List Command

This command is only available in XML format:

Contact List Request Parameter
Explanation
N/ANo extra parameter needed
Result XML tag
Explanation
<ContactListResponse></ContactListResponse>Root node of the response XML document
<ContactListHeader></ContactListHeader>Response header
<SuccessCode></SuccessCode>If the operation is successful, "0" for success, "-1" for failure
<Status></Status>The status of request
<Error></Error>Error information about the request, only used when status is "error"
<ContactListContent></ContactListContent>Response content
<ContactList></ContactList>Contact list
<Contact></Contact>Contact info
<ContactId></ContactId>Contact ID
<Organization></Organization>Contact's organization
<Name></Name>Name
<Email></Email>Email
<PhoneCc></PhoneCc>Phone country code
<PhoneNum></PhoneNum>Phone number
<FaxCc></FaxCc>Fax country code
<FaxNum></FaxNum>Fax number
<Address1></Address1>Address 1
<Address2></Address2>Address 2
<City></City>City
<State></State>State
<ZipCode></ZipCode>Zip code
<Country></Country>Country
<GtldVerified></GtldVerified>gTLD verification status

Contact List Example

Request

https://api.dynadot.com/api3.xml?key=mykey&command=contact_list

Response
<ContactListResponse>
  <ContactListHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </ContactListHeader>
  <ContactListContent>
    <ContactList>
      <Contact>
        <ContactId>0</ContactId>
        <Organization></Organization>
        <Name>Jack Slater</Name>
        <Email>test@dynadot.com</Email>
        <PhoneCc>1</PhoneCc>
        <PhoneNum>555.555.5233</PhoneNum>
        <FaxCc></FaxCc>
        <FaxNum></FaxNum>
        <Address1>1 Free Way</Address1>
        <Address2></Address2>
        <City>Los Angeles</City>
        <State>CA</State>
        <ZipCode>90068</ZipCode>
        <Country>US</Country>
      </Contact>
    </ContactList>
  </ContactListContent>
</ContactListResponse>
 

Get Contact Command

This command is only available in XML format:

Get Contact Request Parameter
Explanation
contact_idid of contact
Result XML tag
Explanation
<GetContactResponse></GetContactResponse>Root node of the response XML document
<GetContactHeader></GetContactHeader>Response header
<SuccessCode></SuccessCode>If the operation is successful, "0" for success, "-1" for failure
<Status></Status>The status of request
<Error></Error>Error information about the request, only used when status is "error"
<GetContactContent></GetContactContent>Response content
<Contact></Contact>Contact info
<ContactId></ContactId>Contact ID
<Organization></Organization>Contact's organization
<Name></Name>Name
<Email></Email>Email
<PhoneCc></PhoneCc>Phone country code
<PhoneNum></PhoneNum>Phone number
<FaxCc></FaxCc>Fax country code
<FaxNum></FaxNum>Fax number
<Address1></Address1>Address 1
<Address2></Address2>Address 2
<City></City>City
<State></State>State
<ZipCode></ZipCode>Zip code
<Country></Country>Country
<GtldVerified></GtldVerified>gTLD verification status

Get Contact Example

Request

https://api.dynadot.com/api3.xml?key=mykey&command=get_contact&contact_id=10000

Response
<GetContactResponse>
 <GetContactHeader>
  <ResponseCode>0</ResponseCode>
  <Status>success</Status>
 </GetContactHeader>
 <GetContactContent>
  <Contact>
   <ContactId>12345</ContactId>
   <Organization>org</Organization>
   <Name>name</Name>
   <Email>example@example.com</Email>
   <PhoneCc>0</PhoneCc>
   <PhoneNum>phone number</PhoneNum>
   <FaxCc>example faxcc</FaxCc>
   <FaxNum>example faxnum</FaxNum>
   <Address1>address1</Address1>
   <Address2>address2</Address2>
   <City>city</City>
   <State>state</State>
   <ZipCode>zipcode</ZipCode>
   <Country>country</Country>
  </Contact>
 </GetContactContent></GetContactResponse>
 

Add Name Server Command

If calling add name server command, the following parameters should be included:

Add Name Server Request Parameter
Explanation
hostThe host name of name server you want to add
Result XML tag
Explanation
<AddNsResponse></AddNsResponse>Root node of the response XML document
<AddNsHeader></AddNsHeader>Response header
<SuccessCode></SuccessCode>If the operation is successful, "0" for success, "-1" for failure
<Status></Status>The status of request
<Error></Error>Error information about the request, only used when status is "error"
<AddNsContent></AddNsContent>Response content
<Server></Server>Server you have set
<Host></Host>Host name of the new server
<ServerId></ServerId>ID of the new server

Add Name Server Example

Request

https://api.dynadot.com/api3.xml?key=mykey&command=add_ns&host=ns1.mydomain.com

Response

<AddNsResponse><AddNsHeader><SuccessCode>0</SuccessCode><Status>success</Status></AddNsHeader><AddNsContent><Server><Host>ns1.mydomain.com</Host><ServerId>0</ServerId></Server></AddNsContent></AddNsResponse>

 

Register Name Server Command

If calling the register name server command, the following parameters should be included:

Register Name Server Request Parameter
Explanation
hostThe host name of your own name server
ipThe IP address of your own name server
Result XML tag
Explanation
<RegisterNsResponse></RegisterNsResponse>Root node of the response XML document
<RegisterNsHeader></RegisterNsHeader>Response header
<SuccessCode></SuccessCode>If the operation is successful, "0" for success, "-1" for failure
<Status></Status>The status of request
<Error></Error>Error information about the request, only used when status is "error"
<RegisterNsContent></RegisterNsContent>Response content
<Server></Server>Server tag
<Host></Host>Host name
<ServerId></ServerId>Server ID

Register Name Server Example

Request

https://api.dynadot.com/api3.xml?key=mykey&command=register_ns&host=domain1.com&ip=192.168.1.1

Response

<RegisterNsResponse><RegisterNsHeader><SuccessCode>0</SuccessCode><Status>success</Status></RegisterNsHeader><RegisterNsContent><Server><Host>domain1.com</Host><ServerId>0</ServerId></Server></RegisterNsContent></RegisterNsResponse>

 

Set Name Server IP Command

If calling set name server IP command, the following parameters should be included:

Set Name Server IP Request Parameter
Explanation
server_idThe name server's ID you want to set
ip0 - ip9The IP address you want to set to the name server, 9 IPs can be set per request and need to be separated by commas
Result XML tag
Explanation
<SetNsIpResponse></SetNsIpResponse>Root node of the response XML document
<SetNsIpHeader></SetNsIpHeader>Response header
<SuccessCode></SuccessCode>If the operation is successful, "0" for success, "-1" for failure
<Status></Status>The status of request
<Error></Error>Error information about the request, only used when status is "error"

Set Name Server IP Example

Request

https://api.dynadot.com/api3.xml?key=mykey&command=set_ns_ip&server_id=1&ip0=192.168.1.1

Response

<SetNsIpResponse><SetNsIpHeader><SuccessCode>0</SuccessCode><Status>success</Status></SetNsIpHeader></SetNsIpResponse>

 

Delete Name Server Command

If calling delete name server command, the following parameters should be included:

Delete Name Server Request Parameter
Explanation
server_idThe ID of name servers you want to delete, make sure that they are separated by commas
Result XML tag
Explanation
<DeleteNsResponse></DeleteNsResponse>Root node of the response XML document
<DeleteNsHeader></DeleteNsHeader>Response header
<SuccessCode></SuccessCode>If the operation is successful, "0" for success, "-1" for failure
<Status></Status>The status of request
<Error></Error>Error information about the request, only used when status is "error"

Delete Name Server Example

Request

https://api.dynadot.com/api3.xml?key=mykey&command=delete_ns&server_id=0

Response

<DeleteNsResponse><DeleteNsHeader><SuccessCode>0</SuccessCode><Status>success</Status></DeleteNsHeader></DeleteNsResponse>

 

Server List Command

This command is only available in XML format:

Server List Request Parameter
Explanation
N/ANo extra parameter needed
Result XML tag
Explanation
<ServerListResponse></ServerListResponse>Root node of the response XML document
<ServerListHeader></ServerListHeader>Response header
<SuccessCode></SuccessCode>If the operation is successful, "0" for success, "-1" for failure
<Status></Status>The status of request
<Error></Error>Error information about the request, only used when status is "error"
<ServerListContent></ServerListContent>Response content
<NameServerList></NameServerList>Name server list
<List></List>
<Server></Server>
<ServerId></ServerId>Server ID
<ServerName></ServerName>Server name
<ServerIp></ServerIp>Server IP

Server List Example

Request

https://api.dynadot.com/api3.xml?key=mykey&command=server_list

Response
<ServerListResponse>
  <ServerListHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </ServerListHeader>
  <ServerListContent>
    <NameServerList>
      <List>
        <Server>
          <ServerId>0</ServerId>
          <ServerName>ns1.com</ServerName>
          <ServerIp></ServerIp>
        </Server>
        <Server>
          <ServerId>1</ServerId>
          <ServerName>domain1.com</ServerName>
          <ServerIp>192.168.1.1,,,,,,,,,</ServerIp>
        </Server>
      </List>
    </NameServerList>
  </ServerListContent>
</ServerListResponse>
 

Account Information Command

This command is only available in XML format:

Account Info Request Parameter
Explanation
N/ANo extra parameter needed
Result XML tag
Explanation
<AccountInfoResponse></AccountInfoResponse>Root node of the response XML document
<AccountInfoHeader></AccountInfoHeader>Response header
<SuccessCode></SuccessCode>If the operation is successful, "0" for success, "-1" for failure
<Status></Status>The status of request
<Error></Error>Error information about the request, only used when status is "error"
<AccountInfoContent></AccountInfoContent>Response content
<AccountInfo></AccountInfo>Account information
<Username></Username>Username
<ForumName></ForumName>Forum name
<Contact></Contact>Contact info
<Organization></Organization>Organization
<Organization></Organization>Response header
<Name></Name>Your name
<Email></Email>Email
<PhoneCc></PhoneCc>Phone country code
<PhoneNum></PhoneNum>Phone number
<Address1></Address1>Address 1
<Address2></Address2>Address 2
<City></City>City
<State></State>State
<ZipCode></ZipCode>Zip code
<Country></Country>Country
<CustomerSince></CustomerSince>Customer since
<AccountLock></AccountLock>Account lock
<TotalSpending></TotalSpending>Total spending
<PriceLevel></PriceLevel>Price level
<AccountBalance></AccountBalance>Account balance
<CustomTimeZone></CustomTimeZone>Custom time zone
<DefaultSettings></DefaultSettings>Default settings
<DefaultWhois></DefaultWhois>Default Whois
<DefaultRegistrant></DefaultRegistrant>Default registrant
<ContactId></ContactId>Contact ID
<DefaultAdmin></DefaultAdmin>Default admin
<DefaultTechnical></DefaultTechnical>Default technical
<DefaultBilling></DefaultBilling>Default billing
<Type></Type>Name server type
<WithAds></WithAds>With ads or not

Account Information Example

Request

https://api.dynadot.com/api3.xml?key=mykey&command=account_info

Response
<AccountInfoResponse>
  <AccountInfoHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </AccountInfoHeader>
  <AccountInfoContent>
    <AccountInfo>
      <Username>slater</Username>
      <ForumName>slaterinforum</ForumName>
      <Contact>
        <Organization></Organization>
        <Name>Jack Slater</Name>
        <Email>bishop@dynadot.local</Email>
        <PhoneCc>1</PhoneCc>
        <PhoneNum>555.555.5233</PhoneNum>
        <Address1>1 Free Way</Address1>
        <Address2></Address2>
        <City>Los Angeles</City>
        <State>CA</State>
        <ZipCode>90068</ZipCode>
        <Country>US</Country>
      </Contact>
      <CustomerSince>1364888735253</CustomerSince>
      <AccountLock>on</AccountLock>
      <TotalSpending>$0.00</TotalSpending>
      <PriceLevel>Regular Pricing</PriceLevel>
      <AccountBalance>$70.02</AccountBalance>
      <CustomTimeZone>PST</CustomTimeZone>
      <DefaultSettings>
        <DefaultWhois>
          <DefaultRegistrant>
            <ContactId>0</ContactId>
          </DefaultRegistrant>
          <DefaultAdmin>
            <ContactId>0</ContactId>
          </DefaultAdmin>
          <DefaultTechnical>
            <ContactId>0</ContactId>
          </DefaultTechnical>
          <DefaultBilling>
            <ContactId>0</ContactId>
          </DefaultBilling>
        </DefaultWhois>
        <DefaultNameServerSettings>
          <Type>Dynadot Parking</Type>
          <WithAds>yes</WithAds>
        </DefaultNameServerSettings>
      </DefaultSettings>
    </AccountInfo>
  </AccountInfoContent>
</AccountInfoResponse>
 

Set Default Whois

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

Set Default Whois Request Parameter
Explanation
registrant_contactThe registrant's information of the domain
admin_contactThe administrator's information of the domain
technical_contactThe technical information of the domain
billing_contactThe billing information of the domain
Result XML tag
Explanation
<SetDefaultWhoisResponse></SetDefaultWhoisResponse>Root node of the response XML document
<SetDefaultWhoisHeader></SetDefaultWhoisHeader>Response header
<SuccessCode></SuccessCode>If the operation is successful, "0" for success, "-1" for failure
<Status></Status>The status of request
<Error></Error>Error information about the request, only used when status is "error"

Set Default Whois Example

Request

https://api.dynadot.com/api3.xml?key=mykey&command=set_default_whois&registrant_contact=0&admin_contact=0&technical_contact=0&billing_contact=0

Response

<SetDefaultWhoisResponse><SetDefaultWhoisHeader><SuccessCode>0</SuccessCode><Status>success</Status></SetDefaultWhoisHeader></SetDefaultWhoisResponse>

 

Set Default Name Servers Command

If calling the set default name servers command, the following parameters should be included:

Set Default Name Servers Request Parameter
Explanation
ns0 - ns12The name servers you want to set
Result XML tag
Explanation
<SetDefaultNsResponse></SetDefaultNsResponse>Tag of set default name servers response, it's the root node of the response XML document
<SetDefaultNsHeader></SetDefaultNsHeader>Tag of set default name servers header
<SuccessCode></SuccessCode>If the operation is successful, "0" for success, "-1" for failure
<Status></Status>The status of request
<Error></Error>Error information about the request, only used when status is "error"
<SetDefaultNsContent></SetDefaultNsContent>Tag of set default name servers content, it's only used when the status is "success"
<Servers></Servers>The information of the servers you have set
<Server></Server>Each server
<ServerName></ServerName>Server name
<ServerId></ServerId>Server Id

Set Default Name Server Example

Request

https://api.dynadot.com/api3.xml?key=mykey&command=set_default_ns&ns0=ns1.hosts.com&ns1=ns2.host.com

Response

<SetDefaultNsResponse><SetDefaultNsHeader><SuccessCode>0</SuccessCode><Status>success</Status></SetDefaultNsHeader><SetDefaultNsContent><Servers><Server><Servername>ns1.hosts.com</Servername><ServerId>1</ServerId></Server><Server><Servername>ns2.hosts.com</Servername><ServerId>2</ServerId></Server></Servers></SetDefaultNsContent></SetDefaultNsResponse>

 

Set Default Parking Command

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

Set Default Parking Request Parameter
Explanation
with_ads (optional)If you don't want a 3rd-party ads, you can use this parameter with "no", default value is "yes"
Result XML tag
Explanation
<SetDefaultParkingResponse></SetDefaultParkingResponse>Root node of the response XML document
<SetDefaultParkingHeader></SetDefaultParkingHeader>Response header
<SuccessCode></SuccessCode>If the operation is successful, "0" for success, "-1" for failure
<Status></Status>The status of request
<Error></Error>Error information about the request, only used when status is "error"

Set Default Parking Example

Request

https://api.dynadot.com/api3.xml?key=mykey&command=set_default_parking&folder_id=0&with_ads=no

Response

<SetDefaultParkingResponse><SetDefaultParkingHeader><SuccessCode>0</SuccessCode><Status>success</Status></SetDefaultParkingHeader></SetDefaultParkingResponse>

 

Set Default Forwarding Command

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

Set Default Forwarding Request Parameter
Explanation
forward_urlThe URL you want your domain forward to
is_temp (optional)Forward status of your domain you want, default value is "temporary", if you want to forward permanently, use this parameter with "no"
Result XML tag
Explanation
<SetDefaultForwardingResponse></SetDefaultForwardingResponse>Root node of the response XML document
<SetDefaultForwardingHeader></SetDefaultForwardingHeader>Response header
<SuccessCode></SuccessCode>If the operation is successful, "0" for success, "-1" for failure
<Status></Status>The status of request
<Error></Error>Error information about the request, only used when status is "error"

Set Default Forwarding Example

Request

https://api.dynadot.com/api3.xml?key=mykey&command=set_default_forwarding&forward_url=http://mydomain.com

Response

<SetDefaultForwardingResponse><SetDefaultForwardingHeader><SuccessCode>0</SuccessCode><Status>success</Status></SetDefaultForwardingHeader></SetDefaultForwardingResponse>

 

Set Default Stealth Command

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

Set Default Stealth Request Parameter
Explanation
stealth_urlThe URL you want your domain forward to
stealth_title (optional)The title of the page
Result XML tag
Explanation
<SetDefaultStealthResponse></SetDefaultStealthResponse>Root node of the response XML document
<SetDefaultStealthHeader></SetDefaultStealthHeader>Response header
<SuccessCode></SuccessCode>If the operation is successful, "0" for success, "-1" for failure
<Status></Status>The status of request
<Error></Error>Error information about the request, only used when status is "error"

Set Deafult Stealth Example

Request

https://api.dynadot.com/api3.xml?key=mykey&command=set_default_stealth&stealth_title=obama's shop&stealth_url=http://www.obamashop.com

Response

<SetDefaultStealthResponse><SetDefaultStealthHeader><SuccessCode>0</SuccessCode><Status>success</Status></SetDefaultStealthHeader></SetDefaultStealthResponse>

 

Set Default Hosting Command

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

Set Default Hosting Request Parameter
Explanation
hosting_typeType of the default hosting you want, you can select in "advanced" and "basic"
Result XML tag
Explanation
<SetDefaultHostingResponse></SetDefaultHostingResponse>Root node of the response XML document
<SetDefaultHostingHeader></SetDefaultHostingHeader>Response header
<SuccessCode></SuccessCode>If the operation is successful, "0" for success, "-1" for failure
<Status></Status>The status of request
<Error></Error>Error information about the request, only used when status is "error"

Set Default Hosting Example

Request

https://api.dynadot.com/api3.xml?key=mykey&command=set_default_hosting&hosting_type=advanced

Response

<SetDefaultHostingResponse><SetDefaultHostingHeader><SuccessCode>0</SuccessCode><Status>success</Status></SetDefaultHostingHeader></SetDefaultHostingResponse>

 

Set Default DNS Command

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

Set Default DNS Request Parameter
Explanation
main_record_typeMain record type
main_recordSpecify a DNS record for your domain
main_txt (optional)Specify a TXT record for your domain. If your main_record_type is aaaa and specified a main_record2, you can set upto 3 main_txts, otherwise, you can set upto 4 main_txts.
main_record2Main record 2, only used when "main_record_type" is "aaaa". Its value must be in ipv4 format.
subdomain0 - subdomain20 (optional)Subdomain records
sub_record_type0 - sub_record_type20 (optional)Subdomain records type
sub_record0 - sub_record20 (optional)IP address or target host
mx_host0 - mx_host2 (optional)Specify the mail host for your domain, distance0 is the highest priority.
mx_distance0 - mx_distance2 (optional)Distance0 is the highest priority
ttl (optional)Time to live
Result XML tag
Explanation
<SetDefaultDnsResponse></SetDefaultDnsResponse>Root node of the response XML document
<SetDefaultDnsHeader></SetDefaultDnsHeader>Response header
<SuccessCode></SuccessCode>If the operation is successful, "0" for success, "-1" for failure
<Status></Status>The status of request
<Error></Error>Error information about the request, only used when status is "error"

Set Default DNS Example

Request

https://api.dynadot.com/api3.xml?key=mykey&command=set_default_dns&main_record_type=aaaa&main_record=0:0:0:0:0:0:0:1

Response

<SetDefaultDnsResponse><SetDefaultDnsHeader><SuccessCode>0</SuccessCode><Status>success</Status></SetDefaultDnsHeader></SetDefaultDnsResponse>

 

Set Default Free Hosting Command

If calling the set default free hosting command, the following parameters should be included:

Set Default Free Hosting Request Parameter
Explanation
style (optional)The style of the free page
titleThe title of the free page
bodyThe main part of the page, HTML is allowed but the following tags should not be included: <html>,<title>, <body>, <meta>, <script>; please note that any HTML entered in the body is not validated
Result XML tag
Explanation
<SetDefaultFreeHostResponse></SetDefaultFreeHostResponse>Tag of set default free host response, it's the root node of the response XML document
<SetDefaultFreeHostHeader></SetDefaultFreeHostHeader>Set default free host header
<SuccessCode></SuccessCode>If the operation is successful, "0" for success, "-1" for failure
<Status></Status>The status of request
<Error></Error>Error information about the request, only used when status is "error"

Set Default Free Hosting Example

Request

https://api.dynadot.com/api3.xml?key=mykey&command=set_default_free_hosting&title=Obama's shop&body=<div>this is obama's shop</div>

Response

<SetDefaultFreeHostResponse><SetDefaultFreeHostHeader><SuccessCode>0</SuccessCode><Status>success</Status></SetDefaultFreeHostHeader></SetDefaultFreeHostResponse>

 

Set Default Email Forward Command

If calling set default email forward command, the following parameters should be included:

Set Default Email Forward Request Parameter
Explanation
forward_typeForward type, it can be "donot": Do not forward email, "mx": Deliver email to another mail host (MX record), "forward": Deliver email to another mail host
username0 - username9Username, only used when "forward_type" is "forward"
exist_email0 - exist_email9Existing email address, only used when "forward_type" is "forward"
mx_host0 - mx_host2Mail host, only used when "forward_type" is "mx"
mx_distance0 - mx_distance2Distance0 is the highest priority, only used when "forward_type" is "mx"
Result XML tag
Explanation
<SetDefaultEmailForwardingResponse></SetDefaultEmailForwardingResponse>Root node of the response XML document
<SetDefaultEmailForwardingHeader></SetDefaultEmailForwardingHeader>Response header
<SuccessCode></SuccessCode>If the operation is successful, "0" for success, "-1" for failure
<Status></Status>The status of request
<Error></Error>Error information about the request, only used when status is "error"

Set Default Email Forward Example

Request

https://api.dynadot.com/api3.xml?key=mykey&command=set_default_email_forward&forward_type=forward&username0=peter&exist_email0=peter@dynadot.com

Response

<SetDefaultEmailForwardingResponse><SetDefaultEmailForwardingHeader><SuccessCode>0</SuccessCode><Status>success</Status></SetDefaultEmailForwardingHeader></SetDefaultEmailForwardingResponse>

 

Set Clear Default Setting Command

If calling the set clear default setting command, the following parameters should be included:

Set Clear Default Setting Request Parameter
Explanation
serviceThe service you want to clear, it can be "forward", "stealth", "email_forwarding", "free_hosting", "dns", and "nameservers"
Result XML tag
Explanation
<SetClearDefaultSettingResponse></SetClearDefaultSettingResponse>Root node of the response XML document
<SetClearDefaultSettingHeader></SetClearDefaultSettingHeader>Response header
<SuccessCode></SuccessCode>If the operation is successful, "0" for success, "-1" for failure
<Status></Status>The status of request
<Error></Error>Error information about the request, only used when status is "error"

Set Clear Default Setting Example

Request

https://api.dynadot.com/api3.xml?key=mykey&command=set_clear_default_setting&service=nameservers

Response

<SetClearDefaultSettingResponse><SetClearDefaultSettingHeader><SuccessCode>0</SuccessCode><Status>success</Status></SetClearDefaultSettingHeader></SetClearDefaultSettingResponse>

 

Set Default Renew Option Command

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

Set Default Renew Option Request Parameter
Explanation
renew_optionIt can be "donot", "auto", "reset"
Result XML tag
Explanation
<SetDefaultRenewOptionResponse></SetDefaultRenewOptionResponse>Root node of the response XML document
<SetDefaultRenewOptionHeader></SetDefaultRenewOptionHeader>Response header
<SuccessCode></SuccessCode>If the operation is successful, "0" for success, "-1" for failure
<Status></Status>The status of request
<Error></Error>Error information about the request, only used when status is "error"

Set Default Renew Option Example

Request

https://api.dynadot.com/api3.xml?key=mykey&command=set_default_renew_option&renew_option=auto

Response

<SetDefaultRenewOptionResponse><SetDefaultRenewOptionHeader><SuccessCode>0</SuccessCode><Status>success</Status></SetDefaultRenewOptionHeader></SetDefaultRenewOptionResponse>

 

Create Folder Command

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

Create Folder Request Parameter
Explanation
folder_nameName of the folder you want to create
Result XML tag
Explanation
<FolderCreateResponse></FolderCreateResponse>Root node of the response XML document
<FolderCreateHeader></FolderCreateHeader>Response header
<SuccessCode></SuccessCode>If the operation is successful, "0" for success, "-1" for failure
<Status></Status>The status of request
<Error></Error>Error information about the request, only used when status is "error"
<FolderCreateContent></FolderCreateContent>Response content
<FolderName></FolderName>folder name
<FolderId></FolderId>ID of the new folder

Create Folder Example

Request

https://api.dynadot.com/api3.xml?key=mykey&command=create_folder&folder_name=new

Response

<FolderCreateResponse><FolderCreateHeader><SuccessCode>0</SuccessCode><Status>success</Status></FolderCreateHeader><FolderCreateContent><FolderName>new</FolderName><FolderId>2</FolderId></FolderCreateContent></FolderCreateResponse>

 

Delete Folder Command

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

Delete Folder Request Parameter
Explanation
folder_idThe ID of folders you want to delete, make sure that they separated by commas
Result XML tag
Explanation
<DeleteFolderResponse></DeleteFolderResponse>Root node of the response XML document
<DeleteFolderHeader></DeleteFolderHeader>Response header
<SuccessCode></SuccessCode>If the operation is successful, "0" for success, "-1" for failure
<Status></Status>The status of request
<Error></Error>Error information about the request, only used when status is "error"

Delete Folder Example

Request

https://api.dynadot.com/api3.xml?key=mykey&command=delete_folder&folder_id=0,1

Response

<DeleteFolderRespofoldere><DeleteFolderHeader><SuccessCode>0</SuccessCode><Status>success</Status></DeleteFolderHeader></DeleteFolderRespofoldere>

 

Set Folder Whois Command

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

Set Folder Whois Request Parameter
Explanation
folder_idThe folder's ID you want to set
registrant_contactThe registrant's information of the domain
admin_contactThe administrator's information of the domain
technical_contactThe technical information of the domain
billing_contactThe billing information of the domain
enable (optional)If you want to apply this Whois setting to future domains that you move to this folder, you can use this parameter with "yes"
sync (optional)If you want to synchronize this Whois setting of all domains in this folder, you can use this parameter with "yes"
Result XML tag
Explanation
<SetFolderWhoisResponse></SetFolderWhoisResponse>Root node of the response XML document
<SetFolderWhoisHeader></SetFolderWhoisHeader>Response header
<SuccessCode></SuccessCode>If the operation is successful, "0" for success, "-1" for failure
<Status></Status>The status of request
<Error></Error>Error information about the request, only used when status is "error"

Set Folder Whois Example

Request

https://api.dynadot.com/api3.xml?key=mykey&command=set_folder_whois&folder_id=0&registrant_contact=0&admin_contact=0&technical_contact=0&billing_contact=0

Response

<SetFolderWhoisResponse><SetFolderWhoisHeader><SuccessCode>0</SuccessCode><Status>success</Status></SetFolderWhoisHeader></SetFolderWhoisResponse>

 

Set Folder Name Servers Command

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

Set Folder Name Servers Request Parameter
Explanation
fold_idThe folder's ID you want to set, only 1 folder can be set per request
ns0 - ns12The name servers to set your domain to use, you can specify up to 13 name servers, but they must already be in your account
enable (optional)If you want to apply this name servers setting to future domains that you move to this folder, you can use this parameter with "yes"
sync (optional)If you want to synchronize name server setting of all domains in this folder, you can use this parameter with "yes"
Result XML tag
Explanation
<SetFolderNsResponse></SetFolderNsResponse>Tag of set folder name server response, it's the root node of the response XML document
<SetFolderNsHeader></SetFolderNsHeader>Tag of set folder name server response header
<SuccessCode></SuccessCode>If the operation is successful, "0" for success, "-1" for failure
<Status></Status>The status of request
<Error></Error>Error information about the request, only used when status is "error"
<SetFolderNsContent></SetFolderNsContent>Tag of set folder name server response content, it's only used when the status is "success"
<Servers></Servers>The information of the servers you have set
<Server></Server>Each server
<ServerName></ServerName>Server name
<ServerId></ServerId>Server ID

Set Folder Name Servers Example

Request

https://api.dynadot.com/api3.xml?key=mykey&command=set_folder_ns&folder_id=0&ns0=ns1.hosts.com&ns1=ns2.host.com&enable=yes&sync=yes

Response

<SetFolderNsResponse><SetFolderNsHeader><SuccessCode>0</SuccessCode><Status>success</Status></SetFolderNsHeader><SetFolderNsContent><Servers><Server><ServerName>ns1.hosts.com</ServerName><ServerId>0</ServerId></Server><Server><ServerName>ns2.host.com</ServerName><ServerId>1</ServerId></Server><Server><ServerName></ServerName><ServerId></ServerId></Server><Server><ServerName></ServerName><ServerId></ServerId></Server><Server><ServerName></ServerName><ServerId></ServerId></Server><Server><ServerName></ServerName><ServerId></ServerId></Server><Server><ServerName></ServerName><ServerId></ServerId></Server><Server><ServerName></ServerName><ServerId></ServerId></Server><Server><ServerName></ServerName><ServerId></ServerId></Server><Server><ServerName></ServerName><ServerId></ServerId></Server><Server><ServerName></ServerName><ServerId></ServerId></Server><Server><ServerName></ServerName><ServerId></ServerId></Server><Server><ServerName></ServerName><ServerId></ServerId></Server></Servers></SetFolderNsContent></SetFolderNsResponse>

 

Set Folder Parking Command

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

Set Folder Parking Request Parameter
Explanation
folder_idThe folder's ID you want to set, only 1 folder can be set per request
with_ads (optional)If you don't want a 3rd-party ads, you can use this parameter with "no", default value is "yes"
enable (optional)If you want to apply this parking setting to future domains that you move to this folder, you can use this parameter with "yes"
sync (optional)If you want to synchronize parking setting of all domains in this folder, you can use this parameter with "yes"
Result XML tag
Explanation
<SetFolderParkingResponse></SetFolderParkingResponse>Root node of the response XML document
<SetFolderParkingHeader></SetFolderParkingHeader>Response header
<SuccessCode></SuccessCode>If the operation is successful, "0" for success, "-1" for failure
<Status></Status>The status of request
<Error></Error>Error information about the request, only used when status is "error"

Set Folder Parking Example

Request

https://api.dynadot.com/api3.xml?key=mykey&command=set_folder_parking&folder_id=0&with_ads=no

Response

<SetFolderParkingResponse><SetFolderParkingHeader><SuccessCode>0</SuccessCode><Status>success</Status></SetFolderParkingHeader></SetFolderParkingResponse>

 

Set Folder Forwarding Command

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

Set Folder Forwarding Request Parameter
Explanation
folder_idThe folder's ID you want to set
forward_urlThe URL you want your domain forward to
is_temp (optional)Forward status of your domain you want, default value is "temporary", if you want to forward permanently, use this parameter with "no"
enable (optional)If you want to apply this forward setting to future domains that you move to this folder, you can use this parameter with "yes"
sync (optional)If you want to synchronize forward setting of all domains in this folder, you can use this parameter with "yes"
Result XML tag
Explanation
<SetFolderForwardingResponse></SetFolderForwardingResponse>Root node of the response XML document
<SetFolderForwardingHeader></SetFolderForwardingHeader>Response header
<SuccessCode></SuccessCode>If the operation is successful, "0" for success, "-1" for failure
<Status></Status>The status of request
<Error></Error>Error information about the request, only used when status is "error"

Set Folder Forwarding Example

Request

https://api.dynadot.com/api3.xml?key=mykey&command=set_folder_forwarding&folder_id=0&forward_url=http://mydomain.com&sync=yes

Response

<SetFolderForwardingResponse><SetFolderForwardingHeader><SuccessCode>0</SuccessCode><Status>success</Status></SetFolderForwardingHeader></SetFolderForwardingResponse>

 

Set Folder Stealth Command

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

Set Folder Stealth Request Parameter
Explanation
folder_idThe folder's ID that you want to set
stealth_urlThe URL you want your domain forward to
stealth_title (optional)The title of the page
enable (optional)If you want to apply this stealth setting to future domains that you move to this folder, you can use this parameter with "yes"
sync (optional)If you want to synchronize stealth setting of all domains in this folder, you can use this parameter with "yes"
Result XML tag
Explanation
<SetFolderStealthResponse></SetFolderStealthResponse>Root node of the response XML document
<SetFolderStealthHeader></SetFolderStealthHeader>Response header
<SuccessCode></SuccessCode>If the operation is successful, "0" for success, "-1" for failure
<Status></Status>The status of request
<Error></Error>Error information about the request, only used when status is "error"

Set Folder Stealth Example

Request

https://api.dynadot.com/api3.xml?key=mykey&command=set_folder_stealth&folder_id=0&stealth_title=obama's shop&stealth_url=http://www.obamashop.com&sync=yes

Response

<SetFolderStealthResponse><SetFolderStealthHeader><SuccessCode>0</SuccessCode><Status>success</Status></SetFolderStealthHeader></SetFolderStealthResponse>

 

Set Folder Hosting Command

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

Set Folder Hosting Request Parameter
Explanation
folder_idThe folder's ID you want to set
hosting_typeType of the hosting you want, you can select in "advanced" and "basic"
enable (optional)If you want to apply this hosting setting to future domains that you move to this folder, you can use this parameter with "yes"
even (optional)If you want to synchronize hosting setting of all domains in this folder, you can use this parameter with "yes"
Result XML tag
Explanation
<SetFolderHostingResponse></SetFolderHostingResponse>Root node of the response XML document
<SetFolderHostingHeader></SetFolderHostingHeader>Response header
<SuccessCode></SuccessCode>If the operation is successful, "0" for success, "-1" for failure
<Status></Status>The status of request
<Error></Error>Error information about the request, only used when status is "error"

Set Folder Hosting Example

Request

https://api.dynadot.com/api3.xml?key=mykey&command=set_folder_hosting&folder_id=0&hosting_type=advanced&sync=yes

Response

<SetFolderHostingResponse><SetFolderHostingHeader><SuccessCode>0</SuccessCode><Status>success</Status></SetFolderHostingHeader></SetFolderHostingResponse>

 

Set Folder DNS Command

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

Set Folder DNS Request Parameter
Explanation
folder_idThe ID of the folder which you want to set
main_record_typeMain record type
main_recordSpecify a DNS record for your domain
main_recordSpecify a DNS record for your domain
with_ads (optional)Specify a TXT record for your domain. If your main_record_type is aaaa and specified a main_record2, you can set upto 3 main_txts, otherwise, you can set upto 4 main_txts.
main_record2Main record 2, only used when "main_record_type" is "aaaa". Its value must be in ipv4 format.
subdomain0 - subdomain20 (optional)Subdomain records (optional)
sub_record_type0 - sub_record_type20 (optional)Subdomain records type
sub_record0 - sub_record20 (optional)IP address or target host
mx_host0 - mx_host2 (optional)Specify the mail host for your domain, distance0 is the highest priority.
mx_distance0 - mx_distance2 (optional)Distance0 is highest priority
ttl (optional)Time to live
enable (optional)If you want to apply this DNS setting to future domains that you move to this folder, you can use this parameter with "yes"
sync (optional)If you want to synchronize this DNS server setting of all domains in this folder, you can use this parameter with "yes"
Result XML tag
Explanation
<SetFolderDnsResponse></SetFolderDnsResponse>Root node of the response XML document
<SetFolderDnsHeader></SetFolderDnsHeader>Response header
<SuccessCode></SuccessCode>If the operation is successful, "0" for success, "-1" for failure
<Status></Status>The status of request
<Error></Error>Error information about the request, only used when status is "error"

Set Folder DNS Example

Request

https://api.dynadot.com/api3.xml?key=mykey&command=set_folder_dns&folder_id=0&main_record_type=aaaa&main_record=0:0:0:0:0:0:0:1

Response

<SetDnsResponse><SetDnsHeader><SuccessCode>0</SuccessCode><Status>success</Status></SetDnsHeader></SetDnsResponse>

 

Set Folder Free Hosting

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

Set Folder Free Hosting Request Parameter
Explanation
folder_idFolder ID you want to set
enable (optional)If you want to apply this free hosting setting to future domains that you move to this folder, you can use this parameter with "yes"
sync (optional)If you want to synchronize this free hosting setting of all domains in this folder, you can use this parameter with "yes"
style (optional)The style of the free page
titleThe title of the free page
bodyThe main part of the page, HTML is allowed but the following tags should not be included: <html>,<title>, <body>, <meta>, <script>; please note that any HTML entered in the body is not validated
Result XML tag
Explanation
<SetFolderFreeHostingResponse></SetFolderFreeHostingResponse>Tag of set folder free hosting response, it's the root node of the response XML document
<SetFolderFreeHostingHeader></SetFolderFreeHostingHeader>Set folder free hosting folder header
<SuccessCode></SuccessCode>If the operation is successful, "0" for success, "-1" for failure
<Status></Status>The status of request
<Error></Error>Error information about the request, only used when status is "error"

Set Folder Free Hosting Example

Request

https://api.dynadot.com/api3.xml?key=mykey&command=set_folder_free_hosting&folder_id=0&title=obama's shop&body=Welcome to obama's shop&enable=yes&sync=yes

Response

<SetFolderFreeHostResponse><SetFolderFreeHostHeader><SuccessCode>0</SuccessCode><Status>success</Status></SetFolderFreeHostHeader></SetFolderFreeHostResponse>

 

Set Folder Email Forward Command

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

Set Folder Email Forward Request Parameter
Explanation
domainThe domain name you want to set, 100 domains can be set per request, make sure they are separated by commas
folder_idID of the folder you want to set
forward_typeForward type, it can be "donot": Do not forward email, "mx": Deliver email to another mail host (MX record), "forward": Deliver email to another mail host
username0 - username9Username, only used when "forward_type" is "forward"
exist_email0 - exist_email9Existing email address, only used when "forward_type" is "forward"
mx_host0 - mx_host2Mail host, only used when "forward_type" is "mx"
mx_distance0 - mx_distance2Distance0 is the highest priority, only used when "forward_type" is "mx"
enable (optional)If you want to apply this setting to future domains that you move to this folder, you can use this parameter with "yes"
sync (optional)If you want to synchronize this setting of all domains in this folder, you can use this parameter with "yes"
Result XML tag
Explanation
<SetFolderEmailForwardingResponse></SetFolderEmailForwardingResponse>Root node of the response XML document
<SetFolderEmailForwardingHeader></SetFolderEmailForwardingHeader>Response header
<SuccessCode></SuccessCode>If the operation is successful, "0" for success, "-1" for failure
<Status></Status>The status of request
<Error></Error>Error information about the request, only used when status is "error"

Set Folder Email Forward Example

Request

https://api.dynadot.com/api3.xml?key=mykey&command=set_folder_email_forward&folder_id=0&forward_type=forward&username0=peter&exist_email0=peter@dynadot.com

Response

<SetFolderEmailForwardingResponse><SetFolderEmailForwardingHeader><SuccessCode>0</SuccessCode><Status>success</Status></SetFolderEmailForwardingHeader></SetFolderEmailForwardingResponse>

 

Set Clear Folder Setting Command

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

Set Clear Folder Setting Request Parameter
Explanation
folder_idThe folder's ID you want to set
serviceThe service you want to clear, it can be "forward", "stealth", "email_forwarding", "free_hosting", "dns", and "nameservers"
Result XML tag
Explanation
<SetClearFolderSettingResponse></SetClearFolderSettingResponse>Root node of the response XML document
<SetClearFolderSettingHeader></SetClearFolderSettingHeaderr>Response header
<SuccessCode></SuccessCode>If the operation is successful, "0" for success, "-1" for failure
<Status></Status>The status of request
<Error></Error>Error information about the request, only used when status is "error"

Set Clear Folder Setting Example

Request

https://api.dynadot.com/api3.xml?key=mykey&command=set_clear_folder_setting&folder_id=0&service=nameservers

Response

<SetClearFolderSettingResponse><SetClearFolderSettingHeader><SuccessCode>0</SuccessCode><Status>success</Status></SetClearFolderSettingHeader></SetClearFolderSettingResponse>

 

Set Folder Name Command

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

Set Folder Name Request Parameter
Explanation
folder_idID of the folder that you want to set
folder_nameNew folder name
Result XML tag
Explanation
<SetFolderNameResponse></SetFolderNameResponse>Root node of the response XML document
<SetFolderNameHeader></SetFolderNameHeader>Response header
<SuccessCode></SuccessCode>If the operation is successful, "0" for success, "-1" for failure
<Status></Status>The status of request
<Error></Error>Error information about the request, only used when status is "error"

Set Folder Name Example

Request

https://api.dynadot.com/api3.xml?key=mykey&command=set_folder_name&folder_id=0&folder_name=new

Response

<SetFolderNameResponse><SetFolderNameHeader><SuccessCode>0</SuccessCode><Status>success</Status></SetFolderNameHeader></SetFolderNameResponse>

 

Set Folder Renew Option Command

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

Set Folder Renew Option Request Parameter
Explanation
folder_idThe folder's ID you want to set, only 1 folder can be set per request
renew_optionThe renew option you want to set to the folder; it can be "donot","auto" or "reset"
enable (optional)If you want to apply this renew setting to future domains that you move to this folder, you can use this parameter with "yes"
sync (optional)If you want to synchronize renew setting of all domains in this folder, you can use this parameter with "yes"
Result XML tag
Explanation
<Response></Response>Root node of the response XML document
<ResponseHeader></ResponseHeader>ResponseHeader
<ResponseCode></ResponseCode>Response code, "0" for success, "-1" for failed
<Error></Error>Error information, it is only used when response code is "-1"

Set Folder Renew Option Example

Request

https://api.dynadot.com/api3.xml?key=mykey&command=set_folder_renew_option&folder_id=0

Response

<Response><ResponseHeader><ResponseCode>0</ResponseCode></ResponseHeader></Response>

 

Folder List Command

This command is only available in XML format:

Folder List Request Parameter
Explanation
N/ANo extra parameter needed
<FolderListResponse></FolderListResponse>Root node of the response XML document
<FolderListHeader></FolderListHeader>Response header
<SuccessCode></SuccessCode>If the operation is successful, "0" for success, "-1" for failure
<Status></Status>The status of request
<Error></Error>Error information about the request, only used when status is "error"
<FolderListContent></FolderListContent>Response content
<FolderList></FolderList>Folder list
<List></List>
<Folder></Folder>
<FolderId></FolderId>Folder ID
<FolderName></FolderName>Folder name
<DefaultWhois></DefaultWhois>Default Whois
<DefaultWhoisEnableStatus></DefaultWhoisEnableStatus>Default Whois enable status
<DefaultRegistrant></DefaultRegistrant>Default registrant
<ContactId></ContactId>Contact's ID
<DefaultAdmin></DefaultAdmin>Default admin
<DefaultTechnical></DefaultTechnical>Default technical info
<DefaultBilling></DefaultBilling>Default billing info
<DefaultNameServerEnableStatus></DefaultNameServerEnableStatus>Default name server enable status
<NameServerSettings></NameServerSettings>Name server settings
<Type></Type>Name server type
<WithAds></WithAds>With ads or not
<DefaultRenewOption></DefaultRenewOption>Default renew option
<DefaultRenewOptionEnableStatus></DefaultRenewOptionEnableStatus>Default renew option enable status
<RenewOption></RenewOption>Renew option
<DefaultTransferLock></DefaultTransferLock>Default transfer lock
<DefaultTransferLockEnableStatus></DefaultTransferLockEnableStatus>Default transfer lock enable status
<LockStatus></LockStatus>Lock status

Folder List Example

Request

https://api.dynadot.com/api3.xml?key=mykey&command=folder_list

Response
<FolderListResponse>
  <FolderListHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </FolderListHeader>
  <FolderListContent>
    <FolderList>
      <List>
        <Folder>
          <FolderId>0</FolderId>
          <FolderName>new</FolderName>
          <DefaultWhois>
            <DefaultWhoisEnableStatus>disable</DefaultWhoisEnableStatus>
            <DefaultRegistrant>
              <ContactId>0</ContactId>
            </DefaultRegistrant>
            <DefaultAdmin>
              <ContactId>0</ContactId>
            </DefaultAdmin>
            <DefaultTechnical>
              <ContactId>0</ContactId>
            </DefaultTechnical>
            <DefaultBilling>
              <ContactId>0</ContactId>
            </DefaultBilling>
          </DefaultWhois>
          <DefaultNameServers>
            <DefaultNameServerEnableStatus>disable</DefaultNameServerEnableStatus>
            <NameServerSettings>
              <Type>Dynadot Parking</Type>
              <WithAds>yes</WithAds>
            </NameServerSettings>
          </DefaultNameServers>
          <DefaultRenewOption>
            <DefaultRenewOptionEnableStatus>disable</DefaultRenewOptionEnableStatus>
            <RenewOption>no renew option</RenewOption>
          </DefaultRenewOption>
          <DefaultTransferLock>
            <DefaultTransferLockEnableStatus>disable</DefaultTransferLockEnableStatus>
            <LockStatus>locked</LockStatus>
          </DefaultTransferLock>
        </Folder>
      </List>
    </FolderList>
  </FolderListContent>
</FolderListResponse>
 

Add Backorder Request Command

If calling add backorder request command, the following parameters should be included:

Add Backorder Request Request Parameter
Explanation
domainThe domain(s) you want to add and agree to pay for if Dynadot catches it, 100 domains can be added per request, they should be separated by commas
Result XML tag
Explanation
<AddBackorderRequestResponse></AddBackorderRequestResponse>Root node of the response XML document
<AddBackorderRequestHeader></AddBackorderRequestHeader>Response header
<SuccessCode></SuccessCode>If the operation is successful, "0" for success, "-1" for failure
<Status></Status>The status of request
<Error></Error>Error information about the request, only used when status is "error"

Add Backorder Request Example

Request

https://api.dynadot.com/api3.xml?key=mykey&command=add_backorder_request&domain=droppingdomain.com,domaindropping.net,domaindrop.org

Response
<AddBackorderRequestResponse>
  <AddBackorderRequestHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </AddBackorderRequestHeader>
</AddBackorderRequestResponse>
 

Delete Backorder Request Command

If calling delete backorder request command, the following parameters should be included:

Delete Backorder Request Request Parameter
Explanation
domainThe domain(s) you want to remove from your backorder request list, 100 domains can be removed per request, they should be separated by commas
Result XML tag
Explanation
<DeleteBackorderRequestResponse></DeleteBackorderRequestResponse>Root node of the response XML document
<DeleteBackorderRequestHeader></DeleteBackorderRequestHeader>Response header
<SuccessCode></SuccessCode>If the operation is successful, "0" for success, "-1" for failure
<Status></Status>The status of request
<Error></Error>Error information about the request, only used when status is "error"

Delete Backorder Request Example

Request

https://api.dynadot.com/api3.xml?key=mykey&command=delete_backorder_request&domain=domaindropp.com

Response
<DeleteBackorderRequestResponse>
  <DeleteBackorderRequestHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </DeleteBackorderRequestHeader>
</DeleteBackorderRequestResponse>
 

Backorder Request List Command

Calling the backorder request list command will return a list of backorder request list of specified account. If calling this command, the following parameters should be included:

Backorder Request List Request Parameter
Explanation
startDateStart drop date of auction you want to request, yyyy-mm-dd, like 2015-05-05
endDateEnd drop date of auction you want to request, yyyy-mm-dd, like 2015-05-05
Result XML tag
Explanation
<BackorderRequestListResponse></BackorderRequestListResponse>Root node of the response XML document
<BackorderRequestListHeader></BackorderRequestListHeader>Response header
<SuccessCode></SuccessCode>If the operation is successful, "0" for success, "-1" for failure
<Status></Status>The status of request
<Error></Error>Error information about the request, only used when status is "error"
<BackorderRequestListContent></BackorderRequestListContent>Response content
<BackorderRequestList></BackorderRequestList>Backorder Request List
<BackorderRequest></BackorderRequest>Backorder Request
<Domain></Domain>Domain on your list
<CutoffTime></CutoffTime>Cutoff date to delete a request in Unix time (milliseconds since midnight UTC of January 1, 1970)
<BackorderRequestStatus></BackorderRequestStatus>Status in the drop catching process

Backorder Request List Example

Request

https://api.dynadot.com/api3.xml?key=mykey&command=backorder_request_list&month=1&day=31&year=2014

Response
<BackorderRequestListResponse>
  <BackorderRequestListHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </BackorderRequestListHeader>
  <BackorderRequestListContent>
    <BackorderRequestList>
      <BackorderRequest>
        <DomainName>testdrop.com</DomainName>
        <CutoffTime>1403914140000</CutoffTime>
        <BackorderRequestStatus>Active</BackorderRequestStatus>
      </BackorderRequest>
      <BackorderRequest>
        <DomainName>testdrop3.com</DomainName>
        <CutoffTime>1403914140000</CutoffTime>
        <BackorderRequestStatus>Active</BackorderRequestStatus>
      </BackorderRequest>
      <BackorderRequest>
        <DomainName>testdrop4.com</DomainName>
        <CutoffTime>1403914140000</CutoffTime>
        <BackorderRequestStatus>Active</BackorderRequestStatus>
      </BackorderRequest>
      <BackorderRequest>
        <DomainName>testdrop5.com</DomainName>
        <CutoffTime>1403914140000</CutoffTime>
        <BackorderRequestStatus>Active</BackorderRequestStatus>
      </BackorderRequest>
    </BackorderRequestList>
  </BackorderRequestListContent>
</BackorderRequestListResponse>
Request(csv format)

http://api.dynadot.com/api3.html?key=1&command=backorder_request_list&startDate=2015-01-01&endDate=2015-5-20

Response

ok,
success,
Domain,CutoffTime,BackorderRequestStatus
domain.com,1431661200000,Active
domain2.com,1431661200000,Success
domain3.com,1431661200000,Success
.
.
.

 

Get Open Auctions Command

Calling the get open auctions command will return a list of auctions which are in progress. If calling this command, the following parameters should be included:

Get Open Auctions Request Parameter
Explanation
currency (optional)The currency of return result, it should be "usd", "eur", or "cny", default currency is US Dollars
Result XML tag
Explanation
<GetOpenAuctionsResponse></GetOpenAuctionsResponse>Tag of get open auctions response, it's the root node of the response XML document
<GetOpenAuctionsHeader></GetOpenAuctionsHeader>Get open auctions header
<SuccessCode></SuccessCode>If the operation is successful, "0" for success, "-1" for failure
<Status></Status>The status of request
<Error></Error>Error information about the request, only used when status is "error"
<GetOpenAuctionsContent></GetOpenAuctionsContent>Tag of get open auctions content, it's only used when status is "success"
<Auction></Auction>Tag of auction item, it's only used when status is "success"
<AuctionId></AuctionId>ID of auction
<Domain></Domain>Domain name of auction
<BidPrice></BidPrice>Current bid price of auction
<BidPriceCurrency></BidPriceCurrency>Currency of bid price
<Bids></Bids>Count of auction bids
<EndTime></EndTime>End time of auction
<EndTimestamp></EndTimestamp>End date of auction in Unix time (milliseconds since midnight UTC of January 1, 1970)
<Revenue></Revenue>Revenue of auction
<RevenueCurrency></RevenueCurrency>Currency of revenue
<Visitors></Visitors>Visitors of domain
<Links></Links>Inbound links of domain
<Age></Age>Age of domain

Get Open Auctions Example

Request(xml format)

https://api.dynadot.com/api3.xml?key=mykey&command=get_open_auctions&currency=usd

Response
<GetOpenAuctionsResponse>
  <GetOpenAuctionsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </GetOpenAuctionsHeader>
  <GetOpenAuctionsContent>
    <Auction>
           <AuctionId>0</AuctionId>
            <Domain>domain.com</Domain>
            <BidPrice>63.99</BidPrice>
            <BidPriceCurrency>USD</BidPriceCurrency>
            <Bids>0</Bids>
            <EndTime>2015/04/28 05:46 UTC</EndTime>
            <EndTimestamp>1430199960354</EndTimestamp>
            <Revenue>72</Revenue>
            <RevenueCurrency>USD</RevenueCurrency>
            <Visitors>-1</Visitors>
            <Links>-1</Links>
            <Age>1</Age>
    </Auction>
    <Auction>
           <AuctionId>0</AuctionId>
            <Domain>domain.com</Domain>
            <BidPrice>63.99</BidPrice>
            <BidPriceCurrency>USD</BidPriceCurrency>
            <Bids>0</Bids>
            <EndTime>2015/04/28 05:46 UTC</EndTime>
            <EndTimestamp>1430199960354</EndTimestamp>
            <Revenue>72</Revenue>
            <RevenueCurrency>USD</RevenueCurrency>
            <Visitors>-1</Visitors>
            <Links>-1</Links>
            <Age>1</Age>
    </Auction>
    .
    .
    .
  </GetOpenAuctionsContent>
</GetOpenAuctionsResponse>
Request(csv format)

https://api.dynadot.com/api3.html?key=mykey&command=get_open_auctions&currency=usd

Response

ok,
success,
AuctionId,Domain,BidPrice,BidPriceCurrency,Bids,EndTime,EndTimestamp,Revenue,RevenueCurrency,Visitors,Links,Age
10001,domain.com,92.99,USD,0,2015/04/28 18:04 UTC,1430244248274,0.64,USD,-1,-1,1
10002,xn--wkccg.com,77.99,USD,0,2015/05/01 06:04 UTC,1430460248338,86,USD,435,-1,1
10003,domain2.com,11.25,USD,0,2015/05/05 06:04 UTC,1430805846946,91,USD,358,-1,1
.
.
.

 

Get Auction Details Command

Calling the get auction details command will return the details of auction specified. This command is only available in XML format. If calling this command, the following parameters should be included:

Get Auction Details Request Parameter
Explanation
domainThe domain name of auction, IDN(International Domain Name) should use punycode, such as "xn--wkccg.com"
currency (optional)The currency of return result, it should be "usd", "eur", or "cny", default currency is US Dollars
Result XML tag
Explanation
<GetAuctionDetailsResponse></GetAuctionDetailsResponse>Tag of get auction details response, it's the root node of the response XML document
<GetAuctionDetailsHeader></GetAuctionDetailsHeader>Get backorder auction details header
<SuccessCode></SuccessCode>If the operation is successful, "0" for success, "-1" for failure
<Status></Status>The status of request
<Error></Error>Error information about the request, only used when status is "error"
<GetAuctionDetailsContent></GetAuctionDetailsContent>Tag of get auction details content, it's only used when status is "success"
<AuctionStatusId></AuctionStatusId>Status id of auction, '0' for In Progress and '1' for Closed by Admin, '2' for Closed by Timeout, '3' for Problem
<AuctionStatus></AuctionStatus>Status of auction
<UserIsHighBid></UserIsHighBid>If user is the highest bid
<YourCurrentBid></YourCurrentBid>Your current bid price for specified auction. If you haven't placed a bid, it will be '-1'
<YourProxyBid></YourProxyBid>Your proxy bid for specified auction. If you haven't placed a bid, it will be '-1'
<AuctionId></AuctionId>ID of auction
<Domain></Domain>Domain name of auction
<BidPrice></BidPrice>Current bid price of auction
<BidPriceCurrency></BidPriceCurrency>Currency of bid price
<Bids></Bids>Count of auction bids
<EndTime></EndTime>End time of auction
<EndTimestamp></EndTimestamp>End date of auction in Unix time (milliseconds since midnight UTC of January 1, 1970)

Get Auction Details Example

Request

https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=get_auction_details&domain=domain0.com&currency=usd

Response
<GetAuctionDetailsResponse>
 <GetAuctionDetailsHeader>
   <SuccessCode>0</SuccessCode>
   <Status>success</Status>
 </GetAuctionDetailsHeader>
 <GetAuctionDetailsContent>
   <AuctionStatusId>0</AuctionStatusId>
   <AuctionStatus>In Progress</AuctionStatus>
   <UserIsHighBid>No</UserIsHighBid>
   <YourCurrentBid>-1</YourCurrentBid>
   <YourProxyBid>-1</YourProxyBid>
   <Auction>
     <AuctionId>0</AuctionId>
     <Domain>domain0.com</Domain>
     <BidPrice>6.35</BidPrice>
     <BidPriceCurrency>CNY</BidPriceCurrency>
     <Bids>0</Bids>
     <EndTime>2017/09/03 17:12 UTC</EndTime>
     <EndTimestamp>1504458737058</EndTimestamp>
   </Auction>
 </GetAuctionDetailsContent>
</GetAuctionDetailsResponse>
 

Place Auction Bid Command

Calling the place auction bid command will place a bid for specified auction. If calling this command, the following parameters should be included:

Place Auction Bid Request Parameter
Explanation
domainThe domain name of auction, IDN (Internationalized Domain Name) should use punycode, such as "xn--wkccg.com"
bid_amountYour bid amount for auction, default currency is US Dollars, you can also specify it by currency parameter below
currency (optional)The currency of your bid, it should be "usd", "eur", or "cny", default currency is US Dollars
Result XML tag
Explanation
<PlaceAuctionBidResponse></PlaceAuctionBidResponse>Tag of place auction bid response, it's the root node of the response XML document
<PlaceAuctionBidHeader></PlaceAuctionBidHeader>Place auction bid header
<SuccessCode></SuccessCode>If the operation is successful, "0" for success, "-1" for failure
<Status></Status>The status of request
<Error></Error>Error information about the request, only used when status is "error"

Domain Example

Request(xml format)

https://api.dynadot.com/api3.xml?key=mykey&command=place_auction_bid&domain=example.com&bid_amount=99.9&currency=usd

Response
<PlaceAuctionBidResponse>
  <PlaceAuctionBidHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </PlaceAuctionBidHeader>
</PlaceAuctionBidResponse>
Request(csv format)

https://api.dynadot.com/api3.html?key=mykey&command=place_auction_bid&domain=example.com&bid_amount=99.9&currency=usd

Response

ok,success

 

Get Closed Auctions Command

Calling the get closed auctions command will return a list of closed auctions of specified account. If calling this command, the following parameters should be included:

Get Closed Auctions Request Parameter
Explanation
startDateStart date of auction, yyyy-mm-dd, like 2015-05-05
endDateEnd date of auction, yyyy-mm-dd, like 2015-05-05
currency (optional)The currency of your bid, it should be "usd", "eur", or "cny", default currency is US Dollars
Result XML tag
Explanation
<GetClosedAuctionsResponse></GetClosedAuctionsResponse>Tag of get closed auctions response, it's the root node of the response XML document
<GetClosedAuctionsHeader></GetClosedAuctionsHeader>Get closed auctions header
<SuccessCode></SuccessCode>If the operation is successful, "0" for success, "-1" for failure
<Status></Status>The status of request
<Error></Error>Error information about the request, only used when status is "error"
<GetClosedAuctionsContent></GetClosedAuctionsContent>Tag of get closed auctions content, it's only used when status is "success"
<Auction></Auction>Tag of auction item, it's only used when status is "success"
<AuctionId></AuctionId>ID of auction
<Domain></Domain>Domain name of auction
<AuctionStatusId></AuctionStatusId>Status id of auction, '0' for In Progress and '1' for Closed by User, '2' for Closed by Admin, '3' for Closed by Renewal, '4' for Closed by Timeout, '5' for Closed by Transfer Away
<AuctionStatus></AuctionStatus>Status of auction
<BidPrice></BidPrice>Current bid price of auction
<BidPriceCurrency></BidPriceCurrency>Currency of bid price
<Bids></Bids>Count of auction bids
<AuctionWonStatus></AuctionWonStatus>If user won this auction
<YourHighBid></YourHighBid>Your high bid for this auction
<YourProxyBid></YourProxyBid>Your proxy bid for this auction

Domain Example

Request(xml format)

https://api.dynadot.com/api3.xml?key=1&command=get_closed_auctions&startDate=2000-01-02&endDate=2015-5-15

Response
<GetClosedAuctionsResponse>
  <GetClosedAuctionsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </GetClosedAuctionsHeader>
  <GetClosedAuctionsContent>
    <Auction>
      <AuctionId>2</AuctionId>
      <Domain>domain-exp143.ooo</Domain>
      <AuctionStatusId>4</AuctionStatusId>
      <AuctionStatus>Closed by Timeout</AuctionStatus>
      <BidPrice>89.99</BidPrice>
      <BidPriceCurrency>USD</BidPriceCurrency>
      <Bids>1</Bids>
      <AuctionWonStatus>won</AuctionWonStatus>
      <YourHighBid>89.99</YourHighBid>
      <YourProxyBid>1000.0</YourProxyBid>
    </Auction>
    <Auction>
      <AuctionId>3</AuctionId>
      <Domain>domain-exp144.vc</Domain>
      <AuctionStatusId>4</AuctionStatusId>
      <AuctionStatus>Closed by Timeout</AuctionStatus>
      <BidPrice>28.99</BidPrice>
      <BidPriceCurrency>USD</BidPriceCurrency>
      <Bids>1</Bids>
      <AuctionWonStatus>won</AuctionWonStatus>
      <YourHighBid>28.99</YourHighBid>
      <YourProxyBid>1000.0</YourProxyBid>
    </Auction>
  </GetClosedAuctionsContent>
</GetClosedAuctionsResponse>
Request(csv format)

http://api.dynadot.com/api3.html?key=1&command=get_closed_auctions&startDate=2000-01-02&endDate=2015-5-15

Response

ok,
success,
AuctionId,Domain,AuctionStatusId,AuctionStatus,BidPrice,BidPriceCurrency,Bids,AuctionWonStatus,YourHighBid,YourProxyBid
2,domain.com,4,Closed by Timeout,89.99,USD,1,won,89.99,200
3,domain.com,4,Closed by Timeout,28.99,USD,1,won,28.99,300
.
.
.

 

Get Open Backorder Auctions Command

Calling the get open backorder auctions command will return a list of backorder auctions which are in progress. If calling this command, the following parameters should be included:

Get Open Backorder Auctions Request Parameter
Explanation
currency (optional)The currency of return result, it should be "usd", "eur", or "cny", default currency is US Dollars
Result XML tag
Explanation
<GetOpenBackorderAuctionsResponse></GetOpenBackorderAuctionsResponse>Tag of get open backorder auctions response, it's the root node of the response XML document
<GetOpenBackorderAuctionsHeader></GetOpenBackorderAuctionsHeader>Get open backorder auctions header
<SuccessCode></SuccessCode>If the operation is successful, "0" for success, "-1" for failure
<Status></Status>The status of request
<Error></Error>Error information about the request, only used when status is "error"
<GetOpenBackorderAuctionsContent></GetOpenBackorderAuctionsContent>Tag of get open backorder auctions content, it's only used when status is "success"
<Auction></Auction>Tag of auction item, it's only used when status is "success"
<AuctionId></AuctionId>ID of auction
<Domain></Domain>Domain name of auction
<BidPrice></BidPrice>Current bid price of auction
<BidPriceCurrency></BidPriceCurrency>Currency of bid price
<Bids></Bids>Count of auction bids
<EndTime></EndTime>End time of auction
<EndTimestamp></EndTimestamp>End date of auction in Unix time (milliseconds since midnight UTC of January 1, 1970)

Get Open Backorder Auctions Example

Request(xml format)

https://api.dynadot.com/api3.xml?key=mykey&command=get_open_backorder_auctions&currency=usd

Response
<GetOpenBackorderAuctionsResponse>
  <GetOpenBackorderAuctionsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </GetOpenBackorderAuctionsHeader>
  <GetOpenBackorderAuctionsContent>
    <Auction>
           <AuctionId>0</AuctionId>
            <Domain>domain.com</Domain>
            <BidPrice>63.99</BidPrice>
            <BidPriceCurrency>USD</BidPriceCurrency>
            <Bids>0</Bids>
            <EndTime>2015/04/28 05:46 UTC</EndTime>
            <EndTimestamp>1430199960354</EndTimestamp>
    </Auction>
    <Auction>
           <AuctionId>0</AuctionId>
            <Domain>domain.com</Domain>
            <BidPrice>63.99</BidPrice>
            <BidPriceCurrency>USD</BidPriceCurrency>
            <Bids>0</Bids>
            <EndTime>2015/04/28 05:46 UTC</EndTime>
            <EndTimestamp>1430199960354</EndTimestamp>
    </Auction>
    .
    .
    .
  </GetOpenBackorderAuctionsContent>
</GetOpenBackorderAuctionsResponse>
Request(csv format)

https://api.dynadot.com/api3.html?key=mykey&command=get_open_backorder_auctions&currency=usd

Response

ok,
success,
AuctionId,Domain,BidPrice,BidPriceCurrency,Bids,EndTime,EndTimestamp
10000,backorder0.com,6.35,USD,0,2017/08/29 17:53 UTC,1504029194453
10001,backorder1.com,1.0,USD,0,2017/08/29 17:53 UTC,1504029194453
10002,backorder2.com,1.0,USD,0,2017/08/29 17:53 UTC,1504029194453
.
.
.

 

Get Backorder Auction Details Command

Calling the get backorder auction details command will return the details of auction specified. This command is only available in XML format. If calling this command, the following parameters should be included:

Get Auction Details Request Parameter
Explanation
domainThe domain name of backorder auction, IDN(International Domain Name) should use punycode, such as "xn--wkccg.com"
currency (optional)The currency of return result, it should be "usd", "eur", or "cny", default currency is US Dollars
Result XML tag
Explanation
<GetBackorderAuctionDetailsResponse></GetBackorderAuctionDetailsResponse>Tag of get auction details response, it's the root node of the response XML document
<GetAuctionDetailsHeader></GetAuctionDetailsHeader>Get auction details header
<SuccessCode></SuccessCode>If the operation is successful, "0" for success, "-1" for failure
<Status></Status>The status of request
<Error></Error>Error information about the request, only used when status is "error"
<GetAuctionDetailsContent></GetAuctionDetailsContent>Tag of get auction details content, it's only used when status is "success"
<AuctionStatusId></AuctionStatusId>Status id of auction, '0' for In Progress and '1' for Closed by User, '2' for Closed by Admin, '3' for Closed by Renewal, '4' for Closed by Timeout, '5' for Closed by Transfer Away
<AuctionStatus></AuctionStatus>Status of auction
<AuctionId></AuctionId>ID of auction
<Domain></Domain>Domain name of auction
<BidPrice></BidPrice>Current bid price of auction
<BidPriceCurrency></BidPriceCurrency>Currency of bid price
<Bids></Bids>Count of auction bids
<EndTime></EndTime>End time of auction
<EndTimestamp></EndTimestamp>End date of auction in Unix time (milliseconds since midnight UTC of January 1, 1970)
<Revenue></Revenue>Revenue of auction
<RevenueCurrency></RevenueCurrency>Currency of revenue
<Visitors></Visitors>Visitors of domain
<Links></Links>Inbound links of domain
<Age></Age>Age of domain
<UserIsHighBid></UserIsHighBid>If user is the highest bid
<YourCurrentBid></YourCurrentBid>Your current bid price for specified auction. If you haven't placed a bid, it will be '-1'
<YourProxyBid></YourProxyBid>Your proxy bid for specified auction. If you haven't placed a bid, it will be '-1'

Get Backorder Auction Details Example

Request

https://api.dynadot.com/api3.xml?key=mykey&command=get_backorder_auction_details&domain=example.com&currency=usd

Response
<GetBackorderAuctionDetailsResponse>
  <GetAuctionDetailsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </GetAuctionDetailsHeader>
  <GetAuctionDetailsContent>
    <Auction>
      <AuctionStatusId>0</AuctionStatusId>
      <AuctionStatus>IN_PROGRESS</AuctionStatus>
      <AuctionId>10001</AuctionId>
      <Domain>example.com</Domain>
      <BidPrice>89.99</BidPrice>
      <BidPriceCurrency>USD</BidPriceCurrency>
      <Bids>0</Bids>
      <EndTime>2015/04/28 18:16 UTC</EndTime>
      <EndTimestamp>1430244969779</EndTimestamp>
      <Revenue>114</Revenue>
      <RevenueCurrency>USD</RevenueCurrency>
      <Visitors>-1</Visitors>
      <Links>-1</Links>
      <Age>1</Age>
      <UserIsHighBid>false</UserIsHighBid>
      <YourCurrentBid>-1</YourCurrentBid>
      <YourProxyBid>-1</YourProxyBid>
    </Auction>
  </GetAuctionDetailsContent></GetBackorderAuctionDetailsResponse>
 

Place Backorder Auction Bid Command

Calling the place backorder auction bid command will place a bid for specified backorder auction. If calling this command, the following parameters should be included:

Place Backorder Auction Bid Request Parameter
Explanation
domainThe domain name of auction, IDN (Internationalized Domain Name) should use punycode, such as "xn--wkccg.com"
bid_amountYour bid amount for auction, default currency is US Dollars, you can also specify it by currency parameter below
currency (optional)The currency of your bid, it should be "usd", "eur", or "cny", default currency is US Dollars
Result XML tag
Explanation
<PlaceBakcorderAuctionBidResponse></PlaceBakcorderAuctionBidResponse>Tag of place auction bid response, it's the root node of the response XML document
<PlaceBackorderAuctionBidHeader></PlaceBackorderAuctionBidHeader>Place auction bid header
<SuccessCode></SuccessCode>If the operation is successful, "0" for success, "-1" for failure
<Status></Status>The status of request
<Error></Error>Error information about the request, only used when status is "error"

Place Backorder Auction Bid Example

Request(xml format)

https://api.dynadot.com/api3.xml?key=mykey&command=place_backorder_auction_bid&domain=example.com&bid_amount=99.9&currency=usd

Response
<PlaceBakcorderAuctionBidResponse>
 <PlaceBackorderAuctionBidHeader>
   <SuccessCode>0</SuccessCode>
   <Status>success</Status>
 </PlaceBackorderAuctionBidHeader>
</PlaceBakcorderAuctionBidResponse>
Request(csv format)

https://api.dynadot.com/api3.html?key=mykey&command=place_backorder_auction_bid&domain=example.com&bid_amount=99.9&currency=usd

Response

ok,success

 

Get Closed Backorder Auctions Command

Calling the get closed backorder auctions command will return a list of closed backorder auctions of specified account. If calling this command, the following parameters should be included:

Get Closed Backorder Auctions Request Parameter
Explanation
startDateStart date of auction, yyyy-mm-dd, like 2015-05-05
endDateEnd date of auction, yyyy-mm-dd, like 2015-05-05
currency (optional)The currency of your bid, it should be "usd", "eur", or "cny", default currency is US Dollars
Result XML tag
Explanation
<GetClosedBackorderAuctionsResponse></GetClosedBackorderAuctionsResponse>Tag of get closed auctions response, it's the root node of the response XML document
<GetClosedBackorderAuctionsHeader></GetClosedBackorderAuctionsHeader>Get closed auctions header
<SuccessCode></SuccessCode>If the operation is successful, "0" for success, "-1" for failure
<Status></Status>The status of request
<Error></Error>Error information about the request, only used when status is "error"
<GetClosedBackorderAuctionsContent></GetClosedBackorderAuctionsContent>Tag of get closed auctions content, it's only used when status is "success"
<Auction></Auction>Tag of auction item, it's only used when status is "success"
<YourHighBid></YourHighBid>Your high bid for this auction
<YourProxyBid></YourProxyBid>Your proxy bid for this auction
<AuctionId></AuctionId>ID of auction
<Domain></Domain>Domain name of auction
<AuctionStatusId></AuctionStatusId>Status id of auction, '0' for In Progress and '1' for Closed by User, '2' for Closed by Admin, '3' for Closed by Renewal, '4' for Closed by Timeout, '5' for Closed by Transfer Away
<AuctionStatus></AuctionStatus>Status of auction
<BidPrice></BidPrice>Current bid price of auction
<BidPriceCurrency></BidPriceCurrency>Currency of bid price
<Bids></Bids>Count of auction bids

Get Closed Auctions Example

Request(xml format)

https://api.dynadot.com/api3.xml?key=1&command=get_closed_backorder_auctions&startDate=2000-01-02&endDate=2015-5-15

Response
<GetClosedBackorderAuctionsResponse>
  <GetClosedBackorderAuctionsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </GetClosedAuctionsHeader>
  <GetClosedBackorderAuctionsContent>
    <Auction>
      <AuctionWonStatus>won</AuctionWonStatus>
      <YourHighBid>89.99</YourHighBid>
      <YourProxyBid>1000.0</YourProxyBid>
      <AuctionId>2</AuctionId>
      <Domain>domain-exp143.ooo</Domain>
      <AuctionStatusId>4</AuctionStatusId>
      <AuctionStatus>Closed by Timeout</AuctionStatus>
      <BidPrice>89.99</BidPrice>
      <BidPriceCurrency>USD</BidPriceCurrency>
      <Bids>1</Bids>
    </Auction>
    <Auction>
      <AuctionWonStatus>won</AuctionWonStatus>
      <YourHighBid>28.99</YourHighBid>
      <YourProxyBid>1000.0</YourProxyBid>
      <AuctionId>3</AuctionId>
      <Domain>domain-exp144.vc</Domain>
      <AuctionStatusId>4</AuctionStatusId>
      <AuctionStatus>Closed by Timeout</AuctionStatus>
      <BidPrice>28.99</BidPrice>
      <BidPriceCurrency>USD</BidPriceCurrency>
      <Bids>1</Bids>
    </Auction>
  </GetClosedAuctionsContent>
</GetClosedAuctionsResponse>
Request(csv format)

http://api.dynadot.com/api3.html?key=1&command=get_closed_auctions&startDate=2000-01-02&endDate=2015-5-15

Response

ok,
success,
AuctionId,Domain,AuctionStatusId,AuctionStatus,BidPrice,BidPriceCurrency,Bids,AuctionWonStatus,YourHighBid,YourProxyBid
2,domain.com,4,Closed by Timeout,89.99,USD,1,won,89.99,200
3,domain.com,4,Closed by Timeout,28.99,USD,1,won,28.99,300
.
.
.

 

Is Processing Command

Calling the is_processing command will tell you whether it is safe to submit a new request

Is-Processing Request Parameter
Explanation
no extra parameter is needed
Result XML tag
Explanation
<Response></Response>Tag of is_processing response
<RespnseHeader></RespnseHeader>Tag of is_processing header
<ResponseMsg></ResponseMsg>Tag of is_processing response message. It should be "yes"(There is a process in the system. You shouldn't sent another request.) or "no"(There is no any process for you account. It is safe to submit a new request.)

Is-Processing Example

Request

https://api.dynadot.com/api3.xml?key=mykey&command=is_processing

Response
<Response>
  <ResponseHeader>
    <ResponseCode>0</ResponseCode>
    <ResponseMsg>yes</ResponseMsg>
  </ResponseHeader>
</Response>
Request(csv format)

http://api.dynadot.com/api3.html?key=mykey&command=is_processing

Response

ok,yes

Dynadot
Domains
Websites
Resources
Top Level Domains
Country Domains

Copyright © 2002-2018 Dynadot LLC. All rights reserved.

Server Ip: 54.67.93.101