Would you like Dynadot in English ?YES

高级域名API

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

希望获得域名API的更多功能？只需看看我们的高级域名API。该版本的API让您可以使用自己的软件和服务器操作超过50条命令，包括创建文件夹、设置Whois、设置隐私、设置电子邮件转发等等！我们的高级域名API对所有账户开放，只需按照以下指引开始即可。

需要使用API的更简单方式？查看我们的域名API页面！

现在就开始使用高级域名API吧！

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

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

请注意，请求应通过https（安全套管）发送，以确保安全。每次仅可处理1条请求，所以在发送另一条请求前，请等待您目前的请求处理完毕。请求应包含以下参数：

Request Parameter
解释
Key您进入API的密匙，位于您账户的控制面板中
Commandsearch, register, delete, renew, push, transfer, bulk_register

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

create_cn_audit, get_cn_audit_status, create_contact, edit_contact, delete_contact, contact_list, get_contact

set_contact_eu_setting, set_contact_lv_setting, cancel_transfer, get_transfer_status, set_transfer_auth_code, authorize_transfer_away, get_transfer_auth_code

get_ns, add_ns, register_ns, set_ns_ip, delete_ns, delete_ns_by_domain, server_list, get_dns

get_listings, get_listing_item, buy_it_now

account_info, get_account_balance, set_default_whois, set_default_ns, set_default_parking, set_default_forwarding, set_default_stealth, set_default_hosting, set_default_dns, set_default_dns2, 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_dns2, 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, get_auction_bids, place_auction_bid, get_closed_auctions

is_processing

get_open_backorder_auctions, get_backorder_auction_details, place_backorder_auction_bid, get_closed_backorder_auctions, get_expired_closeout_domains, buy_expired_closeout_domain, get_order_status

Our Advanced Domain API will return results in an XML format. The response you receive should contain 2 or 3 of the following fields:

XML结果标签
解释
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用
 

搜索结果

如要发送搜索命令，则需包含下面参数：

搜索参数
解释
domain0 - domain99您搜索的域名，常规账户可以每条指令指定1个域名，批量和超级批量账户可以指定多达100个域名
language0 - language99 (可选)各自域名的语言标签，仅用于国际化域名
show_price (可选)如果您想在账户货币中显示价格，请设置为等于“1”
currency (可选)您可以决定货币类型且支持此参数的是"USD"、"CNY"、"GBP"、"EUR"、"INR"、"CAD"等等。如果您没有设定此参数，我们将使用账户的默认货币
XML结果标签
解释
<Results></Results>搜索命令XML响应的根节点
<SearchResponse></SearchResponse>搜索响应标签
<SearchHeader></SearchHeader>搜索标头标签
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用
<DomainName></DomainName>您刚刚搜索的域名
<Available></Available>如果域名可用
<Price></Price>若您将"show_price"设为等于“1”，且该域名可购，则将告知您相关价格信息
<Language></Language>域名的语言信息

搜索示例

Request (XML format)

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

Response (XML format)
<Results>
  <SearchResponse>
    <SearchHeader>
      <SuccessCode>0</SuccessCode>
      <DomainName>mydomain.com</DomainName>
      <Available>yes</Available>
      <Price>77.00 in USD</Price>
    </SearchHeader>
  </SearchResponse>
  <SearchResponse>
    <SearchHeader>
      <SuccessCode>0</SuccessCode>
      <DomainName>mydomain.net</DomainName>
      <Available>yes</Available>
      <Price>44.00 in USD</Price>
    </SearchHeader>
  </SearchResponse>
</Results>
Request (JSON format)

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

Response (JSON format)
{
   "SearchResponse":{
      "ResponseCode":"0",
      "SearchResults":[
         {
            "DomainName":"mydomain.com",
            "Available":"yes",
            "Price":"77.00 in USD"
         },
         {
            "DomainName":"mydomain.net",
            "Available":"yes",
            "Price":"44.00 in USD"
         }
      ]
   }
}
 

注册命令

发送注册命令后将创建并处理注册订单。您账户中须由足够余额支付订单。如果发送注册命令，须包含下列参数：

注册请求参数
解释
domain您想注册的域名，每个请求仅可注册1个域名
language (可选)被请求域名的语言标签，仅国际化域名需要
duration注册所需的时长
registrant_contact (可选)The registrant contact you want to use on the domain
admin_contact (可选)The admin contact you want to use on the domain
technical_contact (可选)The technical contact you want to use on the domain
billing_contact (可选)The billing contact you want to use on the domain
option0 (如果必要)
.AT, .BE,注册人姓名
option1 (如果必要)The .AT, .BE, registrant organization (optional)
对于.AT，您可指定为option0, option1,，或两者同时指定
premium (可选)如果您要注册一个高级域名，将其设为等于"1"（可选）
currency (可选)您可以决定货币类型且支持此参数的是"USD"、"CNY"、"GBP"、"EUR"、"INR"、"CAD"等等。如果您没有设定此参数，我们将使用账户的默认货币
coupon (可选)您希望用于此命令的优惠代码
XML结果标签
解释
<RegisterResponse></RegisterResponse>注册响应标签
<RegisterHeader></RegisterHeader>注册标头标签
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用
<RegisterContent></RegisterContent>注册内容标签
<Expiration></Expiration>以Unix时间计的过期日期（毫秒，自1970年1月1日午夜起），仅结果为"success"时使用
<Registration></Registration>以Unix时间计的注册日期（毫秒，自1970年1月1日午夜起），仅结果为"success"时使用

注册示例

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=register&domain=domain1.net&duration=3&currency=USD

Response (XML format)
<RegisterResponse>
  <RegisterHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </RegisterHeader>
  <RegisterContent>
    <Expiration>1458379145266</Expiration>
  </RegisterContent>
</RegisterResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=register&domain=domain1.net&duration=3&currency=USD

Response (JSON format)
{
   "RegisterResponse":{
      "ResponseCode":"0",
      "Status":"success",
      "DomainName":"domain1.net",
      "Expiration":"1458379145266"
   }
}
 

删除命令

调用删除（delete）命令将删除仍然处于宽限期中的域名。注册费将退回至您的账户余额。已续期或已移动至新账户的域名不得通过API进行删除。如果调用删除命令，应包括以下参数：

删除请求参数
解释
domain您想删除的域名，每次请求仅可删除1个域名
XML结果标签
解释
<DeleteResponse></DeleteResponse>删除响应标签
<DeleteHeader></DeleteHeader>删除标头标签
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用

删除示例

Request (XML format)

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

Response (XML format)
<DeleteResponse>
  <DeleteHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </DeleteHeader>
</DeleteResponse>
Request (JSON format)

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

Response (JSON format)
{
   "DeleteResponse":{
      "ResponseCode":"0",
      "Status":"success",
      "DomainName":"domain1.com",
   }
}
 

续费命令

调用续期（renew）命令将创建和处理续期订单。您必须具备足够的账户余额用于该订单。如果调用续期命令，应包括以下参数：

续费请求参数
解释
domain您想续费的域名，每个请求仅可续费1个域名
duration需要为域名续费多少年
year (可选)域名过期的当前年份
currency (可选)您可以决定货币类型且支持此参数的是"USD"、"CNY"、"GBP"、"EUR"、"INR"、"CAD"等等。如果您没有设定此参数，我们将使用账户的默认货币
price_check (可选)您可以将此参数添加到命令中，查看更新此域名的详细价格信息。注意：添加这个参数到命令中，我们的api将不会更新域名，而只显示价格信息。
coupon (可选)您希望用于此命令的优惠代码
no_renew_if_late_renew_fee_needed (可选)You can add this parameter to the command to avoid the renewal if the domain requires late renewal fee. If domain does requires late renew fee to renew, and "no_renew_if_late_renew_fee_needed = 1" was passed in command, domain will not be renewed.
XML结果标签
解释
<RenewResponse></RenewResponse>续费响应标签，它是响应XML文档的根节点
<RenewHeader></RenewHeader>续费标头
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用
<PriceInfo></PriceInfo>价格信息标签，这仅在状态为"price_check_success"时使用
<RenewContent></RenewContent>续费内容标签，仅状态为"success"时使用
<Expiration></Expiration>以Unix时间计的过期日期（毫秒，自1970年1月1日午夜起），仅结果为"success"时使用

续费示例

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&domain=domian1.com&command=renew&duration=1&currency=USD&coupon=testcoupon

Response (XML format)
<RenewResponse>
  <RenewHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </RenewHeader>
  <RenewContent>
    <Expiration>73984579834</Expiration>
  </RenewContent>
</RenewResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&domain=domian1.com&command=renew&duration=1&currency=USD&coupon=testcoupon

Response (JSON format)
{
   "RenewResponse":{
      "ResponseCode":"0",
      "Status":"success",
      "DomainName":"domian1.com",
      "Expiration":"73984579834"
   }
}
 

Push Command

调用push命令将创建和处理一个push订单。您必须为订单解锁您的域名和帐户。接收人账户必须拒绝/接受域名才能完成订单。如果调用push命令，应包含以下参数：

Push请求参数
解释
domain您想要推送的域名。我们还支持批量推送，您可以使用“;”来分割域名。例子：domain1.com;domain2.com
receiver_push_usernamePush Username of receiver account
currency (可选)您可以决定货币类型且支持此参数的是"USD"、"CNY"、"GBP"、"EUR"、"INR"、"CAD"等等。如果您没有设定此参数，我们将使用账户的默认货币
unlock_domain_for_push(optional)将此参数设为等于“1”。如果域名被锁定，我们将自动对其解锁，您将无需手动解锁域名
XML结果标签
解释
<PushResponse></PushResponse>ush响应标签，这是响应XML文档的根节点
<PushHeader></PushHeader>Push头部
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用

Push例子

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=push&domain=domian1.com&receiver_push_username=username&currency=USD

Response (XML format)
<PushResponse>
  <PushHeader>
    <SuccessCode>0</SuccessCode>
    <Status>order created</Status>
  </PushHeader>
</PushResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=push&domain=domian1.com&receiver_push_username=username&currency=USD

Response (JSON format)
{
   "PushResponse":{
      "ResponseCode":"0",
      "Status":"order created"
   }
}
 

Transfer Command

调用转移命令将创建和处理转移订单。部分tld可能会要求失去域名的注册人确认后才能完成订单。如果调用转移命令，应包括以下参数：

转移请求参数
解释
domain您想要转移到Dynadot中的域名，每一次请求只可以转移1个域名
auth转移请求授权代码。
currency (可选)您可以决定货币类型且支持此参数的是"USD"、"CNY"、"GBP"、"EUR"、"INR"、"CAD"等等。如果您没有设定此参数，我们将使用账户的默认货币
registrant_contact (可选)The registrant contact that you want to use when transfer completed. (Not all tld supports this feature)
admin_contact (可选)The admin contact that you want to use when transfer completed. (Not all tld supports this feature)
technical_contact (可选)The technical contact that you want to use when transfer completed. (Not all tld supports this feature)
billing_contact (可选)The billing contact that you want to use when transfer completed. (Not all tld supports this feature)
coupon (可选)您希望用于此命令的优惠代码
XML结果标签
解释
<TransferResponse></TransferResponse>转移响应标签，这是响应XML文档的根节点
<TransferHeader></TransferHeader>转移头部
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用

转移例子

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=transfer&domain=domian1.com&auth=testauth&currency=USD&coupon=testcoupon

Response (XML format)
<TransferResponse>
  <TransferHeader>
    <SuccessCode>0</SuccessCode>
    <Status>order created</Status>
  </TransferHeader>
</TransferResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=transfer&domain=domian1.com&auth=testauth&currency=USD&coupon=testcoupon

Response (JSON format)
{
   "TransferResponse":{
      "ResponseCode":"0",
      "Status":"order created",
      "DomainName":"domian1.com"
   }
}
 

Bulk Register Command

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

Bulk Register Request Parameter
解释
domain0-domain99The domain name(s) you want to register, maximum 100 domains can be registered per request
premium (可选)如果您要注册一个高级域名，将其设为等于"1"（可选）
currency (可选)You can decide the currency type and this parameter supported are "USD","CNY", "GBP","EUR","INR","CAD" and so on. If you missed this parameter,we will use the account default currency
coupon (可选)您希望用于此命令的优惠代码
XML结果标签
解释
<BulkRegisterResponse></BulkRegisterResponse>Tag of bulk register response
<BulkRegisterHeader></BulkRegisterHeader>Tag of bulk register header
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用
<BulkRegisterContent></BulkRegisterContent>The tag of bulk register content
<Expiration></Expiration>以Unix时间计的过期日期（毫秒，自1970年1月1日午夜起），仅结果为"success"时使用
<Result></Result>The result of the register action
<Message></Message>Error message of register action, only used when result is "error"

Bulk Register Example

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=bulk_register&domain0=domain0.com&domain1=domain1.com&currency=USD

Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<BulkRegisterResponse>
  <BulkRegisterHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </BulkRegisterHeader>
  <BulkRegisterContent>
    <BulkRegister>
      <RegisterResult>
        <DomainName>domain0.com</DomainName>
        <Expiration>1234567890</Expiration>
        <Result>success</Result>
        <Message>-</Message>
      </RegisterResult>
      <RegisterResult>
        <DomainName>domain1.com</DomainName>
        <Expiration>-</Expiration>
        <Result>error</Result>
        <Message>not_available</Message>
      </RegisterResult>
    </BulkRegister>
  </BulkRegisterContent>
</BulkRegisterResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=bulk_register&domain0=domain0.com&domain1=domain1.com&currency=USD

Response (JSON format)
{
  "BulkRegisterResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "BulkRegister": [
      {
        "DomainName": "domain0.com",
        "Expiration": "1234567890",
        "Result": "success",
        "Message": "-"
      },
      {
        "DomainName": "domain1.com",
        "Expiration": "-",
        "Result": "error",
        "Message": "not_available"
      }
    ]
  }
}
 

域名信息命令

This command is only available in XML and JSON format:

域名信息请求参数
解释
domain每个请求仅允许1个域名
XML结果标签
解释
<DomainInfoResponse></DomainInfoResponse>响应XML文档的根节点
<DomainInfoResponseHeader></DomainInfoResponseHeader>响应标头
<ResponseCode></ResponseCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用
<DomainInfoContent></DomainInfoContent>响应内容
<Domain></Domain>域名
<Name></Name>域名名称
<Expiration></Expiration>以Unix时间计的域名过期日期（毫秒，自1970年1月1日起）
<Registration></Registration>以Unix时间（自UTC时间1, 1970一月午夜起的毫秒数）表示的域名注册日期
<NameServerSettings></NameServerSettings>域名的域名服务器设置
<Type></Type>域名的域名服务器类型
<WithAds></WithAds>如果您想为域名创建停放页面
<Whois></Whois>Whois信息
<Registrant></Registrant>注册人信息
<ContactId></ContactId>联系方式ID
<Admin></Admin>管理员信息
<Technical></Technical>技术信息
<Billing></Billing>计费信息
<Locked></Locked>是否锁定
<Disabled></Disabled>启用状态
<UdrpLocked></UdrpLocked>UDRP锁定或未锁定
<UdrpLocked></UdrpLocked>UDRP锁定或未锁定
<RegistrantUnverified></RegistrantUnverified>未验证注册人
<Hold></Hold>暂停
<Privacy></Privacy>隐私保护状态
<isForSale></isForSale>销售状态
<RenewOption></RenewOption>续费选项
<Note></Note>备注
<Folder></Folder>文件夹信息
<FolderId></FolderId>文件夹ID
<FolderName></FolderName>文件夹名称

域名信息示例

Request (XML format)

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

Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<DomainInfoResponse>
  <DomainInfoHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </DomainInfoHeader>
  <DomainInfoContent>
    <Domain>
      <Name>domain1.com</Name>
      <Expiration>1361430589062</Expiration>
      <Registration>1234567890123</Registration>
      <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/>
      <Folder>
        <FolderId>-1</FolderId>
        <FolderName>(no folder)</FolderName>
      </Folder>
    </Domain>
  </DomainInfoContent>
</DomainInfoResponse>
Request (JSON format)

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

Response (JSON format)
{
  "DomainInfoResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "DomainInfo": {
      "Name": "domain1.com",
      "Expiration": "1361430589062",
      "Registration": "1234567890123",
      "NameServerSettings": {
        "Type": "Dynadot Parking",
        "WithAds": "Yes"
      },
      "Whois": {
        "Registrant": {
          "ContactId": "0"
        },
        "Admin": {
          "ContactId": "0"
        },
        "Technical": {
          "ContactId": "0"
        },
        "Billing": {
          "ContactId": "0"
        }
      },
      "Locked": "yes",
      "Disabled": "no",
      "UdrpLocked": "no",
      "RegistrantUnverified": "no",
      "Hold": "no",
      "Privacy": "none",
      "isForSale": "yes",
      "RenewOption": "no renew option",
      "Note": "",
      "Folder": {
        "FolderId": "-1",
        "FolderName": "(no folder)"
      }
    }
  }
}
 

设置Whois命令

如果设置Whois命令，则应包含以下参数：

设置Whois请求参数
解释
domain您要设置的域名，每个请求仅可设置100个域名，请务必用逗号将其隔开
registrant_contact域名的注册人信息
admin_contact域名管理员信息
technical_contact域名的技术信息
billing_contact域名的计费信息
XML结果标签
解释
<SetWhoisResponse></SetWhoisResponse>响应XML文档的根节点
<SetWhoisHeader></SetWhoisHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用

设置Whois示例

Request (XML format)

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 (XML format)
<SetWhoisResponse>
  <SetWhoisHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetWhoisHeader>
</SetWhoisResponse>
Request (JSON format)

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

Response (JSON format)
{
   "SetWhoisResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

设置域名服务器命令

如要呼叫设置域名服务器命令，应包含下列参数：

设置域名服务器请求参数
解释
domain您要设置的域名，每个请求仅可设置100个域名，请务必用逗号将其隔开
ns0 - ns12您要设置并启用域名的域名服务器，您可指定多达13个域名服务器，但它们必须已经在您的账户中
XML结果标签
解释
<SetNsResponse></SetNsResponse>设置域名服务器响应标签，它是响应XML文档的根节点
<SetNsHeader></SetNsHeader>设置域名响应标题标签
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用

设置域名服务器示例

Request (XML format)

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 (XML format)
<SetNsResponse>
  <SetNsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetNsHeader>
</SetNsResponse>
Request (JSON format)

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

Response (JSON format)
{
   "SetNsResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

设置停放命令

如设置停靠命令，则下列参数应包含在内：

设置域名停放请求参数
解释
domain您要设置的域名，每个请求仅可设置100个域名，请务必用逗号将其隔开
with_ads (可选)如果您不要第三方广告，则可将此参数设为"no"
XML结果标签
解释
<SetParkingResponse></SetParkingResponse>设置停放响应的标签，为响应XML文档的根节点
<SetParkingHeader></SetParkingHeader>设置域名停放文件夹标头
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用

设置域名停放示例

Request (XML format)

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

Response (XML format)
<SetParkingResponse>
  <SetParkingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetParkingHeader>
</SetParkingResponse>
Request (JSON format)

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

Response (JSON format)
{
   "SetParkingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

设置转发命令

如果发送设置转发命令，则须包含下列参数

设置转发请求参数
解释
domain您要设置的域名，每个请求仅可设置100个域名，请务必用逗号将其隔开
forward_url您希望域名转发至的URL地址。请注意，参数必须为已编码，以便API调用可得到正确解析。
is_temp (可选)您要跳转域名的跳转状态，默认值为"temporary",，若您要永久跳转，则可将此参数设为"no"
XML结果标签
解释
<SetForwardingResponse></SetForwardingResponse>响应XML文档的根节点
<SetForwardingHeader></SetForwardingHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用

设置转发示例

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=set_forwarding&forward_url=http%3A%2F%2Fwww.mydomain.com&domain=domain1.com,domain2.com

Response (XML format)
<SetForwardingResponse>
  <SetForwardingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetForwardingHeader>
</SetForwardingResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=set_forwarding&forward_url=http%3A%2F%2Fwww.mydomain.com&domain=domain1.com,domain2.com

Response (JSON format)
{
   "SetForwardingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

设置隐身命令

如果发送设置隐身命令，则须包含下列参数：

设置隐身请求参数
解释
domain您要设置的域名，每个请求仅可设置100个域名，请务必用逗号将其隔开
stealth_url您希望域名转发至的URL地址。请注意，参数必须为已编码，以便API调用可得到正确解析。
stealth_title (可选)页面标题
XML结果标签
解释
<SetStealthResponse></SetStealthResponse>响应XML文档的根节点
<SetStealthHeader></SetStealthHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用

设置隐身示例

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=set_stealth&domain=domain1.com&stealth_title=obama's shop&stealth_url=http%3A%2F%2Fwww.obamashop.com

Response (XML format)
<SetStealthResponse>
  <SetStealthHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetStealthHeader>
</SetStealthResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=set_stealth&domain=domain1.com&stealth_title=obama's shop&stealth_url=http%3A%2F%2Fwww.obamashop.com

Response (JSON format)
{
   "SetStealthResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

设置托管命令

如果发送设置托管命令，则须包含下列参数：

设置托管请求参数
解释
domain您要设置的域名，每个请求仅可设置100个域名，请务必用逗号将其隔开
hosting_type您想要的托管类型，可选择"advanced"和"basic"
mobile_view_on仅当hosting_type为"advanced",时刻将此参数设为"yes"
XML结果标签
解释
<SetHostingResponse></SetHostingResponse>响应XML文档的根节点
<SetHostingHeader></SetHostingHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用

设置托管示例

Request (XML format)

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

Response (XML format)
<SetHostingResponse>
  <SetHostingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetHostingHeader>
</SetHostingResponse>
Request (JSON format)

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

Response (JSON format)
{
   "SetHostingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

设置域名系统命令

如果发送设置域名系统命令，则须包含下列参数：

（此命令已过时，不建议使用，请使用设置DNS2命令）

设置域名系统请求参数
解释
domain您要设置的域名，每个请求仅可设置100个域名，请务必用逗号将其隔开
main_record_type主要记录类型
main_record为您的域名制定一个域名系统记录
main_txt1 - main_txt4 (可选)为您的域名指定一个TXT记录；如果您的main_record_type为aaaa，且指定了一个main_record2，则您可设置多达3个main_txts，否则，您可设置多达4个main_txts
main_record2主记录2，仅当"main_record_type"为"aaaa"时使用，其值必须为IPV4格式
subdomain0 - subdomain99 (可选)Subdomain records (可选)
sub_record_type0 - sub_record_type99 (可选)子域名记录类型
sub_record0 - sub_record99 (可选)IP地址或目标主机
mx_host0 - mx_host4 (可选)指定您域名的邮箱主机，distance0为最高优先级
mx_distance0 - mx_distance4 (可选)Distance0为最高优先级
ttl (可选)生存时间
add_dns_to_current_setting (可选)if you want to append the new DNS settings to existing Dns settings. Set it equal to "1" (optional)
XML结果标签
解释
<SetDnsResponse></SetDnsResponse>响应XML文档的根节点
<SetDnsHeader></SetDnsHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用

设置域名系统示例

Request (XML format)

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 (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<SetDnsResponse>
  <SetDnsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDnsHeader>
</SetDnsResponse>
Request (JSON format)

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

Response (JSON format)
{
  "SetDnsResponse": {
    "ResponseCode": "0",
    "Status": "success"
  }
}
 

设置DNS2命令

如果调用设置DNS2命令，应包含以下参数：

Please noted that calling set DNS2 command will override the current DNS setting.

设置DNS2请求参数
解释
domain您要设置的域名，每个请求仅可设置100个域名，请务必用逗号将其隔开
main_record_type0 - main_record_type19主记录类型应为"a"、"aaaa"、"cname"、"forward"、"txt"、"mx"、"stealth"、"email"
main_record0 - main_record19为您的域名指定DNS记录
main_recordx0 - main_recordx19Mx距离、转发类型（301为“1”，302为“2”），隐形转发标题或电子邮件别名，当main_record_type为"forward"、"mx"、"stealth"、"email"时为必需。
subdomain0 - subdomain99 (可选)Subdomain records (可选)
sub_record_type0 - sub_record_type99子域名记录类型应为"a"、"aaaa"、"cname"、"forward"、"txt"、"srv"、"mx"、"stealth"、"email"
sub_record0 - sub_record99子域名IP地址或目标主机
sub_recordx0 - sub_recordx99Mx距离、转发类型、隐形转发标题或电子邮件别名当sub_record_type为"forward"、"mx"、"stealth"、"email"时必须提供
ttl (可选)生存时间
add_dns_to_current_setting (可选)if you want to append the new DNS settings to existing Dns settings. Set it equal to "1" (optional)
XML结果标签
解释
<SetDnsResponse></SetDnsResponse>响应XML文档的根节点
<SetDnsHeader></SetDnsHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用

设置DNS2示例

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=set_dns2&domain=domain1.com&main_record_type0=aaaa&main_record0=0:0:0:0:0:0:0:1&main_record_type1=mx&main_record1=mail1.myisp.com&main_recordx1=0&subdomain0=www&sub_record_type0=a&sub_record0=192.168.1.1

Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<SetDnsResponse>
  <SetDnsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDnsHeader>
</SetDnsResponse>
Request (JSON format)

https://api.dynadot.com/api3.xml?key=mykey&command=set_dns2&domain=domain1.com&main_record_type0=aaaa&main_record0=0:0:0:0:0:0:0:1&main_record_type1=mx&main_record1=mail1.myisp.com&main_recordx1=0&subdomain0=www&sub_record_type0=a&sub_record0=192.168.1.1

Response (JSON format)
{
  "SetDnsResponse": {
    "ResponseCode": "0",
    "Status": "success"
  }
}
 

设置电子邮件转发命令

如果发送设置电子邮件转发命令，则须包含下列参数：

设置电子邮件转发请求参数
解释
domain您要设置的域名，每个请求仅可设置100个域名，请务必用逗号将其隔开
forward_type转发类型，可以是"donot":：不要转发邮件；"mx":将邮件转发给另一个邮箱主机（MX记录）；"forward":：将邮件转发给另一个邮箱主机
username0 - username9用户名，仅"forward_type"为"forward"时使用
exist_email0 - exist_email9现有电子邮箱地址，仅当"forward_type"为"forward"时使用
mx_host0 - mx_host2邮箱主机，仅"forward_type"为"mx"时使用
mx_distance0 - mx_distance2Distance0为最高优先级，仅当"forward_type"为"mx"时使用
XML结果标签
解释
<SetEmailForwardingResponse></SetEmailForwardingResponse>响应XML文档的根节点
<SetEmailForwardingHeader></SetEmailForwardingHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用

设置 电子邮件转发示例

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=set_email_forward&domain=domain1.com&forward_type=forward&username0=peter&[email protected]

Response (XML format)
<SetEmailForwardingResponse>
  <SetEmailForwardingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetEmailForwardingHeader>
</SetEmailForwardingResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=set_email_forward&domain=domain1.com&forward_type=forward&username0=peter&[email protected]

Response (JSON format)
{
   "SetEmailForwardingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

设置清除域名设置命令

如果发送设置清除域名设置命令，则须包含下列参数：

设置清除域名设置请求参数
解释
domain您要设置的域名，每个请求仅可设置100个域名，请务必用逗号将其隔开
service您要清除的服务，它可以是“转发”、“隐形”、“电子邮件转发”、“dns”和“名字服务器”
XML结果标签
解释
<SetClearDomainSettingResponse></SetClearDomainSettingResponse>响应XML文档的根节点
<SetClearDomainSettingHeader></SetClearDomainSettingHeaderr>响应标头
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用

设置清除域名设置示例

Request (XML format)

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

Response (XML format)
<SetClearDomainSettingResponse>
  <SetClearDomainSettingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetClearDomainSettingHeader>
</SetClearDomainSettingResponse>
Request (JSON format)

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

Response (JSON format)
{
   "SetClearDomainSettingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

设置文件夹命令

如果发送设置文件夹命令，则须包含下列参数：

设置文件夹请求参数
解释
domain要更新的域名，每次请求仅可设置1个域名
folder您要将域名移动至的文件夹名称，若要将域名已从至默认文件夹，则可将文件夹名设置为"Default"。文件夹名区分大小写，例如，"Folder1"和"folder1"是两个不同的文件夹名
folder_id (可选)您要将域名移动至的文件夹ID
XML结果标签
解释
<SetFolderResponse></SetFolderResponse>设置文件夹响应标签，它是响应XML文档的根节点
<SetFolderHeader></SetFolderHeader>设置文件夹标头
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用

设置文件夹示例

Request (XML format)

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

Response (XML format)
<SetFolderResponse>
  <SetFolderHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderHeader>
</SetFolderResponse>
Request (JSON format)

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

Response (JSON format)
{
   "SetFolderResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

设置续费选项

如果发送设置续费选项命令，则须包含下列参数：

设置续费选项请求参数
解释
domain您要设置的域名，每个请求仅可设置100个域名，请务必用逗号将其隔开
renew_option可以是"donot", "auto", "reset"
XML结果标签
解释
<SetRenewOptionResponse></SetRenewOptionResponse>响应XML文档的根节点
<SetRenewOptionHeader></SetRenewOptionHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用

设置续费选项示例

Request (XML format)

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

Response (XML format)
<SetRenewOptionResponse>
  <SetRenewOptionHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetRenewOptionHeader>
</SetRenewOptionResponse>
Request (JSON format)

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

Response (JSON format)
{
   "SetRenewOptionResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

设置注释命令

如果发送设置注释命令，则须包含下列参数：

设置通知请求参数
解释
domain您想设置的域名，每个请求仅可设置1个域名
note您想为域名设置的注释，可以为空
XML结果标签
解释
<SetNoteResponse></SetNoteResponse>响应XML文档的根节点
<SetNoteHeader></SetNoteHeader>响应数据头
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用

设置注释示例

Request (XML format)

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

Response (XML format)
<SetNoteResponse>
  <SetNoteHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetNoteHeader>
</SetNoteResponse>
Request (JSON format)

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

Response (JSON format)
{
   "SetNoteResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Set Customer Id Command (RESELLER ONLY)

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

Set Customer Id Request Parameter
解释
domainThe domain you want to set, multiple domains are separated by commas (Max:100)
customer_idCustomer id you want to set to the domain, can't be null
XML结果标签
解释
<SetCustomerIdResponse></SetCustomerIdResponse>响应XML文档的根节点
<SetCustomerIdHeader></SetCustomerIdHeader>响应标头
<SetCustomerIdContent></SetCustomerIdContent>响应内容
<SetCustomerIdSuccess></SetCustomerIdSuccess>Set customer id success response content
<SetCustomerIdFailed></SetCustomerIdFailed>Set customer id failed response content
<ResponseCode></ResponseCode>If the operation is successful, "0" for success, "-1" for failure, "1" for problem
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用

Set Customer Id Example

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=set_customer_id&domain=domain1.com,domain2.com&customer_id=123456

Response (XML format)
<SetCustomerIdResponse>
    <SetCustomerIdHeader>
        <ResponseCode>0</ResponseCode>
        <Status>success</Status>
    </SetCustomerIdHeader>
    <SetCustomerIdContent>
        <SetCustomerIdSuccess>
            <content>
                <Domain>domain1.com</Domain>
                <CustomerId>123456</CustomerId>
            </content>
            <content>
                <Domain>domain2.com</Domain>
                <CustomerId>123456</CustomerId>
            </content>
        </SetCustomerIdSuccess>
    </SetCustomerIdContent>
</SetCustomerIdResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=set_customer_id&domain=domain1.com,domain2.com&customer_id=123456

Response (JSON format)
{
    "SetCustomerIdResponse": {
        "ResponseCode": 0,
        "Status": "success",
        "SetCustomerIdSuccess": [
            {
                "Domain": "domain1.com",
                "CustomerId": 123456
            },
            {
                "Domain": "domain2.com",
                "CustomerId": 123456
            }
        ]
    }
}
 

设置隐私保护命令

如果发送设置隐私保护命令，则须包含下列参数：

设置隐私保护请求参数
解释
domain您要设置的域名，每个请求仅可设置100个域名，请务必用逗号将其隔开
option您想为域名设置的隐私状态，可以是"full", "partial",或者"off"
XML结果标签
解释
<SetPrivacyResponse></SetPrivacyResponse>响应XML文档的根节点
<SetPrivacyHeader></SetPrivacyHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用

设置隐私保护示例

Request (XML format)

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

Response (XML format)
<SetPrivacyResponse>
  <SetPrivacyHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetPrivacyHeader>
</SetPrivacyResponse>
Request (JSON format)

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

Response (JSON format)
{
   "SetPrivacyResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

TLD价格

This feature is only available in XML and JSON format:

Tld价格请求参数
解释
currency (可选)返回结果的货币，它应该是"usd", "eur", 或 "cny",默认货币是账户设置的Api默认货币
XML结果标签
解释
<TldPriceResponse></TldPriceResponse>响应XML文档的根节点
<TldPriceResponseHeader></TldPriceResponseHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用
<TldPriceContent></TldPriceContent>响应内容
<TldContent></TldContent>Tld信息
<Tld></Tld>顶级域名
<Usage></Usage>tld的使用
<Price></Price>Price info of this tld. Contain sub-tags: : Unit of price : Price of Registration : Price of Renew : Price of Transfer
<Privacy></Privacy>如果此tld支持whois隐私
<GracePeriod></GracePeriod>Grace period info of this tld. Contain sub-tags: : Unit of grace period info : Renew grace period : Delete grace period
<IDN></IDN>如果此tld支持国家化域名
<Restrictions></Restrictions>域名名称

TLD价格示例

Request (XML format)

https://api.dynadot.com/api3.xml?key=0&command=tld_price&currency=USD

Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<TldPriceResponse>
  <TldPriceResponseHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
    <PriceLevel>Regular Pricing</PriceLevel>
    <Currency>USD</Currency>
  </TldPriceResponseHeader>
  <TldPriceContent>
    <TldContent>
      <Tld>.com</Tld>
      <Usage>Usage</Usage>
      <Price>
        <Unit>(Price/1 year)</Unit>
        <Register>99.00</Register>
        <Renew>60.00</Renew>
        <Transfer>92.00</Transfer>
      </Price>
      <Privacy>Yes</Privacy>
      <GracePeriod>
        <Unit>(Grace Period/days)</Unit>
        <Renew>40</Renew>
        <Delete>5</Delete>
      </GracePeriod>
      <IDN>Yes</IDN>
      <Restrictions>--</Restrictions>
    </TldContent>
  </TldPriceContent>
</TldPriceResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=0&command=tld_price&currency=USD

Response (JSON format)
{
  "TldPriceResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "PriceLevel": "Regular Pricing",
    "Currency": "USD",
    "TldPrice": [
      {
        "Tld": ".com",
        "Usage": "Usage",
        "Price": {
          "Unit": "(Price/1 year)",
          "Register": "99.00",
          "Renew": "60.00",
          "Transfer": "92.00"
        },
        "Privacy": "Yes",
        "GracePeriod": {
          "Unit": "(Grace Period/days)",
          "Renew": "40",
          "Delete": "5"
        },
        "IDN": "Yes",
        "Restrictions": "--"
      }
    ]
  }
}
 

域名列表命令

This feature is only available in XML and JSON format:

域名列表请求参数
解释
customer_id (可选)Filter data by customer id (only resellers can use this parameter)
XML结果标签
解释
<ListDomainInfoResponse></ListDomainInfoResponse>响应XML文档的根节点
<ListDomainInfoHeader></ListDomainInfoHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用
<ListDomainInfoContent></ListDomainInfoContent>响应内容
<DomainInfoList></DomainInfoList>域名信息列表
<DomainInfo></DomainInfo>域名信息
<Domain></Domain>域名
<Name></Name>域名名称
<Expiration></Expiration>以Unix时间计的域名过期日期（毫秒，自1970年1月1日起）
<Registration></Registration>以Unix时间（自UTC时间1, 1970一月午夜起的毫秒数）表示的域名注册日期
<NameServerSettings></NameServerSettings>域名服务器设置
<Type></Type>域名服务器设置类型
<WithAds></WithAds>是否带有广告
<Whois></Whois>Whois信息
<Registrant></Registrant>注册人信息
<ContactId></ContactId>联系方式ID
<Admin></Admin>管理员信息
<Technical></Technical>技术信息
<Billing></Billing>计费信息
<Locked></Locked>是否锁定
<Disabled></Disabled>启用状态
<Hold></Hold>暂停
<Privacy></Privacy>隐私保护状态
<isForSale></isForSale>销售状态
<RenewOption></RenewOption>续费选项
<Note></Note>备注
<Folder></Folder>文件夹信息
<FolderId></FolderId>文件夹ID
<FolderName></FolderName>文件夹名称

列出域名示例

Request (XML format)

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

Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<ListDomainInfoResponse>
  <ListDomainInfoHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </ListDomainInfoHeader>
  <ListDomainInfoContent>
    <DomainInfoList>
      <DomainInfo>
        <Domain>
          <Name>domain-exp140.com</Name>
          <Expiration>1361430589062</Expiration>
          <Registration>1234567890123</Registration>
          <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>no</isForSale>
          <RenewOption>no renew option</RenewOption>
          <Note/>
          <Folder>
            <FolderId>-1</FolderId>
            <FolderName>(no folder)</FolderName>
          </Folder>
        </Domain>
        <Domain>
          <Name>domain-exp141.com</Name>
          <Expiration>1361430589062</Expiration>
          <Registration>1234567890123</Registration>
          <NameServerSettings>
            <Type>Dynadot Parking</Type>
            <WithAds>Yes</WithAds>
          </NameServerSettings>
          <Whois>
            <Registrant>
              <ContactId>1</ContactId>
            </Registrant>
            <Admin>
              <ContactId>2</ContactId>
            </Admin>
            <Technical>
              <ContactId>3</ContactId>
            </Technical>
            <Billing>
              <ContactId>4</ContactId>
            </Billing>
          </Whois>
          <Locked>yes</Locked>
          <Disabled>no</Disabled>
          <UdrpLocked>no</UdrpLocked>
          <RegistrantUnverified>no</RegistrantUnverified>
          <Hold>no</Hold>
          <Privacy>none</Privacy>
          <isForSale>no</isForSale>
          <RenewOption>no renew option</RenewOption>
          <Note/>
          <Folder>
            <FolderId>-1</FolderId>
            <FolderName>(no folder)</FolderName>
          </Folder>
        </Domain>
      </DomainInfo>
    </DomainInfoList>
  </ListDomainInfoContent>
</ListDomainInfoResponse>
Request (JSON format)

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

Response (JSON format)
{
  "ListDomainInfoResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "MainDomains": [
      {
        "Name": "domain-exp140.com",
        "Expiration": "1361430589062",
        "Registration": "1234567890123",
        "NameServerSettings": {
          "Type": "Dynadot Parking",
          "WithAds": "Yes"
        },
        "Whois": {
          "Registrant": {
            "ContactId": "0"
          },
          "Admin": {
            "ContactId": "0"
          },
          "Technical": {
            "ContactId": "0"
          },
          "Billing": {
            "ContactId": "0"
          }
        },
        "Locked": "yes",
        "Disabled": "no",
        "UdrpLocked": "no",
        "RegistrantUnverified": "no",
        "Hold": "no",
        "Privacy": "none",
        "isForSale": "no",
        "RenewOption": "no renew option",
        "Note": "",
        "Folder": {
          "FolderId": "-1",
          "FolderName": "(no folder)"
        }
      },
      {
        "Name": "domain-exp141.com",
        "Expiration": "1361430589062",
        "Registration": "1234567890123",
        "NameServerSettings": {
          "Type": "Dynadot Parking",
          "WithAds": "Yes"
        },
        "Whois": {
          "Registrant": {
            "ContactId": "1"
          },
          "Admin": {
            "ContactId": "2"
          },
          "Technical": {
            "ContactId": "3"
          },
          "Billing": {
            "ContactId": "4"
          }
        },
        "Locked": "yes",
        "Disabled": "no",
        "UdrpLocked": "no",
        "RegistrantUnverified": "no",
        "Hold": "no",
        "Privacy": "none",
        "isForSale": "no",
        "RenewOption": "no renew option",
        "Note": "",
        "Folder": {
          "FolderId": "-1",
          "FolderName": "(no folder)"
        }
      }
    ]
  }
}
 

创建联系方式命令

如果发送创建联系方式命令，则须包含下列参数：

创建联络人请求参数
解释
organization (可选)机构信息
name名称
email邮箱
phonenum电话号码
phonecc国家区号
faxnum (可选)传真号码
faxcc (可选)传真国家区号
address1地址1
address2 (可选)第2行地址
city城市
state (可选)州
zip邮政区代码
country国家
XML结果标签
解释
<CreateContactResponse></CreateContactResponse>响应XML文档的根节点
<CreateContactHeader></CreateContactHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用
<CreateContactContent></CreateContactContent>New Contact ID, only used when status is "success"

创建联系方式示例

Request (XML format)

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

Response (XML format)
<CreateContactResponse>
  <CreateContactHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </CreateContactHeader>
  <CreateContactContent>
    <ContactId>1234</ContactId>
  </CreateContactContent>
</CreateContactResponse>
Request (JSON format)

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

Response (JSON format)
{
   "CreateContactResponse":{
      "ResponseCode":"0",
      "Status":"success",
      "CreateContactContent":{
         "ContactId":"0"
      }
   }
}
 

遍及联系方式命令

如果发送遍及联系方式命令，则须包含下列参数：

编辑联络人请求参数
解释
contact_id您要编辑的联络人ID
organization (可选)机构信息
name名称
email邮箱
phonenum电话号码
phonecc国家区号
faxnum (可选)传真号码
faxcc (可选)传真国家区号
address1地址第1行
address2 (可选)第2行地址
city城市
state州
zip邮政区代码
country国家
XML结果标签
解释
<EditContactResponse></EditContactResponse>响应XML文档的根节点
<EditContactHeader></EditContactHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用
<EditContactContent></EditContactContent>响应内容
<ContactId></ContactId>联络人ID
Request (XML format)

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

Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<EditContactResponse>
  <EditContactHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </EditContactHeader>
  <EditContactContent>
    <ContactId>0</ContactId>
  </EditContactContent>
</EditContactResponse>
Request (CSV format)

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

Response (CSV format)
ok,

success,
,
Request (JSON format)

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

Response (JSON format)
{
  "EditContactResponse": {
    "ResponseCode": "0",
    "Status": "success",
    "EditContactContent": {
      "ContactId": "0"
    }
  }
}
 

Set Contact EU Setting Command

If calling set contact eu setting command, the following parameters should be included:

Set Contact EU Setting Request Parameter
解释
contact_id您要编辑的联络人ID
country_of_citizenshipMust be an EU member state, The country codes of member states include :
AT, BE, BG, HR, CY, CZ, DK, EE, FI, FR, DE, GR, HU, IS, IE, IT, LV, LI, LT, LU, MT, NL, NO, PL, PT, RO, SK, SI, ES, SE
XML结果标签
解释
<SetContactEUSettingResponse></SetContactEUSettingResponse>响应XML文档的根节点
<SetContactEUSettingHeader></SetContactEUSettingHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用
<SetContactEUSettingContent></SetContactEUSettingContent>响应内容
<ContactId></ContactId>联络人ID

Set Contact EU Setting Example

Request (XML format)

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

Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<SetContactEUSettingResponse>
  <SetContactEUSettingHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </SetContactEUSettingHeader>
  <SetContactEUSettingContent>
    <ContactId>0</ContactId>
  </SetContactEUSettingContent>
</SetContactEUSettingResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=set_contact_eu_setting&contact_id=0&country_of_citizenship=AT

Response (JSON format)
{
  "SetContactEUSettingResponse": {
    "ResponseCode: ": "0",
    "Status": "Success",
    "SetContactEUSettingContent": {
      "ContactId: ": "0"
    }
  }
}
 

Set Contact LV Setting Command

If calling set contact lv setting command, the following parameters should be included:

Set Contact LV Setting Request Parameter
解释
contact_id您要编辑的联络人ID
registration_number- For individual, Please enter Latvian identification number.
- For companies and other legal entities, please enter registration number issued by the Latvian Register of Enterprises.
vat_number (可选)VAT number for foreign legal entities registered within European Union countries (this includes also Latvian companies)
XML结果标签
解释
<SetContactLvSettingResponse></SetContactLvSettingResponse>响应XML文档的根节点
<SetContactLvSettingHeader></SetContactLvSettingHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用
<SetContactLvSettingContent></SetContactLvSettingContent>响应内容
<ContactId></ContactId>联络人ID

Set Contact LV Setting Example

Request (CSV format)

https://api.dynadot.com/api3.csv?key=mykey&command=set_contact_lv_setting&contact_id=0&registration_number=test_reg_number&vat_number=test_vat_number

Response (CSV format)
ok,success,0
Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=set_contact_lv_setting&contact_id=0&registration_number=test_reg_number&vat_number=test_vat_number

Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<SetContactLvSettingResponse>
  <SetContactLvSettingHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </SetContactLvSettingHeader>
  <SetContactLvSettingContent>
    <ContactId>0</ContactId>
  </SetContactLvSettingContent>
</SetContactLvSettingResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=set_contact_lv_setting&contact_id=0&registration_number=test_reg_number&vat_number=test_vat_number

Response (JSON format)
{
  "SetContactLvSettingResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "SetContactLvSettingContent": {
      "ContactId: ": "0"
    }
  }
}
 

删除联系方式命令

如果发送删除联系方式命令，则须包含下列参数：

删除联系方式请求参数
解释
contact_id您要删除的联络人ID，务必使用逗号隔开
XML结果标签
解释
<DeleteContactResponse></DeleteContactResponse>响应XML文档的根节点
<DeleteContactHeader></DeleteContactHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用

删除联系方式示例

Request (XML format)

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

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

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

Response (JSON format)
{
   "DeleteContactResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

联系方式列表命令

This command is only available in XML and JSON format:

联系方式列表请求参数
解释
N/A无需额外参数
XML结果标签
解释
<ContactListResponse></ContactListResponse>响应XML文档的根节点
<ContactListHeader></ContactListHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用
<ContactListContent></ContactListContent>响应内容
<ContactList></ContactList>联系方式列表
<Contact></Contact>联系方式信息
<ContactId></ContactId>联络人ID
<Organization></Organization>联系机构
<Name></Name>名称
<Email></Email>邮箱
<PhoneCc></PhoneCc>国家区号
<PhoneNum></PhoneNum>电话号码
<FaxCc></FaxCc>传真国家区号
<FaxNum></FaxNum>传真号码
<Address1></Address1>地址第1行
<Address2></Address2>第2行地址
<City></City>城市
<State></State>州
<ZipCode></ZipCode>邮政区代码
<Country></Country>国家
<GtldVerified></GtldVerified>gTLD验证状态

联系方式列表示例

Request (XML format)

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

Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<ContactListResponse>
  <ContactListHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </ContactListHeader>
  <ContactListContent>
    <ContactList>
      <Contact>
        <ContactId>0</ContactId>
        <Organization/>
        <Name>Jack Slater</Name>
        <Email>[email protected]</Email>
        <PhoneCc>1</PhoneCc>
        <PhoneNum>555.555.5233</PhoneNum>
        <FaxCc/>
        <FaxNum/>
        <Address1>1 Free Way</Address1>
        <Address2/>
        <City>Los Angeles</City>
        <State>CA</State>
        <ZipCode>90068</ZipCode>
        <Country>US</Country>
        <GtldVerified>no</GtldVerified>
      </Contact>
      <Contact>
        <ContactId>1</ContactId>
        <Organization/>
        <Name>John tester</Name>
        <Email>[email protected]</Email>
        <PhoneCc>1</PhoneCc>
        <PhoneNum>123.456.7890</PhoneNum>
        <FaxCc>1</FaxCc>
        <FaxNum>123.456.7890</FaxNum>
        <Address1>high Way first</Address1>
        <Address2/>
        <City>San Francisco</City>
        <State>CA</State>
        <ZipCode>90068</ZipCode>
        <Country>US</Country>
        <GtldVerified>yes</GtldVerified>
      </Contact>
    </ContactList>
  </ContactListContent>
</ContactListResponse>
Request (JSON format)

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

Response (JSON format)
{
  "ContactListResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "ContactList": [
      {
        "ContactId": "0",
        "Organization": "",
        "Name": "Jack Slater",
        "Email": "[email protected]",
        "PhoneCc": "1",
        "PhoneNum": "555.555.5233",
        "FaxCc": "",
        "FaxNum": "",
        "Address1": "1 Free Way",
        "Address2": "",
        "City": "Los Angeles",
        "State": "CA",
        "ZipCode": "90068",
        "Country": "US",
        "GtldVerified": "no"
      },
      {
        "ContactId": "1",
        "Organization": "",
        "Name": "John tester",
        "Email": "[email protected]",
        "PhoneCc": "1",
        "PhoneNum": "123.456.7890",
        "FaxCc": "1",
        "FaxNum": "123.456.7890",
        "Address1": "high Way first",
        "Address2": "",
        "City": "San Francisco",
        "State": "CA",
        "ZipCode": "90068",
        "Country": "US",
        "GtldVerified": "yes"
      }
    ]
  }
}
 

获取联络人命令

This command is only available in XML and JSON format:

获取联络人请求参数
解释
contact_id联络人ID
XML结果标签
解释
<GetContactResponse></GetContactResponse>响应XML文档的根节点
<GetContactHeader></GetContactHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用
<GetContactContent></GetContactContent>响应内容
<Contact></Contact>联系方式信息
<ContactId></ContactId>联络人ID
<Organization></Organization>联系机构
<Name></Name>名称
<Email></Email>邮箱
<PhoneCc></PhoneCc>国家区号
<PhoneNum></PhoneNum>电话号码
<FaxCc></FaxCc>传真国家区号
<FaxNum></FaxNum>传真号码
<Address1></Address1>地址第1行
<Address2></Address2>第2行地址
<City></City>城市
<State></State>州
<ZipCode></ZipCode>邮政区代码
<Country></Country>国家
<GtldVerified></GtldVerified>gTLD验证状态

获取联络人示例

Request (XML format)

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

Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<GetContactResponse>
  <GetContactHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </GetContactHeader>
  <GetContactContent>
    <GetContact>
      <Contact>
        <ContactId>12345</ContactId>
        <Organization>org</Organization>
        <Name>name</Name>
        <Email>[email protected]</Email>
        <PhoneCc>1</PhoneCc>
        <PhoneNum>555.555.5233</PhoneNum>
        <FaxCc/>
        <FaxNum/>
        <Address1>address1</Address1>
        <Address2>address2</Address2>
        <City>city</City>
        <State>state</State>
        <ZipCode>zipcode</ZipCode>
        <Country>country</Country>
        <GtldVerified>no</GtldVerified>
      </Contact>
    </GetContact>
  </GetContactContent>
</GetContactResponse>
Request (JSON format)

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

Response (JSON format)
{
  "GetContactResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "GetContact": {
      "ContactId": "12345",
      "Organization": "org",
      "Name": "name",
      "Email": "[email protected]",
      "PhoneCc": "1",
      "PhoneNum": "555.555.5233",
      "FaxCc": "",
      "FaxNum": "",
      "Address1": "address1",
      "Address2": "address2",
      "City": "city",
      "State": "state",
      "ZipCode": "zipcode",
      "Country": "country",
      "GtldVerified": "no"
    }
  }
}
 

Get Name Server Command

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

Get Name Server Request Parameter
解释
domain您想获得的该域名的域名服务器信息，每次请求仅能抓取1条该域名的域名服务器信息
XML结果标签
解释
<GetNsResponse></GetNsResponse>响应XML文档的根节点
<GetNsHeader></GetNsHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用
<NsContent></NsContent>响应内容
<Host></Host>Host name of the server
<NsName></NsName>Name of the server

Get Name Server Example

Request (XML format)

https://api.dynadot.com/api3.html?key=mykey&command=get_ns&domain=mydomain.com

Response (XML format)
<GetNsResponse>
  <GetNsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </GetNsHeader>
  <NsContent>
    <Host>ns1.mydomain.com</Host>
    <Host>ns2.mydomain.com</Host>
  </NsContent>
</GetNsResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=get_ns&domain=mydomain.com

Response (JSON format)
{
   "GetNsResponse":{
      "ResponseCode":"0",
      "Status":"success",
      "NsContent":{
         "Host":"ns1.mydomain.com",
         "Host":"ns2.mydomain.com"
      }
   }
}
 

添加域名服务器命令

若呼叫添加域名服务器命令，则需包含以下参数：

添加域名服务器请求参数
解释
host您想添加的域名服务器主机名称
XML结果标签
解释
<AddNsResponse></AddNsResponse>响应XML文档的根节点
<AddNsHeader></AddNsHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用
<AddNsContent></AddNsContent>响应内容
<Server></Server>您已经设置的服务器
<Host></Host>新服务器的托管名称
<ServerId></ServerId>新服务器ID

添加域名服务器示例

Request (XML format)

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

Response (XML format)
<AddNsResponse>
  <AddNsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </AddNsHeader>
  <AddNsContent>
    <Server>
      <Host>ns1.mydomain.com</Host>
      <ServerId>0</ServerId>
    </Server>
  </AddNsContent>
</AddNsResponse>
Request (JSON format)

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

Response (JSON format)
{
   "AddNsResponse":{
      "ResponseCode":"0",
      "Status":"success",
      "AddNsContent":{
         "Server":{
            "Host":"ns1.mydomain.com",
            "ServerId":"0"
         }
      }
   }
}
 

注册域名服务器命令

如果呼叫注册域名服务器命令，则应包含下列参数：

注册域名服务器请求参数
解释
host您自己域名服务器的主机名称
ip您自己的域名服务器IP地址
XML结果标签
解释
<RegisterNsResponse></RegisterNsResponse>响应XML文档的根节点
<RegisterNsHeader></RegisterNsHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用
<RegisterNsContent></RegisterNsContent>响应内容
<Server></Server>服务器标签
<Host></Host>托管名称
<ServerId></ServerId>服务器ID

注册域名服务器示例

Request (XML format)

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

Response (XML format)
<RegisterNsResponse>
  <RegisterNsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </RegisterNsHeader>
  <RegisterNsContent>
    <Server>
      <Host>domain1.com</Host>
      <ServerId>0</ServerId>
    </Server>
  </RegisterNsContent>
</RegisterNsResponse>
Request (JSON format)

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

Response (JSON format)
{
   "RegisterNsResponse":{
      "ResponseCode":"0",
      "Status":"success",
      "RegisterNsContent":{
         "Server":{
            "Host":"ndomain1.com",
            "ServerId":"0"
         }
      }
   }
}
 

设置域名服务器IP命令

若呼叫设置域名服务器IP命令，则应包含以下参数：

设置域名服务器IP请求参数
解释
server_id您要设置的域名服务器ID
ip0 - ip9您要为域名服务器设置的IP地址，每个请求可以设置9个IP，需用逗号隔开
XML结果标签
解释
<SetNsIpResponse></SetNsIpResponse>响应XML文档的根节点
<SetNsIpHeader></SetNsIpHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用

设置域名服务器IP示例

Request (XML format)

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

Response (XML format)
<SetNsIpResponse>
  <SetNsIpHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetNsIpHeader>
</SetNsIpResponse>
Request (JSON format)

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

Response (JSON format)
{
   "SetNsIpResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

删除域名服务器命令

如果呼叫删除域名服务器命令，则应包含下列参数：

删除域名服务器请求参数
解释
server_id您想删除的域名服务器ID，请务必使用逗号将其隔开
XML结果标签
解释
<DeleteNsResponse></DeleteNsResponse>响应XML文档的根节点
<DeleteNsHeader></DeleteNsHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用

删除域名服务器示例

Request (XML format)

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

Response (XML format)
<DeleteNsResponse>
  <DeleteNsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </DeleteNsHeader>
</DeleteNsResponse>
Request (JSON format)

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

Response (JSON format)
{
   "DeleteNsResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Delete Name Server By Domain Command

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

Delete Name Server By Domain Request Parameter
解释
server_domainName of the name server. ex: ns1.testnameserver.com
XML结果标签
解释
<DeleteNsResponse></DeleteNsResponse>响应XML文档的根节点
<DeleteNsHeader></DeleteNsHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用

Delete Name Server By Domain Example

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=delete_ns_by_domain&server_domain=ns1.testnameserver.com

Response (XML format)
<DeleteNsResponse>
  <DeleteNsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </DeleteNsHeader>
</DeleteNsResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=delete_ns_by_domain&server_domain=ns1.testnameserver.com

Response (JSON format)
{
   "DeleteNsResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

服务器列表命令

This command is only available in XML and JSON format:

服务器列表请求参数
解释
N/A无需额外参数
XML结果标签
解释
<ServerListResponse></ServerListResponse>响应XML文档的根节点
<ServerListHeader></ServerListHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用
<ServerListContent></ServerListContent>响应内容
<NameServerList></NameServerList>域名服务器列表
<List></List>
<Server></Server>
<ServerId></ServerId>服务器ID
<ServerName></ServerName>服务器名称
<ServerIp></ServerIp>服务器IP

服务器列表示例

Request (XML format)

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

Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<ServerListResponse>
  <ServerListHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </ServerListHeader>
  <ServerListContent>
    <NameServerList>
      <List>
        <Server>
          <ServerId>0</ServerId>
          <ServerName>ns1.com</ServerName>
        </Server>
        <Server>
          <ServerId>1</ServerId>
          <ServerName>domain1.com</ServerName>
          <ServerIp>192.168.1.1</ServerIp>
        </Server>
      </List>
    </NameServerList>
  </ServerListContent>
</ServerListResponse>
Request (JSON format)

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

Response (JSON format)
{
  "ServerListResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "ServerList": [
      {
        "ServerId": "0",
        "ServerName": "ns1.com"
      },
      {
        "ServerId": "1",
        "ServerName": "domain1.com",
        "ServerIp": "192.168.1.1"
      }
    ]
  }
}
 

Get Domain NameServer Settings Command

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

Get Domain Nameserver Settings Request Parameter
解释
domainThe domain whose name server setting you want to get, only 1 domain's name server setting can be pulled per request.
XML结果标签
解释
<GetDnsResponse></GetDnsResponse>响应XML文档的根节点
<GetDnsHeader></GetDnsHeader>响应标头
<ResponseCode></ResponseCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用
<GetDnsContent></GetDnsContent>响应内容
<NameServerSettings></NameServerSettings>域名的域名服务器设置
<Type></Type>域名的域名服务器类型

Get Domain Nameserver Settings Example

Request (XML format)

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

Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<GetDnsResponse>
  <GetDnsHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </GetDnsHeader>
  <GetDnsContent>
    <NameServerSettings>
      <Type>Dynadot Parking</Type>
      <WithAds>Yes</WithAds>
    </NameServerSettings>
  </GetDnsContent>
</GetDnsResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=get_dns&domain=mydomain.com

Response (JSON format)
{
  "GetDnsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "GetDns": {
      "NameServerSettings": {
        "Type": "Dynadot Parking",
        "WithAds": "Yes"
      }
    }
  }
}
 

Get Transfer Auth Code Command

您必须在请求授权代码前先解锁域名和账户。

获取转移授权代码请求参数
解释
domain您想要为其获取转移授权代码的域名，每一次请求只可以输入1个域名
new_code (optional)生成新的转移授权代码
unlock_domain_for_transfer (Optional. Requires api skip lock agreement to use)如果您要解锁域名进行转移，那么请将其设为等于“1”。如果请求成功得到处理，域名将被解锁。
XML结果标签
解释
<GetTransferAuthCodeResponse></GetTransferAuthCodeResponse>响应XML文件的根节点XML文件
<GetTransferAuthCodeHeader></GetTransferAuthCodeHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用
<AuthCode></AuthCode>授权代码将用于开启域名转移。

获取转移授权代码示例

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=get_transfer_auth_code&domain=domian1.com&new_code=1&unlock_domain_for_transfer=1

Response (XML format)
<GetTransferAuthCodeResponse>
   <GetTransferAuthCodeHeader>
      <SuccessCode>0</SuccessCode>
      <Status>success</Status>
      <AuthCode>testauthcode</AuthCode>
   </GetTransferAuthCodeHeader>
</GetTransferAuthCodeResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=get_transfer_auth_code&domain=domian1.com&new_code=1&unlock_domain_for_transfer=1

Response (JSON format)
{
   "GetTransferAuthCodeResponse":{
      "ResponseCode":"0",
      "Status":"success",
      "AuthCode":"testauthcode"
   }
}
 

Get Transfer Status Command

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

Get Transfer Status Request Parameter
解释
domainThe domain name you want to get transfer status for, only 1 domain can be entered per request
transfer_typeThe transfer type you want to get transfer status for (transfer in or transfer away)
XML结果标签
解释
<GetTransferStatusResponse></GetTransferStatusResponse>响应XML文件的根节点XML文件
<GetTransferStatusHeader></GetTransferStatusHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用
<GetTransferStatusContent></GetTransferStatusContent>响应内容
<TransferList></TransferList>Transfer list
<Transfer></Transfer>Transfer info
<OrderId></OrderId>The order id
<TransferStatus></TransferStatus>The transfer status of domain.If you got 'none' or 'approved', you can cancel the transfer.If you got 'waiting', means transfer already start.If you got 'auth code needed', means bad auth code, you can use another api SET_TRANSFER_AUTH re-submit auth code.There are also some other statuses, we will send you an email or needs to be checked by our engineers.

Get Transfer Status Example

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=get_transfer_status&domain=domian1.com&transfer_type=in

Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<GetTransferStatusResponse>
  <GetTransferStatusHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </GetTransferStatusHeader>
  <GetTransferStatusContent>
    <TransferList>
      <Transfer>
        <OrderId>testorderid</OrderId>
        <TransferStatus>teststatus</TransferStatus>
      </Transfer>
      <Transfer>
        <OrderId>testorderid2</OrderId>
        <TransferStatus>teststatus2</TransferStatus>
      </Transfer>
    </TransferList>
  </GetTransferStatusContent>
</GetTransferStatusResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=get_transfer_status&domain=domian1.com&transfer_type=in

Response (JSON format)
{
  "GetTransferStatusResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "TransferList": [
      {
        "OrderId": "testorderid",
        "TransferStatus": "teststatus"
      },
      {
        "OrderId": "testorderid2",
        "TransferStatus": "teststatus2"
      }
    ]
  }
}
 

Set Transfer Auth Code For Transfer Order Command

The command which allows you to update auth code for processing transfer orders. If calling set transfer auth code command, the following parameters should be included:

Set Transfer Auth Code Request Parameter
解释
domainThe domain name you update the transfer auth for, only 1 domain can be entered per request
auth_codeThe auth_code you want to re-submit
order_idThe transfer order id, you can get it from another api get_transfer_status.
XML结果标签
解释
<GetTransferStatusResponse></GetTransferStatusResponse>响应XML文件的根节点XML文件
<GetTransferStatusHeader></GetTransferStatusHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用

Set Transfer Auth Code Example

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=set_transfer_auth_code&domain=domain4.com&auth_code=testauthcode

Response (XML format)
<SetTransferAuthCodeResponse>
   <SetTransferAuthCodeHeader>
      <SuccessCode>0</SuccessCode>
      <Status>success</Status>
   </SetTransferAuthCodeHeader>
</SetTransferAuthCodeResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=set_transfer_auth_code&domain=domain4.com&auth_code=testauthcode

Response (JSON format)
{
   "SetTransferAuthCodeResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Cancel Transfer For Order Command

The Command allows you to cancel a transfer item in the order. If calling cancel transfer command, the following parameters should be included:

Cancel Transfer Request Parameter
解释
domainThe domain name you want to cancel transfer for, only 1 domain can be entered per request
order_idThe transfer order id, you can get it from another api get_transfer_status.
XML结果标签
解释
<CancelTransferResponse></CancelTransferResponse>响应XML文件的根节点XML文件
<CancelTransferHeader></CancelTransferHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用

Cancel Transfer Example

Request (XML format)

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

Response (XML format)
<CancelTransferResponse>
   <CancelTransferHeader>
      <SuccessCode>0</SuccessCode>
      <Status>success</Status>
   </CancelTransferHeader>
</CancelTransferResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=cancel_transfer&domain=domain4.com

Response (JSON format)
{
   "CancelTransferResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Authorize Transfer Away Command (RESELLER ONLY)

Authorize Transfer Away Request Parameter
解释
domainThe domain name you want to authorize transfer away for, only 1 domain can be entered per request
order_idThe Dynadot order_id of the domain you want to transfer away
authorizeTo authorize the transfer away, set it equal to "approve". To deny the transfer away, set it equal to "deny".
XML结果标签
解释
<AuthorizeTransferAwayResponse></AuthorizeTransferAwayResponse>响应XML文件的根节点XML文件
<AuthorizeTransferAwayHeader></AuthorizeTransferAwayHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用
<Result></Result>The result of authorize transfer away

Authorize Transfer Away Example

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=authorize_transfer_away&domain=domian.com&authorize=approve&order_id=123

Response (XML format)
<AuthorizeTransferAwayResponse>
   <AuthorizeTransferAwayHeader>
      <SuccessCode>0</SuccessCode>
      <Status>success</Status>
      <Result>away_approved</Result>
   </AuthorizeTransferAwayHeader>
</AuthorizeTransferAwayResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=authorize_transfer_away&domain=domian.com&authorize=approve&order_id=123

Response (JSON format)
{
   "AuthorizeTransferAwayResponse":{
      "ResponseCode":"0",
      "Status":"success",
      "Result":"away_approved"
   }
}
 

Create CN Audit Command

The Command allows you to create a CN audit for a contact. If calling create cn audit command, the following parameters should be included:

Create CN Audit Request Parameter
解释
contact_idThe contact record id you want start audit for, only 1 contact id can be entered per request
contact_typeType of contact, can be either "Individual" or "Enterprise"
individual_id_typeNatural person's ID type, expected values (description of value) are:
JGZ (Officer's identity card of the People's Republic of China)
SFZ (ID card of the People's Republic of China)
HZ (Passport)
GAJMTX (Exit-Entry Permit for Travelling to and from Hong Kong and Macao)
TWJMTX (Travel passes for Taiwan Residents to Enter or Leave the Mainland)
WJLSFZ (Foreign Permanent Resident ID Card of the People's Republic of China)
GAJZZ (Residence permit for Hong Kong, Macao)
TWJZZ (Residence permit for Taiwan residents)
QT (Others)
individual_license_idThe License number of natural person's ID
individual_urlDocument of natural person license ID. The file url on the server. Only jpg, gif, png, jpeg are allowed
enterprise_id_type (Mandatory when contact type is "Enterprise")Enterprise ID type, expected values (description of value) are:
ORG (Organization Code Certificate)
YYZZ (Business License)
TYDM (Certificate for Uniform Social Credit Code)
BDDM (Military Code Designation)
JDDWFW (Military Paid External Service License)
SYDWFR (Public Institution Legal Person Certificate)
WGCZJG (Resident Representative Offices of Foreign Enterprises Registration Form)
SHTTFR (Social Organization Legal Person Registration Certificate)
ZJCS (Religion Activity Site Registration Certificate)
MBFQY (Private Non-Enterprise Entity Registration Certificate)
JJHFR (Fund Legal Person Registration Certificate)
LSZY (Practicing License of Law Firm)
WGZHWH (Registration Certificate of Foreign Cultural Center in China)
WLCZJG (Resident Representative Office of Tourism Departments of Foreign Government Approval Registration Certificate)
SFJD (Judicial Expertise License)
JWJG (Overseas Organization Certificate)
SHFWJG (Social Service Agency Registration Certificate)
MBXXBX (Private School Permit)
YLJGZY (Medical Institution Practicing License)
GZJGZY (Notary Organization Practicing License)
BJWSXX (Beijing School for Children of Foreign Embassy Staff in China Permit)
QTTYDM (Others-Certificate for Uniform Social Credit Code)
QT (Others)
enterprise_license_id (Mandatory when contact type is "Enterprise")The License number of enterprise document
enterprise_url (Mandatory when contact type is "Enterprise")Document of enterprise license. The file url on the server. Only jpg, gif, png, jpeg are allowed
XML结果标签
解释
<CreateCnAuditResponse></CreateCnAuditResponse>响应XML文档的根节点
<CreateCnAuditHeader></CreateCnAuditHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用

Create CN Audit Example

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=create_cn_audit&contact_id=testcontactid&contact_type=Enterprise&individual_id_type=SFZ&individual_license_id=testlicenseid&individual_url=url1&enterprise_id_type=ORG&enterprise_license_id=testlicenseid2&enterprise_url=url2

Response (XML format)
<CreateCnAuditResponse>
  <CreateCnAuditHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </CreateCnAuditHeader>
 </CreateCnAuditResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=create_cn_audit&contact_id=testcontactid&license_id=testlicenseid&url=url

Response (JSON format)
{
   "CreateCnAuditResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

Get Cn Audit Status Command

If calling get cn audit status command, the following parameters should be included:

Get Cn Audit Status Request Parameter
解释
contact_idThe contact record id you want to get audit status for, only 1 contactId can be entered per request
gtldIf you query the audit result of the cnnic-gtld, set this parameter to 1
XML结果标签
解释
<GetCnAuditStatusResponse></GetCnAuditStatusResponse>响应XML文件的根节点XML文件
<GetCnAuditStatusHeader></GetCnAuditStatusHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用
<CnAuditStatus></CnAuditStatus>the audit status of cnnic audit record. You may got 'processing' or 'waiting for cnnic' or 'failed'. If failed, we will send you an email.
<FailedReason></FailedReason>If the audit unpass, the failed reason will be displayed

Get Cn Audit Status Example

Request (XML format)

https://api.dynadot.xml/api3.xml?key=mykey&command=get_cn_audit_status&contact_id=testcontactid

Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<GetCnAuditStatusResponse>
  <GetCnAuditStatusHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
    <CnAuditStatus>pass</CnAuditStatus>
  </GetCnAuditStatusHeader>
</GetCnAuditStatusResponse>
Request (JSON format)

https://api.dynadot.json/api3.xml?key=mykey&command=get_cn_audit_status&contact_id=testcontactid

Response (JSON format)
{
  "GetCnAuditStatusResponse": {
    "ResponseCode": "0",
    "Status": "success",
    "CnAuditStatus": "pass"
  }
}
 

Get Account Balance Command

This command is only available in XML and JSON format:

Get Account Balance Request Parameter
解释
N/A无需额外参数
XML结果标签
解释
<GetAccountBalanceResponse></GetAccountBalanceResponse>响应XML文件的根节点XML文件
<GetAccountBalanceHeader></GetAccountBalanceHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用
<GetAccountBalanceContent></GetAccountBalanceContent>响应内容
<Balance></Balance>帐户余额

Get Account Balance Example

Request (XML format)

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

Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<GetAccountBalanceResponse>
  <GetAccountBalanceHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </GetAccountBalanceHeader>
  <GetAccountBalanceContent>
    <BalanceList>
      <Balance>
        <Currency>USD</Currency>
        <Amount>300.00</Amount>
      </Balance>
    </BalanceList>
  </GetAccountBalanceContent>
</GetAccountBalanceResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=get_account_balance

Response (JSON format)
{
  "GetAccountBalanceResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "BalanceList": [
      {
        "Currency": "USD",
        "Amount": "300.00"
      }
    ]
  }
}
 

Get Listings Command

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

Get Listings Request Parameter
解释
currency (可选)返回货币结果，应为"usd", "eur", 或 "cny",，默认货币为美元
exclude_pending_sale (可选)If you don't want to get pending sale lock listings, it should be "yes", default is "no"
XML结果标签
解释
<GetListingsResponse></GetListingsResponse>响应XML文件的根节点XML文件
<GetListingsHeader></GetListingsHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用
<GetListingsContent></GetListingsContent>Listing content
<Listing></Listing>Listing item content
<ListingId></ListingId>Listing Id
<Domain></Domain>域名名称
<Price></Price>出售价格
<InBoundLinks></InBoundLinks>In bound links count
<Age></Age>域名年龄
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用

Get Listings Example

Request (XML format)

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

Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<GetListingsResponse>
  <GetListingsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </GetListingsHeader>
  <GetListingsContent>
    <Listing>
      <ListingId>id1</ListingId>
      <Domain>domain_name1</Domain>
      <Price>1</Price>
      <InboundLinks>1</InboundLinks>
      <Age>1</Age>
      <PendingSaleLocked>No</PendingSaleLocked>
    </Listing>
    <Listing>
      <ListingId>id2</ListingId>
      <Domain>domain_name2</Domain>
      <Price>2</Price>
      <InboundLinks>2</InboundLinks>
      <Age>2</Age>
      <PendingSaleLocked>No</PendingSaleLocked>
    </Listing>
  </GetListingsContent>
</GetListingsResponse>
Request (JSON format)

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

Response (JSON format)
{
  "GetListingsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "Listing": [
      {
        "ListingId": "id1",
        "Domain": "domain_name1",
        "Price": "1",
        "InboundLinks": "1",
        "Age": "1",
        "PendingSaleLocked": "No"
      },
      {
        "ListingId": "id2",
        "Domain": "domain_name2",
        "Price": "2",
        "InboundLinks": "2",
        "Age": "2",
        "PendingSaleLocked": "No"
      }
    ]
  }
}
 

Get Listing Item Command

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

Get Listing Item Request Parameter
解释
domainThe domain name you want to get detail, only 1 domain can be entered per request
currency (可选)返回货币结果，应为"usd", "eur", 或 "cny",，默认货币为美元
XML结果标签
解释
<GetListingItemResponse></GetListingItemResponse>响应XML文件的根节点XML文件
<GetListingItemHeader></GetListingItemHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用
<GetListingsItemContent></GetListingsItemContent>Listing content
<Listing></Listing>Listing item content
<ListingId></ListingId>Listing Id
<Domain></Domain>域名名称
<Price></Price>出售价格
<InBoundLinks></InBoundLinks>In bound links count
<Age></Age>域名年龄

Get Listing Item Example

Request (XML format)

http://api.dynadot.com/api3.xml?key=my_key&command=get_listing_item&currency=usd&domain=domain_name

Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<GetListingsItemResponse>
  <GetListingsItemHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </GetListingsItemHeader>
  <GetListingsItemContent>
    <Listing>
      <ListingId>id</ListingId>
      <Domain>domain_name</Domain>
      <Price>0</Price>
      <InboundLinks>0</InboundLinks>
      <Age>0</Age>
      <PendingSaleLocked>No</PendingSaleLocked>
    </Listing>
  </GetListingsItemContent>
</GetListingsItemResponse>
Request (JSON format)

http://api.dynadot.com/api3.json?key=my_key&command=get_listing_item&currency=usd&domain=domain_name

Response (JSON format)
{
  "GetListingsItemResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "Listing": {
      "ListingId": "id",
      "Domain": "domain_name",
      "Price": "0",
      "InboundLinks": "0",
      "Age": "0",
      "PendingSaleLocked": "No"
    }
  }
}
 

Buy It Now Command

If calling buy it now command, the following parameters should be included:

Buy It Now Request Parameter
解释
domainThe domain you want to buy, only 1 domain can be entered per request
currency (可选)返回货币结果，应为"usd", "eur", 或 "cny",，默认货币为美元
XML结果标签
解释
<BuyItNowResponse></BuyItNowResponse>响应XML文件的根节点XML文件
<BuyItNowHeader></BuyItNowHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用
<Message></Message>It should be "domain order created", only used when status is "success".

Buy It Now Example

Request (XML format)

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

Response (XML format)
<BuyItNowResponse>
   <BuyItNowHeader>
      <SuccessCode>0</SuccessCode>
      <Status>success</Status>
   </BuyItNowHeader>
   <Message>domain order created</Message>
</BuyItNowResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=buy_it_now&domain=domain&currency=currency

Response (JSON format)
{
   "BuyItNowResponse":{
      "ResponseCode":"0",
      "Status":"success",
      "Message":"domain order created"
   }
}
 

账户信息命令

This command is only available in XML and JSON format:

账户信息请求参数
解释
N/A无需额外参数
XML结果标签
解释
<AccountInfoResponse></AccountInfoResponse>响应XML文档的根节点
<AccountInfoHeader></AccountInfoHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用
<AccountInfoContent></AccountInfoContent>响应内容
<AccountInfo></AccountInfo>账户信息
<Username></Username>用户名
<ForumName></ForumName>论坛名称
<Contact></Contact>联系方式信息
<Organization></Organization>整理与归纳
<Organization></Organization>响应标头
<Name></Name>您的名称
<Email></Email>邮箱
<PhoneCc></PhoneCc>国家区号
<PhoneNum></PhoneNum>电话号码
<Address1></Address1>地址第1行
<Address2></Address2>第2行地址
<City></City>城市
<State></State>州
<ZipCode></ZipCode>邮政区代码
<Country></Country>国家
<CustomerSince></CustomerSince>客户身份始于
<AccountLock></AccountLock>账户锁定
<TotalSpending></TotalSpending>花费总计
<PriceLevel></PriceLevel>价格级别
<AccountBalance></AccountBalance>账户余额
<CustomTimeZone></CustomTimeZone>自定义时区
<DefaultSettings></DefaultSettings>默认设置
<DefaultWhois></DefaultWhois>默认Whois
<DefaultRegistrant></DefaultRegistrant>默认注册人
<ContactId></ContactId>联络人ID
<DefaultAdmin></DefaultAdmin>默认管理员
<DefaultTechnical></DefaultTechnical>默认技术类型
<DefaultBilling></DefaultBilling>默认账单
<Type></Type>域名服务器类型
<WithAds></WithAds>是否带有广告

账户信息示例

Request (XML format)

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

Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<AccountInfoResponse>
  <AccountInfoHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </AccountInfoHeader>
  <AccountInfoContent>
    <AccountInfo>
      <Username>testname</Username>
      <ForumName>test forum name</ForumName>
      <Contact>
        <Organization/>
        <Name>testname test</Name>
        <Email>[email protected]</Email>
        <PhoneCc>1</PhoneCc>
        <PhoneNum>555.555.5233</PhoneNum>
        <FaxCc/>
        <FaxNum/>
        <Address1>1 test road</Address1>
        <Address2/>
        <City>Los Angeles</City>
        <State>CA</State>
        <ZipCode>90000</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>
Request (JSON format)

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

Response (JSON format)
{
  "AccountInfoResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "AccountInfo": {
      "Username": "testname",
      "ForumName": "test forum name",
      "Contact": {
        "Organization": "",
        "Name": "testname test",
        "Email": "[email protected]",
        "PhoneCc": "1",
        "PhoneNum": "555.555.5233",
        "FaxCc": "",
        "FaxNum": "",
        "Address1": "1 test road",
        "Address2": "",
        "City": "Los Angeles",
        "State": "CA",
        "ZipCode": "90000",
        "Country": "US"
      },
      "CustomerSince": "1364888735253",
      "AccountLock": "on",
      "TotalSpending": "$0.00",
      "PriceLevel": "Regular Pricing",
      "AccountBalance": "$70.02",
      "CustomTimeZone": "PST",
      "DefaultSettings": {
        "DefaultWhois": {
          "DefaultRegistrant": {
            "ContactId": "0"
          },
          "DefaultAdmin": {
            "ContactId": "0"
          },
          "DefaultTechnical": {
            "ContactId": "0"
          },
          "DefaultBilling": {
            "ContactId": "0"
          }
        },
        "DefaultNameServerSettings": {
          "Type": "Dynadot Parking",
          "WithAds": "yes"
        }
      }
    }
  }
}
 

设置默认Whois

如果呼叫设置默认Whois命令，则应包含以下参数：

设置默认Whois请求参数
解释
registrant_contact域名的注册人信息
admin_contact域名管理员信息
technical_contact域名的技术信息
billing_contact域名的计费信息
XML结果标签
解释
<SetDefaultWhoisResponse></SetDefaultWhoisResponse>响应XML文档的根节点
<SetDefaultWhoisHeader></SetDefaultWhoisHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用

设置默认Whois示例

Request (XML format)

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 (XML format)
<SetDefaultWhoisResponse>
   <SetDefaultWhoisHeader>
      <SuccessCode>0</SuccessCode>
      <Status>success</Status>
   </SetDefaultWhoisHeader>
</SetDefaultWhoisResponse>
Request (JSON format)

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

Response (JSON format)
{
   "SetDefaultWhoisResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

设置默认域名服务器命令

如果呼叫设置默认域名服务器命令，则应包含下列参数：

设置默认域名服务器请求参数
解释
ns0 - ns12您要设置的域名服务器
XML结果标签
解释
<SetDefaultNsResponse></SetDefaultNsResponse>设置默认域名服务器响应标签，它是XML文档响应的根节点
<SetDefaultNsHeader></SetDefaultNsHeader>设置默认域名服务器标题标签
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用
<SetDefaultNsContent></SetDefaultNsContent>设置默认域名服务器内容标签，仅当状态为"success"时使用
<Servers></Servers>已设置的服务器信息
<Server></Server>每个服务器
<ServerName></ServerName>服务器名称
<ServerId></ServerId>服务器id

设置默认域名服务器示例

Request (XML format)

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

Response (XML format)
<SetDefaultNsResponse>
   <SetDefaultNsHeader>
      <SuccessCode>0</SuccessCode>
      <Status>success</Status>
   </SetDefaultNsHeader>
   <SetDefaultNsContent>
      <Servers>
         <Server>
            <ServerName>ns1.hosts.com</ServerName>
            <ServerId>0</ServerId>
         </Server>
         <Server>
            <ServerName>ns2.host.com</ServerName>
            <ServerId>1</ServerId>
         </Server>
         <Server>
            <ServerName />
            <ServerId />
         </Server>
         <Server>
            <ServerName />
            <ServerId />
         </Server>
         <Server>
            <ServerName />
            <ServerId />
         </Server>
         <Server>
            <ServerName />
            <ServerId />
         </Server>
         <Server>
            <ServerName />
            <ServerId />
         </Server>
         <Server>
            <ServerName />
            <ServerId />
         </Server>
         <Server>
            <ServerName />
            <ServerId />
         </Server>
         <Server>
            <ServerName />
            <ServerId />
         </Server>
         <Server>
            <ServerName />
            <ServerId />
         </Server>
         <Server>
            <ServerName />
            <ServerId />
         </Server>
         <Server>
            <ServerName />
            <ServerId />
         </Server>
      </Servers>
   </SetDefaultNsContent>
</SetDefaultNsResponse>
Request (JSON format)

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

Response (JSON format)
{
   "SetDefaultNsResponse":{
      "ResponseCode":"0",
      "Status":"success",
      "SetDefaultNsContent":{
         "Servers":[
            {
               "ServerName":"ns1.hosts.com",
               "ServerId":"0"
            },
            {
               "ServerName":"ns2.host.com",
               "ServerId":"1"
            },
            {
               "ServerName":"",
               "ServerId":""
            },
            {
               "ServerName":"",
               "ServerId":""
            },
            {
               "ServerName":"",
               "ServerId":""
            },
            {
               "ServerName":"",
               "ServerId":""
            },
            {
               "ServerName":"",
               "ServerId":""
            },
            {
               "ServerName":"",
               "ServerId":""
            },
            {
               "ServerName":"",
               "ServerId":""
            },
            {
               "ServerName":"",
               "ServerId":""
            },
            {
               "ServerName":"",
               "ServerId":""
            },
            {
               "ServerName":"",
               "ServerId":""
            },
            {
               "ServerName":"",
               "ServerId":""
            }
         ]
      }
   }
}
 

设置默认停放命令

如果发送设置默认停放命令，则须包含下列参数：

设置默认停放请求参数
解释
with_ads (可选)如果您不想要第三方广告，则可将此参数设置为"no",，默认值为"yes"
XML结果标签
解释
<SetDefaultParkingResponse></SetDefaultParkingResponse>响应XML文档的根节点
<SetDefaultParkingHeader></SetDefaultParkingHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用

设置默认停放示例

Request (XML format)

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

Response (XML format)
<SetDefaultParkingResponse>
   <SetDefaultParkingHeader>
      <SuccessCode>0</SuccessCode>
      <Status>success</Status>
   </SetDefaultParkingHeader>
</SetDefaultParkingResponse>
Request (JSON format)

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

Response (JSON format)
{
   "SetDefaultParkingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

设置默认转发命令

如果发送设置默认转发命令，则须包含下列参数：

设置默认转发请求参数
解释
forward_url您希望域名转发至的URL地址。请注意，参数必须为已编码，以便API调用可得到正确解析。
is_temp (可选)您要跳转域名的跳转状态，默认值为"temporary",，若您要永久跳转，则可将此参数设为"no"
XML结果标签
解释
<SetDefaultForwardingResponse></SetDefaultForwardingResponse>响应XML文档的根节点
<SetDefaultForwardingHeader></SetDefaultForwardingHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用

设置默认转发示例

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=set_default_forwarding&forward_url=http%3A%2F%2Fmydomain.com

Response (XML format)
<SetDefaultForwardingResponse>
  <SetDefaultForwardingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDefaultForwardingHeader>
</SetDefaultForwardingResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=set_default_forwarding&forward_url=http%3A%2F%2Fmydomain.com

Response (JSON format)
{
   "SetDefaultForwardingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

设置默认隐身命令

如果要发送默认隐身命令，则须包含下列参数：

设置默认隐身请求参数
解释
stealth_url您希望域名转发至的URL地址。请注意，参数必须为已编码，以便API调用可得到正确解析。
stealth_title (可选)页面标题
XML结果标签
解释
<SetDefaultStealthResponse></SetDefaultStealthResponse>响应XML文档的根节点
<SetDefaultStealthHeader></SetDefaultStealthHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用

设置默认隐身示例

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=set_default_stealth&stealth_title=obama's shop&stealth_url=http%3A%2F%2Fwww.obamashop.com

Response (XML format)
<SetDefaultStealthResponse>
  <SetDefaultStealthHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDefaultStealthHeader>
</SetDefaultStealthResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=set_default_stealth&stealth_title=obama's shop&stealth_url=http%3A%2F%2Fwww.obamashop.com

Response (JSON format)
{
   "SetDefaultStealthResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

设置默认托管命令

如果发送设置默认托管命令，则须包含下列参数：

设置默认托管请求参数
解释
hosting_type您想要的默认托管类型，可以选择"advanced"和"basic"
XML结果标签
解释
<SetDefaultHostingResponse></SetDefaultHostingResponse>响应XML文档的根节点
<SetDefaultHostingHeader></SetDefaultHostingHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用

设置默认托管示例

Request (XML format)

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

Response (XML format)
<SetDefaultHostingResponse>
  <SetDefaultHostingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDefaultHostingHeader>
</SetDefaultHostingResponse>
Request (JSON format)

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

Response (JSON format)
{
   "SetDefaultHostingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

设置默认域名系统命令

如果发送设置默认域名系统命令，则须包含下列参数：

（该命令已过时，不建议使用，请使用Set Default DNS2命令）

设置默认域名系统请求参数
解释
main_record_type主要记录类型
main_record为您的域名制定一个域名系统记录
main_txt (可选)为您的域名指定TXT记录；若your main_record_type为aaaa，且指定了一个main_record2，则您可设置多达3个main_txts，否则，您可设置多达4个main_txts
main_record2主记录2，仅当"main_record_type"为"aaaa"时使用，其值必须为IPV4格式
subdomain0 - subdomain99 (可选)子域名记录
sub_record_type0 - sub_record_type99 (可选)子域名记录类型
sub_record0 - sub_record99 (可选)IP地址或目标主机
mx_host0 - mx_host2 (可选)指定您域名的邮箱主机，distance0为最高优先级
mx_distance0 - mx_distance2 (可选)Distance0为最高优先级
ttl (可选)生存时间
XML结果标签
解释
<SetDefaultDnsResponse></SetDefaultDnsResponse>响应XML文档的根节点
<SetDefaultDnsHeader></SetDefaultDnsHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用

设置默认域名系统示例

Request (XML format)

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 (XML format)
<SetDefaultDnsResponse>
  <SetDefaultDnsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDefaultDnsHeader>
</SetDefaultDnsResponse>
Request (JSON format)

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

Response (JSON format)
{
   "SetDefaultDnsResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

设置默认DNS2命令

如果发送设置默认域名系统命令，则须包含下列参数：

设置默认DNS2请求参数
解释
main_record_type0 - main_record_type19主要记录类型
main_record0 - main_record19为您的域名指定DNS记录
main_recordx0 - main_recordx19Mx距离、转发类型、隐形转发标题或电子邮件别名当main_record_type为"a"、"aaaa"、"cname"、"forward"、"txt"、"mx"、"stealth"、"email"时必须提供
subdomain0 - subdomain99 (可选)子域名记录
sub_record_type0 - sub_record_type99 (可选)子域名记录类型
sub_record0 - sub_record99 (可选)子域名IP地址或目标主机
sub_recordx0 - subdo_recordx99Mx距离、转发类型、隐形转发标题或电子邮件别名当sub_record_type为"a"、"aaaa"、"cname"、"forward"、"txt"、"srv"、"mx"、"stealth"、"email"时必须提供
ttl (可选)生存时间
XML结果标签
解释
<SetDefaultDnsResponse></SetDefaultDnsResponse>响应XML文档的根节点
<SetDefaultDnsHeader></SetDefaultDnsHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用

设置默认DNS2示例

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=set_default_dns2&main_record_type0=aaaa&main_record0=0:0:0:0:0:0:0:1

Response (XML format)
<SetDefaultDnsResponse>
  <SetDefaultDnsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDefaultDnsHeader>
</SetDefaultDnsResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=set_default_dns2&main_record_type0=aaaa&main_record0=0:0:0:0:0:0:0:1

Response (JSON format)
{
   "SetDefaultDnsResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

设置默认电子邮件转发命令

如果发送设置默认电子邮件转发命令，则须包含下列参数：

设置默认电子邮件转发请求参数
解释
forward_type转发类型，可以是"donot":：不要转发邮件；"mx":将邮件转发给另一个邮箱主机（MX记录）；"forward":：将邮件转发给另一个邮箱主机
username0 - username9用户名，仅"forward_type"为"forward"时使用
exist_email0 - exist_email9现有电子邮箱地址，仅当"forward_type"为"forward"时使用
mx_host0 - mx_host2邮箱主机，仅"forward_type"为"mx"时使用
mx_distance0 - mx_distance2Distance0为最高优先级，仅当"forward_type"为"mx"时使用
XML结果标签
解释
<SetDefaultEmailForwardingResponse></SetDefaultEmailForwardingResponse>响应XML文档的根节点
<SetDefaultEmailForwardingHeader></SetDefaultEmailForwardingHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用

设置默认电子邮件转发示例

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=set_default_email_forward&forward_type=forward&username0=peter&[email protected]

Response (XML format)
<SetDefaultEmailForwardingResponse>
  <SetDefaultEmailForwardingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDefaultEmailForwardingHeader>
</SetDefaultEmailForwardingResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=set_default_email_forward&forward_type=forward&username0=peter&[email protected]

Response (JSON format)
{
   "SetDefaultEmailForwardingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

设置清除默认设置命令

如果呼叫设置清除默认设置命令，则需包含以下参数：

设置清除默认设置请求参数
解释
service您要清除的服务，它可以是“转发”、“隐形”、“电子邮件转发”、“dns”和“名字服务器”
XML结果标签
解释
<SetClearDefaultSettingResponse></SetClearDefaultSettingResponse>响应XML文档的根节点
<SetClearDefaultSettingHeader></SetClearDefaultSettingHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用

设置清除默认设置示例

Request (XML format)

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

Response (XML format)
<SetClearDefaultSettingResponse>
  <SetClearDefaultSettingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetClearDefaultSettingHeader>
</SetClearDefaultSettingResponse>
Request (JSON format)

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

Response (JSON format)
{
   "SetClearDefaultSettingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

设置默认续费选项命令

如果发送设置默认续费选项命令，则须包含下列参数：

设置默认续费选项请求参数
解释
renew_option可以是"donot", "auto", "reset"
XML结果标签
解释
<SetDefaultRenewOptionResponse></SetDefaultRenewOptionResponse>响应XML文档的根节点
<SetDefaultRenewOptionHeader></SetDefaultRenewOptionHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用

设置默认续费选项示例

Request (XML format)

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

Response (XML format)
<SetDefaultRenewOptionResponse>
  <SetDefaultRenewOptionHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetDefaultRenewOptionHeader>
</SetDefaultRenewOptionResponse>
Request (JSON format)

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

Response (JSON format)
{
   "SetDefaultRenewOptionResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

创建文件夹命令

如果发送创建文件夹命令，则须包含下列参数：

创建文件夹请求参数
解释
folder_name您想创建的文件夹名称
XML结果标签
解释
<FolderCreateResponse></FolderCreateResponse>响应XML文档的根节点
<FolderCreateHeader></FolderCreateHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用
<FolderCreateContent></FolderCreateContent>响应内容
<FolderName></FolderName>文件夹名称
<FolderId></FolderId>新文件夹ID

创建文件夹示例

Request (XML format)

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

Response (XML format)
<FolderCreateResponse>
  <FolderCreateHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </FolderCreateHeader>
  <FolderCreateContent>
    <FolderName>new</FolderName>
    <FolderId>1</FolderId>
  </FolderCreateContent>
</FolderCreateResponse>
Request (JSON format)

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

Response (JSON format)
{
   "FolderCreateResponse":{
      "ResponseCode":"0",
      "Status":"success",
      "FolderCreateContent":{
         "FolderName":"new",
         "FolderId":"1"
      }
   }
}
 

删除文件夹命令

如果设置Whois命令，则应包含以下参数：

删除文件夹请求参数
解释
folder_id您要删除的文件夹ID，确保用逗号分隔
XML结果标签
解释
<DeleteFolderResponse></DeleteFolderResponse>响应XML文档的根节点
<DeleteFolderHeader></DeleteFolderHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用

删除文件夹例子

Request (XML format)

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

Response (XML format)
<DeleteFolderResponse>
  <DeleteFolderHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </DeleteFolderHeader>
</DeleteFolderResponse>
Request (JSON format)

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

Response (JSON format)
{
   "DeleteFolderResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

设置文件夹Whois命令

如果呼叫设置文件夹Whois命令，则应包含下列参数：

设置文件夹Whois请求参数
解释
folder_id您要设置的文件夹ID
registrant_contact域名的注册人信息
admin_contact域名管理员信息
technical_contact域名的技术信息
billing_contact域名的计费信息
enable (可选)如果您要将此Whois设置应用于今后移动至此文件夹的域名，则可将此参数设为"yes"
sync (可选)如果您要将此Whois设置同步于此文件夹下的所有域名，则应将此参数设为"yes"
XML结果标签
解释
<SetFolderWhoisResponse></SetFolderWhoisResponse>响应XML文档的根节点
<SetFolderWhoisHeader></SetFolderWhoisHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用

设置Whois文件夹示例

Request (XML format)

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 (XML format)
<SetFolderWhoisResponse>
  <SetFolderWhoisHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderWhoisHeader>
</SetFolderWhoisResponse>
Request (JSON format)

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

Response (JSON format)
{
   "SetFolderWhoisResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

设置文件夹名称服务器命令

如果呼叫设置文件夹名称服务器命令，则应包含下列参数：

设置文件夹名称服务器请求参数
解释
fold_id您要设置的文件夹ID，每个请求可设置1个文件夹
ns0 - ns12您要设置并启用域名的域名服务器，您可指定多达13个域名服务器，但它们必须已经在您的账户中
enable (可选)如果您要将此域名服务器设置应用于今后移动至该文件夹的域名，则可将此参数设为"yes"
sync (可选)若要同步该文件夹下所有域名的域名服务器设置，则可将此参数设为"yes"
XML结果标签
解释
<SetFolderNsResponse></SetFolderNsResponse>设置域名服务器响应标签，它是响应XML文档的根节点
<SetFolderNsHeader></SetFolderNsHeader>设置文件夹名称服务器响应标题标签
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用
<SetFolderNsContent></SetFolderNsContent>设置文件夹名称服务器响应内容标签，仅当状态为"success"时使用
<Servers></Servers>已设置的服务器信息
<Server></Server>每个服务器
<ServerName></ServerName>服务器名称
<ServerId></ServerId>服务器ID

设置文件夹名称服务器示例

Request (XML format)

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 (XML format)

0 success ns1.hosts.com 0 ns2.host.com 1

Request (JSON format)

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

Response (JSON format)
{
   "SetFolderNsResponse":{
      "ResponseCode":"0",
      "Status":"success",
      "SetFolderNsContent":{
         "Servers":[
            {
               "ServerName":"ns1.hosts.com",
               "ServerId":"0"
            },
            {
               "ServerName":"ns2.host.com",
               "ServerId":"1"
            },
            {
               "ServerName":"",
               "ServerId":""
            },
            {
               "ServerName":"",
               "ServerId":""
            },
            {
               "ServerName":"",
               "ServerId":""
            },
            {
               "ServerName":"",
               "ServerId":""
            },
            {
               "ServerName":"",
               "ServerId":""
            },
            {
               "ServerName":"",
               "ServerId":""
            },
            {
               "ServerName":"",
               "ServerId":""
            },
            {
               "ServerName":"",
               "ServerId":""
            },
            {
               "ServerName":"",
               "ServerId":""
            },
            {
               "ServerName":"",
               "ServerId":""
            },
            {
               "ServerName":"",
               "ServerId":""
            }
         ]
      }
   }
}
 

设置文件夹停放命令

如果发送设置文件夹停放命令，则须包含下列参数：

设置文件夹停放请求参数
解释
folder_id您要设置的文件夹ID，每个请求可设置1个文件夹
with_ads (可选)如果您不想要第三方广告，则可将此参数设置为"no",，默认值为"yes"
enable (可选)如果您想为未来移动至此文件夹的域名应用此停放设置，则可将此参数设为"yes"
sync (可选)如果您想将此文件夹内所有域名的停放设置同步，则可将此参数设为"yes"
XML结果标签
解释
<SetFolderParkingResponse></SetFolderParkingResponse>响应XML文档的根节点
<SetFolderParkingHeader></SetFolderParkingHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用

设置文件夹停放示例

Request (XML format)

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

Response (XML format)
<SetFolderParkingResponse>
  <SetFolderParkingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderParkingHeader>
</SetFolderParkingResponse>
Request (JSON format)

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

Response (JSON format)
{
   "SetFolderParkingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

设置文件夹转发命令

如果发送设置文件夹转发命令，则须包含下列参数：

设置文件夹转发请求参数
解释
folder_id您要设置的文件夹ID
forward_url您希望域名转发至的URL地址。请注意，参数必须为已编码，以便API调用可得到正确解析。
is_temp (可选)您要跳转域名的跳转状态，默认值为"temporary",，若您要永久跳转，则可将此参数设为"no"
enable (可选)如果您要将此跳转设置应用于今后移动至该文件夹的域名，则可将此参数设为"yes"
sync (可选)如果您要为此文件夹内所有域名同步跳转设置，则可将此参数设为"yes"
XML结果标签
解释
<SetFolderForwardingResponse></SetFolderForwardingResponse>响应XML文档的根节点
<SetFolderForwardingHeader></SetFolderForwardingHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用

设置文件夹转发示例

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=set_folder_forwarding&folder_id=0&forward_url=http%3A%2F%2Fmydomain.com&sync=yes

Response (XML format)
<SetFolderForwardingResponse>
  <SetFolderForwardingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderForwardingHeader>
</SetFolderForwardingResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=set_folder_forwarding&folder_id=0&forward_url=http%3A%2F%2Fmydomain.com&sync=yes

Response (JSON format)
{
   "SetFolderForwardingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

设置文件夹隐身命令

如果发送设置文件夹隐身命令，则须包含下列参数：

设置文件夹隐身请求参数
解释
folder_id您要设置的文件夹ID
stealth_url您希望域名转发至的URL地址。请注意，参数必须为已编码，以便API调用可得到正确解析。
stealth_title (可选)页面标题
enable (可选)如果您要将此隐身设置应用于今后移动至该文件夹的域名，则可将此参数设为"yes"
sync (可选)如果您要将此隐身设置同步于今后移动至该文件夹的所有域名，则可将此参数设为"yes"
XML结果标签
解释
<SetFolderStealthResponse></SetFolderStealthResponse>响应XML文档的根节点
<SetFolderStealthHeader></SetFolderStealthHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用

设置文件夹隐身示例

Request (XML format)

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

Response (XML format)
<SetFolderStealthResponse>
  <SetFolderStealthHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderStealthHeader>
</SetFolderStealthResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=set_folder_stealth&folder_id=0&stealth_title=obama's shop&stealth_url=http%3A%2F%2Fwww.obamashop.com&sync=yes

Response (JSON format)
{
   "SetFolderStealthResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

设置文件夹托管命令

如果发送设置文件夹托管命令，则须包含下列参数：

设置文件夹托管请求参数
解释
folder_id您要设置的文件夹ID
hosting_type您想要的托管类型，可选择"advanced"和"basic"
enable (可选)如果您要将此托管设置应用于今后移动至该文件夹的域名，则可将此参数设为"yes"
even (可选)如果您想为在此文件夹下所有的域名同步托管设置，则可将次参数设为"yes"
XML结果标签
解释
<SetFolderHostingResponse></SetFolderHostingResponse>响应XML文档的根节点
<SetFolderHostingHeader></SetFolderHostingHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用

设置文件夹托管示例

Request (XML format)

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

Response (XML format)
<SetFolderHostingResponse>
  <SetFolderHostingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderHostingHeader>
</SetFolderHostingResponse>
Request (JSON format)

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

Response (JSON format)
{
   "SetFolderHostingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

设置文件夹域名系统命令

如果要发送设置文件夹域名系统命令，则须包含下列参数：

（该命令已过时，不建议使用。请使用Set Folder DNS2命令）

设置文件夹DNS请求参数
解释
folder_id您要设置的文件夹ID
main_record_type主要记录类型
main_record为您的域名制定一个域名系统记录
main_record为您的域名制定一个域名系统记录
with_ads (可选)为您的域名指定TXT记录；若your main_record_type为aaaa，且指定了一个main_record2，则您可设置多达3个main_txts，否则，您可设置多达4个main_txts
main_record2主记录2，仅当"main_record_type"为"aaaa"时使用，其值必须为IPV4格式
subdomain0 - subdomain99 (可选)Subdomain records (可选)
sub_record_type0 - sub_record_type99 (可选)子域名记录类型
sub_record0 - sub_record99 (可选)IP地址或目标主机
mx_host0 - mx_host2 (可选)指定您域名的邮箱主机，distance0为最高优先级
mx_distance0 - mx_distance2 (可选)Distance0为最高优先级
ttl (可选)生存时间
enable (可选)如果您要将此DNS设置应用于今后您移动至此文件夹的域名，则可将此参数设为"yes"
sync (可选)如果您要将此DNS服务器设置同步于此文件夹中的所有域名，则可将此参数设为"yes"
XML结果标签
解释
<SetFolderDnsResponse></SetFolderDnsResponse>响应XML文档的根节点
<SetFolderDnsHeader></SetFolderDnsHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用

设置文件夹域名系统示例

Request (XML format)

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 (XML format)
<SetFolderDnsResponse>
  <SetFolderDnsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderDnsHeader>
</SetFolderDnsResponse>
Request (JSON format)

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

Response (JSON format)
{
   "SetFolderDnsResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

设置文件夹DNS2命令

如果调用设置文件夹DNS2命令，应包含以下参数：

设置文件夹DNS2请求参数
解释
folder_id您要设置的文件夹ID
main_record_type0 - main_record_type19主记录类型应为"a"、"aaaa"、"cname"、"forward"、"txt"、"mx"、"stealth"、"email"
main_record0 - main_record19为您的域名指定DNS记录
main_recordx0 - main_recordx19Mx距离、转发类型、隐形转发标题或电子邮件别名当sub_record_type为"forward"、"mx"、"stealth"、"email"时必须提供
subdomain0 - subdomain99 (可选)Subdomain records (可选)
sub_record_type0 - sub_record_type99 (可选)子域名记录类型应为"a"、"aaaa"、"cname"、"forward"、"txt"、"srv"、"mx"、"stealth"、"email"
sub_record0 - sub_record99 (可选)IP地址或目标主机
sub_recordx0 - sub_recordx99 (可选)Mx距离、转发类型、隐形转发标题或电子邮件别名当sub_record_type为"forward"、"mx"、"stealth"、"email"时必须提供
ttl (可选)生存时间
enable (可选)如果您要将此DNS设置应用于今后您移动至此文件夹的域名，则可将此参数设为"yes"
sync (可选)如果您要将此DNS服务器设置同步于此文件夹中的所有域名，则可将此参数设为"yes"
XML结果标签
解释
<SetFolderDnsResponse></SetFolderDnsResponse>响应XML文档的根节点
<SetFolderDnsHeader></SetFolderDnsHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用

设置文件夹DNS2示例

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=set_folder_dns2&folder_id=0&main_record_type0=aaaa&main_record0=0:0:0:0:0:0:0:1

Response (XML format)
<SetFolderDnsResponse>
  <SetFolderDnsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderDnsHeader>
</SetFolderDnsResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=set_folder_dns2&folder_id=0&main_record_type0=aaaa&main_record0=0:0:0:0:0:0:0:1

Response (JSON format)
{
   "SetFolderDnsResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

设置文件夹电子邮件转发命令

如果发送设置文件夹电子邮件转发命令，则须包含下列参数：

设置文件夹电子邮件转发请求参数
解释
domain您要设置的域名，每个请求仅可设置100个域名，请务必用逗号将其隔开
folder_id您想设置的文件夹ID
forward_type转发类型，可以是"donot":：不要转发邮件；"mx":将邮件转发给另一个邮箱主机（MX记录）；"forward":：将邮件转发给另一个邮箱主机
username0 - username9用户名，仅"forward_type"为"forward"时使用
exist_email0 - exist_email9现有电子邮箱地址，仅当"forward_type"为"forward"时使用
mx_host0 - mx_host2邮箱主机，仅"forward_type"为"mx"时使用
mx_distance0 - mx_distance2Distance0为最高优先级，仅当"forward_type"为"mx"时使用
enable (可选)如果您要将此设置应用于今后移动至该文件夹的域名，则可将此参数设为"yes"
sync (可选)如果您要将此设置同步于此文件夹中的所有域名，则可将此参数设为"yes"
XML结果标签
解释
<SetFolderEmailForwardingResponse></SetFolderEmailForwardingResponse>响应XML文档的根节点
<SetFolderEmailForwardingHeader></SetFolderEmailForwardingHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用

设置文件夹电子邮件转发示例

Request (XML format)

https://api.dynadot.com/api3.xml?key=mykey&command=set_folder_email_forward&folder_id=0&forward_type=forward&username0=peter&[email protected]

Response (XML format)
<SetFolderEmailForwardingResponse>
  <SetFolderEmailForwardingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderEmailForwardingHeader>
</SetFolderEmailForwardingResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=mykey&command=set_folder_email_forward&folder_id=0&forward_type=forward&username0=peter&[email protected]

Response (JSON format)
{
   "SetFolderEmailForwardingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

设置清除文件夹设置命令

如果发送设置清除文件夹设置命令，则须包含下列参数：

设置清除文件夹设置请求参数
解释
folder_id您要设置的文件夹ID
service您要清除的服务，它可以是“转发”、“隐形”、“电子邮件转发”、“dns”和“名字服务器”
XML结果标签
解释
<SetClearFolderSettingResponse></SetClearFolderSettingResponse>响应XML文档的根节点
<SetClearFolderSettingHeader></SetClearFolderSettingHeaderr>响应标头
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用

设置清除文件夹设置示例

Request (XML format)

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

Response (XML format)
<SetClearFolderSettingResponse>
  <SetClearFolderSettingHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetClearFolderSettingHeader>
</SetClearFolderSettingResponse>
Request (JSON format)

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

Response (JSON format)
{
   "SetClearFolderSettingResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

设置文件夹名称命令

如果发送设置文件夹名称命令，则须包含下列参数：

设置文件夹名称请求参数
解释
folder_id您要设置文件夹的ID
folder_name新文件夹名称
XML结果标签
解释
<SetFolderNameResponse></SetFolderNameResponse>响应XML文档的根节点
<SetFolderNameHeader></SetFolderNameHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用

设置文件夹名称示例

Request (XML format)

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

Response (XML format)
<SetFolderNameResponse>
  <SetFolderNameHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderNameHeader>
</SetFolderNameResponse>
Request (JSON format)

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

Response (JSON format)
{
   "SetFolderNameResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

设置文件夹续费选项命令

如果发送设置文件夹续费选项命令，则须包含下列参数：

设置文件夹续费选项请求参数
解释
folder_id您要设置的文件夹ID，每个请求可设置1个文件夹
renew_optionThe renew option you want to set to the folder; it can be "donot", "auto" or "reset"
enable (可选)如果您要将此续费设置应用于今后您移动至此文件夹的域名，则可将此参数设为"yes"
sync (可选)如果您要将此续费设置同步于该文件夹中的所有域名，则可将此参数设为"yes"
XML结果标签
解释
<Response></Response>响应XML文档的根节点
<ResponseHeader></ResponseHeader>响应标头
<ResponseCode></ResponseCode>响应码，"0"为成功，"-1"为失败
<Error></Error>错误信息，仅当响应码为"-1"时使用

设置文件夹续费选项示例

Request (XML format)

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

Response (XML format)
<SetFolderRenewOptionResponse>
  <SetFolderRenewOptionHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </SetFolderRenewOptionHeader>
</SetFolderRenewOptionResponse>
Request (JSON format)

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

Response (JSON format)
{
   "SetFolderRenewOptionResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

文件夹列表命令

This command is only available in XML and JSON format:

文件夹列表请求参数
解释
N/A无需额外参数
<FolderListResponse></FolderListResponse>响应XML文档的根节点
<FolderListHeader></FolderListHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用
<FolderListContent></FolderListContent>响应内容
<FolderList></FolderList>文件夹列表
<List></List>
<Folder></Folder>
<FolderId></FolderId>文件夹ID
<FolderName></FolderName>文件夹名称
<DefaultWhois></DefaultWhois>默认Whois
<DefaultWhoisEnableStatus></DefaultWhoisEnableStatus>默认Whois启用状态
<DefaultRegistrant></DefaultRegistrant>默认注册人
<ContactId></ContactId>联络人ID
<DefaultAdmin></DefaultAdmin>默认管理员
<DefaultTechnical></DefaultTechnical>默认技术信息
<DefaultBilling></DefaultBilling>默认账单信息
<DefaultNameServerEnableStatus></DefaultNameServerEnableStatus>默认域名服务器启用状态
<NameServerSettings></NameServerSettings>域名服务器设置
<Type></Type>域名服务器类型
<WithAds></WithAds>是否带有广告
<DefaultRenewOption></DefaultRenewOption>默认续费选项
<DefaultRenewOptionEnableStatus></DefaultRenewOptionEnableStatus>默认续费启用状态
<RenewOption></RenewOption>续费选项
<DefaultTransferLock></DefaultTransferLock>默认转移锁定
<DefaultTransferLockEnableStatus></DefaultTransferLockEnableStatus>默认转移锁定启用状态
<LockStatus></LockStatus>锁定状态

文件夹列表示例

Request (XML format)

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

Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<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>
Request (JSON format)

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

Response (JSON format)
{
  "FolderListResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "FolderList": [
      {
        "FolderId": "0",
        "FolderName": "new",
        "DefaultWhois": {
          "DefaultWhoisEnableStatus": "disable",
          "DefaultRegistrant": {
            "ContactId": "0"
          },
          "DefaultAdmin": {
            "ContactId": "0"
          },
          "DefaultTechnical": {
            "ContactId": "0"
          },
          "DefaultBilling": {
            "ContactId": "0"
          }
        },
        "DefaultNameServers": {
          "DefaultTransferLockEnableStatus": "disable",
          "NameServerSettings": {
            "Type": "Dynadot Parking",
            "WithAds": "Yes"
          }
        },
        "DefaultRenewOption": {
          "DefaultRenewOptionEnableStatus": "disable",
          "RenewOption": "no renew option"
        },
        "DefaultTransferLock": {
          "DefaultTransferLockEnableStatus": "disable",
          "LockStatus": "locked"
        }
      }
    ]
  }
}
 

添加域名抢购请求命令

如添加域名抢购请求命令，则须包括下列参数:

添加域名抢购请求请求参数
解释
domain若Dynadot成功接取，您愿意添加并付款的一个或多个域名，每条请求可添加100个域名，请用逗号隔开
XML结果标签
解释
<AddBackorderRequestResponse></AddBackorderRequestResponse>响应XML文档的根节点
<AddBackorderRequestHeader></AddBackorderRequestHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用

添加域名抢购请求示例

Request (XML format)

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

Response (XML format)
<AddBackorderRequestResponse>
  <AddBackorderRequestHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </AddBackorderRequestHeader>
</AddBackorderRequestResponse>
Request (JSON format)

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

Response (JSON format)
{
   "AddBackorderRequestResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

删除域名抢购请求命令

如设置删除域名抢购请求命令，则需包含下列参数：

删除域名抢购请求请求参数
解释
domain您要从过期域名抢注请求清单中移除的（一个或多个域名），每个请求可移除100个域名，域名之间应使用逗号隔开
XML结果标签
解释
<DeleteBackorderRequestResponse></DeleteBackorderRequestResponse>响应XML文档的根节点
<DeleteBackorderRequestHeader></DeleteBackorderRequestHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用

删除域名抢购请求示例

Request (XML format)

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

Response (XML format)
<DeleteBackorderRequestResponse>
  <DeleteBackorderRequestHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </DeleteBackorderRequestHeader>
</DeleteBackorderRequestResponse>
Request (JSON format)

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

Response (JSON format)
{
   "DeleteBackorderRequestResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

域名抢购请求列表命令

呼叫域名过期抢注请求清单命令将返回一个指定账户域名过期抢注请求清单；如果呼叫该命令，则需包含以下参数：

域名抢购请求列表请求参数
解释
startDate您要请求拍卖的过期抢注起始日期，如yyyy-mm-dd，如2015-05-05
endDate您要请求拍卖的过期抢注截止日期，yyyy-mm-dd，如2015-05-05
XML结果标签
解释
<BackorderRequestListResponse></BackorderRequestListResponse>响应XML文档的根节点
<BackorderRequestListHeader></BackorderRequestListHeader>响应标头
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用
<BackorderRequestListContent></BackorderRequestListContent>响应内容
<BackorderRequestList></BackorderRequestList>域名抢购请求列表
<BackorderRequest></BackorderRequest>域名抢购请求
<Domain></Domain>您列表上的域名
<CutoffTime></CutoffTime>以Unix时间计的删除请求交割日期（毫秒，自UTC1970年1月1日午夜起）
<BackorderRequestStatus></BackorderRequestStatus>过期抢购进程状态

域名抢购请求列表示例

Request (XML format)

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

Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<BackorderRequestListResponse>
  <BackorderRequestListHeader>
    <SuccessCode>0</SuccessCode>
    <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 (CSV format)
ok,success,Domain,CutoffTime,BackorderRequestStatus,testdrop.com,1403914140000,Active,testdrop3.com,1403914140000,Active,testdrop4.com,1403914140000,Active,testdrop5.com,1403914140000,Active
Request (JSON format)

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

Response (JSON format)
{
  "BackorderRequestListResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "BackorderRequestList": [
      {
        "DomainName": "testdrop.com",
        "CutoffTime": "1403914140000",
        "BackorderRequestStatus": "Active"
      },
      {
        "DomainName": "testdrop3.com",
        "CutoffTime": "1403914140000",
        "BackorderRequestStatus": "Active"
      },
      {
        "DomainName": "testdrop4.com",
        "CutoffTime": "1403914140000",
        "BackorderRequestStatus": "Active"
      },
      {
        "DomainName": "testdrop5.com",
        "CutoffTime": "1403914140000",
        "BackorderRequestStatus": "Active"
      }
    ]
  }
}
 

获取公开拍卖命令

呼叫获取公开拍卖命令将返回一个正在处理中的拍卖的清单；如果呼叫此命令，则应包含以下参数：

获取公开拍卖请求参数
解释
currency (可选)返回货币结果，应为"usd", "eur", 或 "cny",，默认货币为美元
type (可选)The auction type you want to see, it should be "expired", "user", or "backorder", if you want to get more than one auction types, you can use "," to split each auction type
XML结果标签
解释
<GetOpenAuctionsResponse></GetOpenAuctionsResponse>获取公开拍卖响应标签，它是响应XML文档的根节点
<GetOpenAuctionsHeader></GetOpenAuctionsHeader>获取公开拍卖标题
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用
<GetOpenAuctionsContent></GetOpenAuctionsContent>公开拍卖内容标签，仅当状态为"success"时使用
<Auction></Auction>拍卖项目标签，仅状态为"success"时使用
<AuctionId></AuctionId>拍卖ID
<Domain></Domain>拍卖的域名
<BidPrice></BidPrice>拍卖目前竞标价格
<BidPriceCurrency></BidPriceCurrency>竞拍价格货币
<Bids></Bids>竞拍出价次数
<EndTime></EndTime>拍卖结束时间
<EndTimestamp></EndTimestamp>拍卖终止日期，以Unix时间计（毫秒，自UTC1970年一月1日午夜起）
<Revenue></Revenue>拍卖收入
<RevenueCurrency></RevenueCurrency>收入货币
<Visitors></Visitors>域名访客
<Links></Links>到达域名链接
<Age></Age>域名年龄

获取公开拍卖示例

Request (XML format)

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

Response (XML format)
<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>
请求（csv格式）

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

响应

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
.
.
.

Request (JSON format)

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

Response (JSON format)
{
    "status": "success",
    "auction_list": [
        {
            "auction_id": 11,
            "domain": "domain.com",
            "utf_name": "domain.com",
            "is_idn": false,
            "auction_type": "expired",
            "currency": "USD",
            "current_bid_price": "124.00",
            "bids": 4,
            "bidders": 2,
            "time_left": "1 day, 23 hours",
            "start_time": "2022/03/28 02:20 PST",
            "start_time_stamp": 1648459234033,
            "end_time": "2022/04/04 02:20 PST",
            "end_time_stamp": 1649064034033,
            "visitors": 223,
            "links": "-",
            "age": 0,
            "estibot_appraisal": "-"
        },
        {
            "auction_id": 12,
            "domain": "domain0.com",
            "utf_name": "domain0.com",
            "is_idn": false,
            "auction_type": "expired",
            "currency": "USD",
            "current_bid_price": "44.99",
            "bids": 1,
            "bidders": 1,
            "time_left": "2 days, 23 hours",
            "start_time": "2022/03/29 02:20 PST",
            "start_time_stamp": 1648545634049,
            "end_time": "2022/04/05 02:20 PST",
            "end_time_stamp": 1649150434049,
            "visitors": 245,
            "links": "-",
            "age": 0,
            "estibot_appraisal": "-"
        }
        ...
    ]
}
 

获取拍卖详情命令

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

获取拍卖详情请求参数
解释
domainThe domain name of auction, IDN(International Domain Name) should use punycode, such as "xn--wkccg.com". you can get more than one auctions , each domain must be split by ","
currency (可选)返回货币结果，应为"usd", "eur", 或 "cny",，默认货币为美元
XML结果标签
解释
<GetAuctionDetailsResponse></GetAuctionDetailsResponse>获取拍卖详情响应标签，它是XML文档响应的根节点
<GetAuctionDetailsHeader></GetAuctionDetailsHeader>获取过期域名竞拍详情标题
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用
<GetAuctionDetailsContent></GetAuctionDetailsContent>获取拍卖细节内容标签，仅当状态为"success"时可用
<AuctionStatusId></AuctionStatusId>Status id of auction : '0' for In Progress, '1' for Cancelled by User, '2' for Cancelled by Admin, '3' for Cancelled by Renewal, '4' for Complete, '5' for Cancelled by Transfer Away
<AuctionStatus></AuctionStatus>拍卖状态
<UserIsHighBid></UserIsHighBid>如果用户为出价最高者
<YourCurrentBid></YourCurrentBid>指定拍卖中您目前的竞拍出价；若尚未出价，则应为'-1'
<YourProxyBid></YourProxyBid>指定拍卖的代理竞拍；如果您尚未出价，应为'-1'
<AuctionId></AuctionId>拍卖ID
<Domain></Domain>拍卖的域名
<BidPrice></BidPrice>拍卖目前竞标价格
<BidPriceCurrency></BidPriceCurrency>竞拍价格货币
<Bids></Bids>竞拍出价次数
<EndTime></EndTime>拍卖结束时间
<EndTimestamp></EndTimestamp>拍卖终止日期，以Unix时间计（毫秒，自UTC1970年一月1日午夜起）
<IsPremium></IsPremium>Whether it is a premium domain
<RenewalPrice></RenewalPrice>Renewal price

获取拍卖详情示例

Request (XML format)

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

Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<GetAuctionDetailsResponse>
  <GetAuctionDetailsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </GetAuctionDetailsHeader>
  <GetAuctionDetailsContent>
    <Auction>
      <AuctionStatusId>0</AuctionStatusId>
      <AuctionStatus>1</AuctionStatus>
      <AuctionId>0</AuctionId>
      <Domain>test.biz</Domain>
      <BidPrice>46.99</BidPrice>
      <BidPriceCurrency>USD</BidPriceCurrency>
      <Bids>0</Bids>
      <EndTime>1970/01/01 00:00 UTC</EndTime>
      <EndTimestamp>0</EndTimestamp>
      <Revenue>1</Revenue>
      <RevenueCurrency>USD</RevenueCurrency>
      <Visitors>-1</Visitors>
      <Links>1</Links>
      <Age>10</Age>
      <isPremium>false</isPremium>
      <RenewalPrice>-0.1</RenewalPrice>
      <UserIsHighBid>false</UserIsHighBid>
      <YourCurrentBid>-1</YourCurrentBid>
      <YourProxyBid>-1</YourProxyBid>
    </Auction>
  </GetAuctionDetailsContent>
</GetAuctionDetailsResponse>
Request (JSON format)

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

Response (JSON format)
{
  "status": "success",
  "size": 1,
  "auction_details": [
    {
      "auction_json": {
        "auction_id": 0,
        "domain": "test.biz",
        "utf_name": "test.biz",
        "is_idn": false,
        "auction_type": "expired",
        "current_bid_price": "46.99",
        "accepted_bid_price": "46.99",
        "currency": "USD",
        "is_high_bidder": false,
        "bids": 0,
        "bidders": 0,
        "auction_status_id": 0,
        "time_left": "1",
        "start_time": "1",
        "start_time_stamp": 0,
        "end_time": "",
        "end_time_stamp": 0,
        "revenue": "1",
        "visitors": -1,
        "links": "1",
        "age": 10,
        "estibot_appraisal": "",
        "bidder_name": "",
        "bid_price": "",
        "timestamp": 0,
        "bid_status": "",
        "is_proxy_auto_bid": false,
        "auction_ended": false,
        "customer_bided": false,
        "customer_bid": "1",
        "customer_proxy_bid": "1",
        "is_premium": false,
        "renewal_price": "-0.1"
      },
      "bid_history": []
    }
  ]
}
 

竞拍出价命令

呼叫出价竞标命令将会为指定拍卖出价；若呼叫此命令，则应包含以下参数：

竞拍出价请求参数
解释
domain拍卖的域名、国际化域名应使用punycode，如"xn--wkccg.com"
bid_amount您的竞拍出价，默认货币为美元，您也可以指定货币类型
currency (可选)您竞拍的货币，应为"usd", "eur", 或 "cny",，默认货币为美元
XML结果标签
解释
<PlaceAuctionBidResponse></PlaceAuctionBidResponse>竞拍出价响应标签，它是响应XML文档的根节点
<PlaceAuctionBidHeader></PlaceAuctionBidHeader>竞拍出价标题
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用

域名例子

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 (XML format)
<PlaceAuctionBidResponse>
  <PlaceAuctionBidHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </PlaceAuctionBidHeader>
</PlaceAuctionBidResponse>
请求（csv格式）

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

响应

ok,success

Request (JSON format)

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

Response (JSON format)
{
    "status": "success",
    "auction_details": {
        "auction_json": {
            "auction_id": 12,
            "domain": "example.com",
            "utf_name": "example.com",
            "is_idn": false,
            "auction_type": "expired",
            "current_bid_price": "44.99",
            "accepted_bid_price": "45.99",
            "currency": "USD",
            "is_high_bidder": true,
            "bids": 3,
            "bidders": 2,
            "time_left": "2 days, 22 hours",
            "start_time": "2022/03/29 02:20 PST",
            "start_time_stamp": 1648545634049,
            "end_time": "2022/04/05 02:20 PST",
            "end_time_stamp": 1649150434049,
            "revenue": "$26.50",
            "visitors": 245,
            "links": "-",
            "age": 0,
            "estibot_appraisal": "-",
            "auction_ended": false,
            "customer_bided": true,
            "customer_bid": "44.99",
            "customer_proxy_bid": "$121.00"
        },
        "bid_history": [
            {
                "bidder_name": "You",
                "bid_price": "44.99",
                "currency": "USD",
                "timestamp": 1648892255084,
                "bid_status": "High Bidder",
                "is_proxy_auto_bid": false
            }
            ...        ]
    }
}
 

获取已关闭拍卖命令

调用获取已关闭竞拍命令将返回指定账户的已关闭竞拍列表。如果调用该命令，应包含以下参数：

获取已关闭拍卖请求参数
解释
startDate拍卖起始日期，yyyy-mm-dd，如2015-05-05
endDate拍卖结束日期，yyyy-mm-dd，如2015-05-05
currency (可选)您竞拍的货币，应为"usd", "eur", 或 "cny",，默认货币为美元
XML结果标签
解释
<GetClosedAuctionsResponse></GetClosedAuctionsResponse>获取已关闭拍卖响应标签，它是响应XML文档的根节点
<GetClosedAuctionsHeader></GetClosedAuctionsHeader>获取已关闭拍卖标题
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用
<GetClosedAuctionsContent></GetClosedAuctionsContent>获取已关闭拍卖内容标签，仅当状态为"success"时使用
<Auction></Auction>拍卖项目标签，仅状态为"success"时使用
<AuctionId></AuctionId>拍卖ID
<Domain></Domain>拍卖的域名
<AuctionStatusId></AuctionStatusId>拍卖状态ID，“0”为进行中，“1”为被用户关闭，“2”为被管理员关闭，“3”为因续费关闭，“4”为由于超时关闭，“5”为因迁出关闭
<AuctionStatus></AuctionStatus>拍卖状态
<BidPrice></BidPrice>拍卖目前竞标价格
<BidPriceCurrency></BidPriceCurrency>竞拍价格货币
<Bids></Bids>竞拍出价次数
<AuctionWonStatus></AuctionWonStatus>如果用户在拍卖中胜出
<YourHighBid></YourHighBid>您对该竞拍的高出价
<YourProxyBid></YourProxyBid>对此拍卖的代理竞拍出价

获取已关闭拍卖示例

Request (XML format)

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

Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<GetClosedAuctionsResponse>
  <GetClosedAuctionsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </GetClosedAuctionsHeader>
  <GetClosedAuctionsContent>
    <Auction>
      <AuctionId>2</AuctionId>
      <Domain>testdomain1.test</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>testdomain2.test</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)

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

Response (CSV format)
ok,success,AuctionId,Domain,AuctionStatusId,AuctionStatus,BidPrice,BidPriceCurrency,Bids,AuctionWonStatus,YourHighBid,YourProxyBid,2,testdomain1.test,4,Closed by Timeout,89.99,USD,1,won,89.99,1000.0,3,testdomain2.test,4,Closed by Timeout,28.99,USD,1,won,28.99,1000.0
Request (JSON format)

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

Response (JSON format)
{
  "GetClosedAuctionsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "Auctions": [
      {
        "AuctionId": "2",
        "Domain": "testdomain1.test",
        "AuctionStatusId": "4",
        "AuctionStatus": "Closed by Timeout",
        "BidPrice": "89.99",
        "BidPriceCurrency": "USD",
        "Bids": "1",
        "AuctionWonStatus": "won",
        "YourHighBid": "89.99",
        "YourProxyBid": "1000.0"
      },
      {
        "AuctionId": "3",
        "Domain": "testdomain2.test",
        "AuctionStatusId": "4",
        "AuctionStatus": "Closed by Timeout",
        "BidPrice": "28.99",
        "BidPriceCurrency": "USD",
        "Bids": "1",
        "AuctionWonStatus": "won",
        "YourHighBid": "28.99",
        "YourProxyBid": "1000.0"
      }
    ]
  }
}
 

获取开放过期域名竞拍命令(Deprecated,please use get_open_auctions command)

调用获取开放过期域名竞拍命令将返回正在进行中的过期域名竞拍列表。如果调用此命令，应包含以下参数：

获取开放过期域名竞拍请求参数
解释
currency (可选)返回货币结果，应为"usd", "eur", 或 "cny",，默认货币为美元
XML结果标签
解释
<GetOpenBackorderAuctionsResponse></GetOpenBackorderAuctionsResponse>获取开放过期域名竞拍响应标签，将作为响应XML文件的根节点
<GetOpenBackorderAuctionsHeader></GetOpenBackorderAuctionsHeader>获取开放过期域名竞拍标题
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用
<GetOpenBackorderAuctionsContent></GetOpenBackorderAuctionsContent>获取开放过期域名竞拍内容标签，只在状态为"success"时使用
<Auction></Auction>拍卖项目标签，仅状态为"success"时使用
<AuctionId></AuctionId>拍卖ID
<Domain></Domain>拍卖的域名
<BidPrice></BidPrice>拍卖目前竞标价格
<BidPriceCurrency></BidPriceCurrency>竞拍价格货币
<Bids></Bids>竞拍出价次数
<EndTime></EndTime>拍卖结束时间
<EndTimestamp></EndTimestamp>拍卖终止日期，以Unix时间计（毫秒，自UTC1970年一月1日午夜起）

获取开放过期竞拍域名例子

Request (XML format)

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

Response (XML format)
<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>
请求（csv格式）

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

响应

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
.
.
.

 

获取过期域名竞拍详情命令

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

获取拍卖详情请求参数
解释
domain过期域名竞拍中的域名，IDN（国际域名）应使用域名代码（punycode），例如“xn--wkccg.com”
currency (可选)返回货币结果，应为"usd", "eur", 或 "cny",，默认货币为美元
XML结果标签
解释
<GetBackorderAuctionDetailsResponse></GetBackorderAuctionDetailsResponse>获取拍卖详情响应标签，它是XML文档响应的根节点
<GetAuctionDetailsHeader></GetAuctionDetailsHeader>获取拍卖详情标题
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用
<GetAuctionDetailsContent></GetAuctionDetailsContent>获取拍卖细节内容标签，仅当状态为"success"时可用
<AuctionStatusId></AuctionStatusId>拍卖状态ID，“0”为进行中，“1”为被用户关闭，“2”为被管理员关闭，“3”为因续费关闭，“4”为由于超时关闭，“5”为因迁出关闭
<AuctionStatus></AuctionStatus>拍卖状态
<AuctionId></AuctionId>拍卖ID
<Domain></Domain>拍卖的域名
<BidPrice></BidPrice>拍卖目前竞标价格
<BidPriceCurrency></BidPriceCurrency>竞拍价格货币
<Bids></Bids>竞拍出价次数
<EndTime></EndTime>拍卖结束时间
<EndTimestamp></EndTimestamp>拍卖终止日期，以Unix时间计（毫秒，自UTC1970年一月1日午夜起）
<Revenue></Revenue>拍卖收入
<RevenueCurrency></RevenueCurrency>收入货币
<Visitors></Visitors>域名访客
<Links></Links>到达域名链接
<Age></Age>域名年龄
<UserIsHighBid></UserIsHighBid>如果用户为出价最高者
<YourCurrentBid></YourCurrentBid>指定拍卖中您目前的竞拍出价；若尚未出价，则应为'-1'
<YourProxyBid></YourProxyBid>指定拍卖的代理竞拍；如果您尚未出价，应为'-1'

获取过期域名详情例子

Request (XML format)

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

Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<GetBackorderAuctionDetailsResponse>
  <GetBackorderAuctionDetailsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </GetBackorderAuctionDetailsHeader>
  <GetBackorderAuctionDetailsContent>
    <AuctionStatusId>0</AuctionStatusId>
    <AuctionStatus>In Progress</AuctionStatus>
    <UserIsHighBid>no</UserIsHighBid>
    <YourCurrentBid>-1</YourCurrentBid>
    <YourProxyBid>-1</YourProxyBid>
    <Auction>
      <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>
    </Auction>
  </GetBackorderAuctionDetailsContent>
</GetBackorderAuctionDetailsResponse>
Request (JSON format)

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

Response (JSON format)
{
  "GetBackorderAuctionDetailsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "GetBackorderAuctionDetails": {
      "AuctionStatusId": "0",
      "AuctionStatus": "In Progress",
      "UserIsHighBid": "no",
      "YourCurrentBid": "-1",
      "YourProxyBid": "-1",
      "Auction": {
        "AuctionId": "10001",
        "Domain": "example.com",
        "BidPrice": "89.99",
        "BidPriceCurrency": "USD",
        "Bids": "0",
        "EndTime": "2015/04/28 18:16 UTC",
        "EndTimestamp": "1430244969779"
      }
    }
  }
}
 

过期域名竞拍出价命令

调用过期域名竞拍出价命令将对指定的过期域名竞拍进行报价。如果调用该命令，应包含以下参数：

过期域名竞拍出价请求参数
解释
domain拍卖的域名、国际化域名应使用punycode，如"xn--wkccg.com"
bid_amount您的竞拍出价，默认货币为美元，您也可以指定货币类型
currency (可选)您竞拍的货币，应为"usd", "eur", 或 "cny",，默认货币为美元
XML结果标签
解释
<PlaceBakcorderAuctionBidResponse></PlaceBakcorderAuctionBidResponse>竞拍出价响应标签，它是响应XML文档的根节点
<PlaceBackorderAuctionBidHeader></PlaceBackorderAuctionBidHeader>竞拍出价标题
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用

进行过期域名拍卖出价例子

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 (XML format)
<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 (CSV format)
ok,success
Request (JSON format)

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

Response (JSON format)
{
   "PlaceBakcorderAuctionBidResponse":{
      "ResponseCode":"0",
      "Status":"success"
   }
}
 

获取已关闭过期域名竞拍命令

调用获取已关闭过期域名命令将返回指定账户的已关闭过期域名竞拍列表。如果调用该命令，应包含以下参数：

获取已关闭的过期域名竞拍请求参数
解释
startDate拍卖起始日期，yyyy-mm-dd，如2015-05-05
endDate拍卖结束日期，yyyy-mm-dd，如2015-05-05
currency (可选)您竞拍的货币，应为"usd", "eur", 或 "cny",，默认货币为美元
XML结果标签
解释
<GetClosedBackorderAuctionsResponse></GetClosedBackorderAuctionsResponse>获取已关闭拍卖响应标签，它是响应XML文档的根节点
<GetClosedBackorderAuctionsHeader></GetClosedBackorderAuctionsHeader>获取已关闭拍卖标题
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用
<GetClosedBackorderAuctionsContent></GetClosedBackorderAuctionsContent>获取已关闭拍卖内容标签，仅当状态为"success"时使用
<Auction></Auction>拍卖项目标签，仅状态为"success"时使用
<YourHighBid></YourHighBid>您对该竞拍的高出价
<YourProxyBid></YourProxyBid>对此拍卖的代理竞拍出价
<AuctionId></AuctionId>拍卖ID
<Domain></Domain>拍卖的域名
<AuctionStatusId></AuctionStatusId>拍卖状态ID，“0”为进行中，“1”为被用户关闭，“2”为被管理员关闭，“3”为因续费关闭，“4”为由于超时关闭，“5”为因迁出关闭
<AuctionStatus></AuctionStatus>拍卖状态
<BidPrice></BidPrice>拍卖目前竞标价格
<BidPriceCurrency></BidPriceCurrency>竞拍价格货币
<Bids></Bids>竞拍出价次数

Get Closed Backorder 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 (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<GetClosedBackorderAuctionsResponse>
  <GetClosedBackorderAuctionsHeader>
    <SuccessCode>0</SuccessCode>
    <Status>success</Status>
  </GetClosedBackorderAuctionsHeader>
  <GetClosedBackorderAuctionsContent>
    <Auction>
      <AuctionWonStatus>won</AuctionWonStatus>
      <YourHighBid>89.99</YourHighBid>
      <YourProxyBid>1000.0</YourProxyBid>
      <AuctionId>2</AuctionId>
      <Domain>testdomain1.test</Domain>
      <BidPrice>89.99</BidPrice>
      <BidPriceCurrency>USD</BidPriceCurrency>
      <Bids>1</Bids>
      <EndTime>2022/04/04 02:20:34 PST</EndTime>
      <EndTimestamp>1649064034033</EndTimestamp>
    </Auction>
    <Auction>
      <AuctionWonStatus>won</AuctionWonStatus>
      <YourHighBid>28.99</YourHighBid>
      <YourProxyBid>1000.0</YourProxyBid>
      <AuctionId>3</AuctionId>
      <Domain>testdomain2.test</Domain>
      <BidPrice>28.99</BidPrice>
      <BidPriceCurrency>USD</BidPriceCurrency>
      <Bids>1</Bids>
      <EndTime>2022/04/05 02:20:34 PST</EndTime>
      <EndTimestamp>1649150434049</EndTimestamp>
    </Auction>
  </GetClosedBackorderAuctionsContent>
</GetClosedBackorderAuctionsResponse>
Request (CSV format)

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

Response (CSV format)
ok,success,AuctionId,Domain,AuctionStatusId,AuctionStatus,BidPrice,BidPriceCurrency,Bids,AuctionWonStatus,YourHighBid,YourProxyBid,2,testdomain1.test,4,Closed by Timeout,89.99,USD,1,won,89.99,1000.0,3,testdomain2.test,4,Closed by Timeout,28.99,USD,1,won,28.99,1000.0
Request (JSON format)

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

Response (JSON format)
{
  "GetClosedBackorderAuctionsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "Auctions": [
      {
        "AuctionWonStatus": "won",
        "YourHighBid": "89.99",
        "YourProxyBid": "1000.0",
        "AuctionId": "2",
        "Domain": "testdomain1.test",
        "BidPrice": "89.99",
        "BidPriceCurrency": "USD",
        "Bids": "1",
        "EndTime": "2022/04/04 02:20:34 PST",
        "EndTimestamp": "1649064034033"
      },
      {
        "AuctionWonStatus": "won",
        "YourHighBid": "28.99",
        "YourProxyBid": "1000.0",
        "AuctionId": "3",
        "Domain": "testdomain2.test",
        "BidPrice": "28.99",
        "BidPriceCurrency": "USD",
        "Bids": "1",
        "EndTime": "2022/04/05 02:20:34 PST",
        "EndTimestamp": "1649150434049"
      }
    ]
  }
}
 

获取竞拍出价（Get Auction Bids）命令

Calling the get auction bids command will get your bids list which you took part in. If calling this command, the following parameters should be included:

Get Auction Bids Request Parameter
解释
currency (可选)您竞拍的货币，应为"usd", "eur", 或 "cny",，默认货币为美元
XML结果标签
解释
<GetAuctionBidsResponse></GetAuctionBidsResponse>Tag of get auction bids response, it's the root node of the response XML document
<GetAuctionBidsHeader></GetAuctionBidsHeader>Get auction bids header
<SuccessCode></SuccessCode>如果操作成功，"0"为成功，"-1"为失败
<Status></Status>请求状态
<Error></Error>请求错误信息，仅状态为"error"时使用
<GetAuctionBidsContent></GetAuctionBidsContent>Tag of get auction bids content, it's only used when status is "success"
<BidList></BidList> Bid List
<Bid></Bid> Bid Item
<BidId></BidId> ID of bid
<AuctionId></AuctionId> ID of auction
<AccountId></AccountId>ID of account
<Domain></Domain>拍卖的域名
<DomainUtf></DomainUtf>Domain utf name of auction
<AuctionType></AuctionType>Type of auction
<IsIdn></IsIdn>If this domain is Internationalized Domain Name
<CurrentBid></CurrentBid>Current bid price for the auction
<YourStatus></YourStatus>Your bid status for the auction
<ProxyBid></ProxyBid>Your proxy bid price for the auction
<ActiveBidders></ActiveBidders>The amount of bidders who take part in this auction
<TimeLeft></TimeLeft>the left time for the auction
<EndTime></EndTime>The end time for the auction
<EndTimestamp></EndTimestamp>The end time stamp for the auction

获取竞拍出价（Get Auction Bids）示例

Request (XML format)

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

Response (XML format)
<GetAuctionBidsResponse>
    <GetAuctionBidsHeader>
        <SuccessCode>0</SuccessCode>
        <Status>success</Status>
    </GetAuctionBidsHeader>
    <GetAuctionBidsContent>
        <BidList>
            <Bid>
                <BidId>0</BidId>
                <AuctionId>11</AuctionId>
                <AccountId>1</AccountId>
                <Domain>domain.com</Domain>
                <DomainUtf>domain.com</DomainUtf>
                <AuctionType>expired</AuctionType>
                <IsIdn>false</IsIdn>
                <CurrentBid>$124.00</CurrentBid>
                <YourStatus>Out Bid</YourStatus>
                <ProxyBid>$119.00</ProxyBid>
                <ActiveBidders>2</ActiveBidders>
                <TimeLeft>1 day, 6 hours</TimeLeft>
                <EndTime>2022/04/04 02:20:34 PST</EndTime>
                <EndTimestamp>1649064034033</EndTimestamp>
            </Bid>
            <Bid>
                <BidId>9</BidId>
                <AuctionId>12</AuctionId>
                <AccountId>1</AccountId>
                <Domain>domain0.com</Domain>
                <DomainUtf>domain0.com</DomainUtf>
                <AuctionType>expired</AuctionType>
                <IsIdn>false</IsIdn>
                <CurrentBid>$44.99</CurrentBid>
                <YourStatus>High Bidder</YourStatus>
                <ProxyBid>$121.00</ProxyBid>
                <ActiveBidders>1</ActiveBidders>
                <TimeLeft>2 days, 6 hours</TimeLeft>
                <EndTime>2022/04/05 02:20:34 PST</EndTime>
                <EndTimestamp>1649150434049</EndTimestamp>
            </Bid>
        </BidList>
    </GetAuctionBidsContent>
</GetAuctionBidsResponse>
Request (JSON format)

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

Response (JSON format)
{
    "status": "success",
    "auction_bids": [
        {
            "bid_id": 0,
            "auction_id": 11,
            "account_id": "1",
            "domain": "domain.com",
            "domain_utf": "domain.com",
            "auction_type": "expired",
            "is_idn": false,
            "current_bid": "$44.99",
            "your_status": "High Bidder",
            "proxy_bid": "$119.00",
            "active_bidders": 1,
            "time_left": "1 day, 23 hours",
            "end_time": "2022/04/04 02:20:34 PST",
            "end_time_stamp": 1649064034033
        },
        {
            "bid_id": 2,
            "auction_id": 12,
            "account_id": "1",
            "domain": "domain0.com",
            "domain_utf": "domain0.com",
            "auction_type": "expired",
            "is_idn": false,
            "current_bid": "$44.99",
            "your_status": "High Bidder",
            "proxy_bid": "$119.00",
            "active_bidders": 1,
            "time_left": "2 days, 23 hours",
            "end_time": "2022/04/05 02:20:34 PST",
            "end_time_stamp": 1649150434049
        }
        ...
    ]
}
 

Is Processing命令

呼叫is_processing可让您知晓提交一个新请求是否安全

Is_Processing请求参数
解释
不需额外参数
XML结果标签
解释
<Response></Response>is_processing响应标签
<RespnseHeader></RespnseHeader>is_processing标题标签
<ResponseMsg></ResponseMsg>is_processing响应信息标签，标签应显示为“yes”（系统中有正在处理的请求，您不应发送另一个请求）或“no”（您的账户中已没有处理中的请求，可以安全地提交新请求）

Is_Processing示例

Request (XML format)

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

Response (XML format)
<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 (CSV format)
ok,yes
Request (JSON format)

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

Response (JSON format)
{
   "Response":{
      "ResponseCode":"0",
      "ResponseMsg":"no"
   }
}
 

Get Expired Closeout Domains Command

Calling the Get Expired Closeout Domains Command will Get Expired Closeout Domains. This command is only available in XML and JSON format. If calling this command, the following parameters should be included:

Get Expired Closeout Domains Request Parameter
解释
currency(optional)The currency of return result, it should be "usd", "eur", or "cny", default currency is US Dollars
domain(optional)Add this parameter if you want to query for a closeout domain
XML结果标签
解释
<GetExpiredCloseoutDomainsResponse></GetExpiredCloseoutDomainsResponse>Tag of Get Expired Closeout Domains response, it's the root node of the response XML document
<GetExpiredCloseoutDomainsHeader></GetExpiredCloseoutDomainsHeader>Get Expired Closeout Domains Header
<ResponseCode></ResponseCode>If the operation is successful, "0" for success, "-1" for failure
<Status></Status>请求状态
<Error></Error>Error information about the request, only used when status is "error"
<GetExpiredCloseoutDomainsContent></GetExpiredCloseoutDomainsContent>Tag of content, it's only used when status is "success"
<CloseoutItem></CloseoutItem>CloseoutItem
<DomainName></DomainName>The domain name
<DomainNameUtf></DomainNameUtf>The domain name is in utf format
<CurrentPrice></CurrentPrice>current price
<isIdn></isIdn>Whether it is the idn domain name
<EndTimeStamp></EndTimeStamp>End date of auction in Unix time (milliseconds since midnight UTC of January 1, 1970)
<RenewalPrice></RenewalPrice>Renewal price
<ExpiredRevenue></ExpiredRevenue>Revenue of closeout
<EstibotAppraisal></EstibotAppraisal>EstibotAppraisal
<InboundLinks></InboundLinks>到达域名链接
<MonthlyVisitors></MonthlyVisitors>域名访客
<Currency></Currency>currency

Get Expired Closeout Domains Example

Request (XML format)

https://api.dynadot.com/api3.xml?key=MY_API_KEY&command=get_expired_closeout_domains¤cy=usd

Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<GetExpiredCloseoutDomainsResponse>
  <GetExpiredCloseoutDomainsHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </GetExpiredCloseoutDomainsHeader>
  <GetExpiredCloseoutDomainsContent>
    <CloseoutItem>
      <DomainName>test.biz</DomainName>
      <DomainNameUtf>test.biz</DomainNameUtf>
      <CurrentPrice>9.91</CurrentPrice>
      <IsIDN>false</IsIDN>
      <EndTimeStamp>0</EndTimeStamp>
      <RenewalPrice>9.99</RenewalPrice>
      <ExpiredRevenue>9.90</ExpiredRevenue>
      <EstibotAppraisal>1223</EstibotAppraisal>
      <InboundLinks>-1</InboundLinks>
      <MonthlyVisitors>-1</MonthlyVisitors>
      <Currency>usd</Currency>
    </CloseoutItem>
  </GetExpiredCloseoutDomainsContent>
</GetExpiredCloseoutDomainsResponse>
Request (JSON format)

https://api.dynadot.com/api3.json?key=MY_API_KEY&command=get_expired_closeout_domains¤cy=usd

Response (JSON format)
{
  "GetExpiredCloseoutDomainsResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "Size": 1,
    "CloseoutDomains": [
      {
        "closeoutItem": {
          "domainName": "test.biz",
          "domainNameUtf": "test.biz",
          "currentPrice": "9.91",
          "isIdn": false,
          "endTimeStamp": 0,
          "renewalPrice": "9.99",
          "expiredRevenue": "9.90",
          "estibotAppraisal": "1223",
          "inboundLinks": -1,
          "monthlyVisitors": -1,
          "currency": "usd"
        }
      }
    ]
  }
}
 

Buy Expired Closeout Domain Command

Calling the Buy Expired Closeout Domain Command will buy the specified domain name. This command is only available in XML and JSON format. If calling this command, the following parameters should be included:

Buy Expired Closeout Domain Request Parameter
解释
domainThe domain you want to buy, only 1 domain can be entered per request
currency(optional)The currency of return result, it should be "usd", "eur", or "cny", default currency is US Dollars
XML结果标签
解释
<BuyExpiredCloseoutDomainResponse></BuyExpiredCloseoutDomainResponse>Tag of Buy Expired Closeout Domain response, it's the root node of the response XML document
<BuyExpiredCloseoutDomainHeader></BuyExpiredCloseoutDomainHeader>Buy Expired Closeout Domain header
<ResponseCode></ResponseCode>If the operation is successful, "0" for success, "-1" for failure
<Status></Status>请求状态
<Error></Error>Error information about the request, only used when status is "error"

Buy Expired Closeout Domain Example

Request (XML format)

http://127.0.0.1:8889/api3.xml?key=0&command=buy_expired_closeout_domain¤cy=USD&domain=domain-exp141.org.ph

Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<BuyExpiredCloseoutDomainResponse>
  <BuyExpiredCloseoutDomainHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </BuyExpiredCloseoutDomainHeader>
</BuyExpiredCloseoutDomainResponse>
Request (JSON format)

http://127.0.0.1:8889/api3.json?key=0&command=buy_expired_closeout_domain¤cy=USD&domain=domain-exp141.org.ph

Response (JSON format)
{
  "BuyExpiredCloseoutDomainResponse": {
    "ResponseCode": "0",
    "Status": "success"
  }
}
 

Get Order Status Command

Calling the Get Order Status Command will get order status. This command is only available in XML and JSON format. If calling this command, the following parameters should be included:

Get Order Status Request Parameter
解释
order_idThe id of the order to be queried
XML结果标签
解释
<GetOrderStatusResponse></GetOrderStatusResponse>the root node of the response
<GetOrderStatusHeader></GetOrderStatusHeader>Get Order Status header
<ResponseCode></ResponseCode>If the operation is successful, "0" for success, "-1" for failure
<Status></Status>请求状态
<Error></Error>Error information about the request, only used when status is "error"
<GetOrderStatusContent></GetOrderStatusContent>response content
<OrderId></OrderId>order id
<OrderStatus></OrderStatus>order status( Shopping, Submitted, Waitpay, Processing, Completed, Problem, Deleted, Cancelled )
<ItemTypeName></ItemTypeName>item Type
<ItemName></ItemName>item Name
<ItemStatus></ItemStatus>Item Status(Completed, Cancelled, Problem)

Get Order Status Example

Request (XML format)

http://127.0.0.1:8889/api3.xml?key=0&command=get_ordedr_status&order_id=0

Response (XML format)
<?xml version="1.0" encoding="UTF-8"?>
<GetOrderStatusResponse>
  <GetOrderStatusHeader>
    <ResponseCode>0</ResponseCode>
    <Status>success</Status>
  </GetOrderStatusHeader>
  <GetOrderStatusContent>
    <OrderId>0</OrderId>
    <OrderStatus>Completed</OrderStatus>
    <Item>
      <ItemTypeName>domain transfer away</ItemTypeName>
      <ItemName>&amp;</ItemName>
      <ItemStatus>transfer.com</ItemStatus>
    </Item>
    <Item>
      <ItemTypeName>domain</ItemTypeName>
      <ItemName>&amp;</ItemName>
      <ItemStatus>register.com</ItemStatus>
    </Item>
  </GetOrderStatusContent>
</GetOrderStatusResponse>
Request (JSON format)

http://127.0.0.1:8889/api3.json?key=0&command=get_ordedr_status&order_id=0

Response (JSON format)
{
  "GetOrderStatusResponse": {
    "ResponseCode": 0,
    "Status": "success",
    "OrderStatus": {
      "OrderId": 0,
      "OrderStatus": "Completed",
      "ItemList": [
        {
          "ItemTypeName": "domain transfer away",
          "ItemName": "transfer.com",
          "ItemStatus": "Completed"
        },
        {
          "ItemTypeName": "domain",
          "ItemName": "register.com",
          "ItemStatus": "Completed"
        }
      ]
    }
  }
}
Are you sure you want to close the chat?Chat will be closed and the chat history will be cleared.
Sorry, can't receive informationPlease move your mouse to the dialog
Chat Online
在线聊天0
Dynadot
域名
资源
网站
关注
顶级域名
国家域名

版权所有 © 2002-2023 Dynadot Inc. 保留一切权利