域名 API - API 命令列表

开始使用我们的 RESTful API

Dynadot API 旨在与您的系统无缝集成。我们的 API 具有可预测的面向资源的 URL，支持 JSON 编码的请求体，返回 JSON 编码和 XML 编码的响应，并遵循标准的 HTTP 方法、认证和响应代码。您可以在测试模式和实时模式下使用Dynadot API。所使用的模式由用于认证您请求的API密钥决定。测试模式允许您模拟并验证您的API集成，而不影响实时数据或交易。Dynadot API 主要专注于域名管理、订单处理和相关服务。您可以执行注册、转移和续订域名、管理 DNS 设置以及查看或更新账户订单等操作。请注意：不支持批量创建、更新、删除操作，每种请求类型限制为一个对象或操作。

生成您的 API 密钥在您开始发出任何 API 请求之前，生成您的 API 密钥和 API 密码是必要的。这些密钥是进行身份验证以及在与我们的 API 交互时确保您操作安全所必需的。您可以在账户设置中的 API 部分生成 API 密钥和 API 密码。1. 在 Dynadot 登录您的账户。2. 导航至工具 > API。3. 从这个页面生成您的API 密钥和API 密码。

加入我们的社区有任何想法或建议吗？直接与我们的专业工程师交流。Discord

HTTP 方法API 使用标准的 HTTP 方法来对资源进行操作：

Method	Description
GET	GET Request: Retrieve detailed information about a specified resource
POST	POST Request: Create a new resource
PUT	PUT Request: Fully update the specified resource
DELETE	DELETE Request: Remove the specified resource

URL

所有 API 请求的基础 URL 是：https://api.dynadot.com/

完整的URL格式：http://api.dynadot.com/restful/version_code/resource/{resource_identify}/action

https://api.dynadot.com/restful/v1/domains/{domain_name}/search

版本

当前的 API 版本是v

在构建 API 请求 URL 时，只需包含主版本号即可。次要版本和补丁更新旨在保持向后兼容，不会引入破坏现有代码的更改。这确保了稳定性，同时允许您在不需要修改实现的情况下，从增量改进和修复中获益。当未来版本发布时，我们将在一段时间内保持对旧版本的向后兼容性。新功能和重大更改将在主要版本增量中引入。

HeaderAPI 请求的头部包含了关于请求的元数据。这些元数据为服务器正确处理请求提供了必要的上下文。常用的头部包括：

Content-Type指定请求体中发送数据的格式。服务器使用此信息来正确解析请求。目前唯一接受的值是：application/json。

Content-Type: application/json

接受通知服务器客户端期望的响应格式。可能的值包括：application/json、application/xml

Accept: application/json

授权所有 API 请求都必须包含一个 API 密钥以进行身份验证。您可以从您的账户仪表板获取您的 API 密钥。You can generate an API key in API setting page

Authorization: Bearer YOUR_API_KEY

X-Request-IDX-Request-ID 头是一个可选的头部，用于唯一标识每个 API 请求。包含此头部时，可以帮助跟踪和关联系统及日志中的请求，从而便于调试和监控 API 活动。X-Request-ID 的值必须是有效的UUID（通用唯一识别码），遵循标准格式：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx（例如，123e4567-e89b-12d3-a456-426614174000）。

X-Request-ID: 550e8400-e29b-41d4-a716-446655440000

X-签名X-Signature 头是处理交易请求时必需的安全机制，包括那些检索敏感信息或更新数据的请求。它通过要求客户端使用 HMAC-SHA256 对请求负载进行签名，确保 API 请求的真实性、完整性和不可否认性。

要生成签名，您需要以下值1. API 密钥：您的独特 API 密钥。2. 完整路径和查询参数：API端点的完整路径以及查询参数。3. X-Request-Id：请求 ID。如果不可用，您可以输入空字符串。4. 请求正文：请求的正文部分。如果此部分为空或为 null，您可以输入空字符串。

待签名的字符串是上述值的组合，按以下顺序连接：

apiKey + "\n" + fullPathAndQuery + "\n" + (xRequestId or empty String) + "\n" + (requestBody or empty String)

apiKey = "your_api_key"
fullPathAndQuery = "/v1/some/endpoint?param=value"
xRequestId = "unique-request-id"
requestBody = "{\"key\":\"value\"}"


stringToSign = "your_api_key\n/v1/some/endpoint?param=value\nunique-request-id\n{\"key\":\"value\"}"

生成 HMAC-SHA256 签名在构建签名字符串后，您需要使用您的密钥应用HMAC-SHA256加密。这个过程将生成签名。签名的生成遵循以下步骤：1. 使用 HMAC-SHA256 算法。2. 使用 stringToSign 作为输入消息。3. 使用密钥作为密钥。
将生成的签名用作请求头中X-Signature的值。

X-Signature: {HMAC-SHA256 Signature}

BodyAPI 请求的正文用于向服务器发送数据。它通常包含在 POST、PUT 或 PATCH 请求中（通常不用于 GET 或 DELETE 请求）。

Sure, please provide the specific text you need translated into Chinese Simplified.正文数据的格式由“Content-Type”头部决定。一些常见的格式包括：

{

domainName: "domain.com",
showPrice: "yes",
currency: "USD"

}

典型使用场景POST 请求：POST 方法用于在服务器上创建新资源。请求体通常包含资源的详细信息。PUT 请求：PUT 方法用于通过完全替换来更新现有资源。请求体包含完整的更新资源。GET 请求：DELETE 方法用于从服务器中删除已存在的资源。它不包含请求体。DELETE 请求：GET 方法用于从服务器检索现有资源。它不包含请求体。

Response Format所有 API 响应均以 JSON 或 XML 格式返回，响应体数据的格式由 Accept 头部确定，提供请求的数据或错误信息（如果适用）。

Sure, please provide the specific text you need translated into Chinese Simplified.一般来说，响应包含三个部分：代码、消息、数据。

代码：请求的状态消息：关于状态的更多描述数据：响应的主体内容

{

Code: "200",
Message: "Success",
Data: {}

}

错误处理HTTP状态代码是服务器返回的标准化三位数字，用以指示客户端请求的处理结果。它们提供了关于请求是否成功处理、是否需要进一步操作或是否遇到错误的重要信息。这些代码分为五个类别，每个类别代表一种不同类型的响应。我们的 API 状态代码遵循 HTTP/1.1 协议，这是一个广泛接受的标准，确保了一致且可靠的通信。通过使用 HTTP/1.1，我们利用了如持久连接和增强缓存等功能，以优化客户端与服务器之间的交互。

2xx（成功）：表示命令已接收并被接受。

200状态代码表明请求已成功。

201状态代码表明请求已被满足，并且已创建了一个或多个新资源。

202状态代码表明请求已被接受处理，但处理尚未完成。

249用户在规定时间内发送了过多的请求

4xx（客户端错误）：表示客户端在请求中出现错误，例如提供了无效的输入或缺乏适当的授权。

400状态码表明，由于某些被认为是客户端错误的原因，服务器无法或不会处理该请求。

401状态代码表明，由于缺乏针对目标资源的有效认证凭证，请求未被执行。

402状态代码表明由于支付问题，请求未能执行。

403状态代码表明服务器已理解请求，但拒绝执行。

404状态码表明源服务器没有找到目标资源的当前表示，或者不愿意透露该资源存在。

409由于与资源的当前状态存在冲突，无法完成该请求。

5xx（服务器错误）：表示服务器遇到错误或无法完成请求。

500状态代码表明服务器遇到了一个意外情况，导致它无法完成请求。

501状态代码表明服务器不支持完成请求所需的功能。

502状态代码表明，服务器在充当网关或代理时，从其尝试满足请求时访问的入站服务器收到了无效响应。

503状态代码表明，由于暂时性过载或计划中的维护，服务器目前无法处理请求。这种情况在延迟一段时间后可能会得到缓解。

504状态码表明，服务器在充当网关或代理时，未能及时从其需要访问的上游服务器那里获得响应，以完成请求。

: 代码状态名称

200成功

201创建

202接受了

249请求过多

400错误的请求

401未经授权

402需要付款

403禁止访问

404未找到

409冲突

500内部服务器错误

501未实现

502错误的网关

503服务不可用

504网关超时

速率限制请求应通过 https（安全套接字）发送以确保安全。一次只能处理一个请求，因此请等待当前请求完成后再发送另一个请求。

您的账户价格等级不同，将获得不同的线程数：

Price level	Account
Regular	1 thread
Bulk	5 threads
Super Bulk	25 threads

<Response>
  <status>
    <code>429</code>
    <message>Too Many Requests</message>
  </status>
  <error>
    <description>You have reached the maximum allowed requests within the concurrent limit of your account. Please try again later.</description>
  </error>
</Response>

{

code: 429,
message: "Too Many Requests",
error: {
- description: "You have reached the maximum allowed requests within the concurrent limit of your account. Please try again later."
1 item}

}

更改日志概览

更新日志是记录 API 每个版本中变更、改进、修复错误和新功能的详细记录。它通过记录每次更新的影响，为用户和开发者提供透明度。它主要包括两个关键部分：

API 版本本部分介绍了API的版本控制系统，该系统帮助开发者跟踪功能的演变并确保兼容性。每个API版本都有一个独特的版本号（例如，v1.0.1、v2.2.3），代表了一个重要的里程碑或发布。版本控制使用户能够在准备好时选择更新，从而最小化集成的中断。

更改日志历史更改日志历史提供了每个版本中更新、修复错误、弃用和增强功能的详细信息。它详细描述了对端点、参数、认证机制或响应格式所做的具体更改。此部分确保开发者完全了解发生了哪些变化，并可以相应地调整他们的实现。通过维护一个清晰、详细的更改日志，我们旨在为开发者提供管理集成的工具和信息，使他们能够有效且自信地进行管理。

API 版本

我们的 API 目前处于版本v

版本代码用于系统地识别和管理 API 更新。它们遵循语义版本控制（SemVer）格式：

版本代码的每个组成部分都有其特定的目的，并帮助开发者有效地传达更改的范围和类型。

主要版本定义：代表可能破坏向后兼容性的重大变化。Certainly! Please provide the text you need translated into Chinese Simplified.<Major>.x.x

示例:v1.0.0->v2.0.0完全的 API 重新设计或不兼容的架构更改。

次要版本定义：表示向后兼容的功能添加。Certainly! Please provide the text you need translated into Chinese Simplified.x.<Minor>.x

示例:v1.0.0->v1.1.0添加新的端点或方法，同时保持向后兼容性。

补丁版本定义：指向后兼容的错误修复或小幅改进。Certainly! Please provide the text you need translated into Chinese Simplified.x.x.<Patch>

示例:v1.0.0->v1.1.0修复 API 端点中的一个小错误。

API 更新日志

更新日志是一份详细记录，涵盖了软件或API每个版本中的变更、改进、错误修复和新功能。通过记录每次更新的影响，它为用户和开发者提供了透明度。

更改日志中的典型条目包括：描述：简要说明所做的更改内容。受影响的组件：变更影响的特定模块、端点或功能。

示例：新增支持此新 API 命令<域名注册>

更改日志历史跟踪 Dynadot API 的每一次更改。

SEARCH Command

Support multi-thread

Support API Sandbox

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

Request Parameters Expand All

show_price boolean Optional

If you would like to display price for available search result.
currency Enum Optional

The currency of the price result.
Supported valuesUSD, GBP, EUR, INR, PLN, ZAR, LTL, CNY, CAD, JPY, NZD, RUB, AUD, MXN, BRL, IDR, ARS, COP, DKK, RSD, HKD, CHF, AED, MYR, NGN, KES, CZK

Result Parameters Expand All

domain_name String

The domain name.
is_available boolean

Is the domain available.
is_premium Enum

Is the domain premium.
Supported valuesYES, NO, UNKNOWN
is_show_price boolean

Is the domain require price.
currency String

The currency of the price result.
registration_price Array

The price of registration.
renewal_price Array

The price of renewal.
transfer_price String

The price of transfer.
restore_price String

The price of restore.

Api Request and Header

GET https://api.dynadot.com/restful/v1/domains/{domain_name}/search

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

Response

{

code: "Integer",
message: "String",
data: {
- domain_name: "String",
- available: "String",
- premium: "String",
- price_list: [
  1. {
    - currency: "String",
    - unit: "String",
    - transfer: "String",
    - restore: "String"
    }
  ]
}

}

BULK_SEARCH Command

Support multi-thread

Support API Sandbox

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

Request Parameters Expand All

domain_name_list List

The domain names you are searching for,.

Result Parameters Expand All

currency String

The currency.
show_price boolean

Is Show Price.
result_list ArrayList
The Domain Search Result List.
Show Properties
- domain_name String
  
  The domain name.
- is_available boolean
  
  Is the domain available.
- is_premium Enum
  
  Is the domain premium.
  Supported valuesYES, NO, UNKNOWN
- is_show_price boolean
  
  Is the domain require price.
- currency String
  
  The currency of the price result.
- registration_price Array
  
  The price of registration.
- renewal_price Array
  
  The price of renewal.
- transfer_price String
  
  The price of transfer.
- restore_price String
  
  The price of restore.

Api Request and Header

GET https://api.dynadot.com/restful/v1/domains/bulk_search

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

Response

{

code: "Integer",
message: "String",
data: {
- domain_result_list: [
  1. {
    - domain_name: "String",
    - available: "String"
    }
  ]
}

}

SUGGESTION_SEARCH Command

Support multi-thread

Support API Sandbox

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

Request Parameters Expand All

domain_name String

your domain name.
tlds String

comma separated list of tlds.
max_count Integer Optional

max number of suggestions.

Result Parameters Expand All

domain_list List

List of domain suggestions.

Api Request and Header

GET https://api.dynadot.com/restful/v1/domains/{domain_name}/suggestion_search

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

Response

{

code: "Integer",
message: "String",
data: {
- domain_list: [
  1. "String"
  ]
}

}

REGISTER Command

Support multi-thread

Support API Sandbox

Require X-Signature

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

Request Parameters Expand All

domain Object
The domain name.
Show Properties
- duration int
  
  The duration of domain.
- auth_code String Optional
  
  The authCode of domain, used only for transfer in action.
- registrant_contact_id int Optional
  
  The registrant contact id.
- admin_contact_id int Optional
  
  The admin contact id.
- tech_contact_id int Optional
  
  The tech contact id.
- billing_contact_id int Optional
  
  The billing contact id.
- registrant_contact Object Optional
  The registrant contact.
  
  Show Properties
  
  organization String Optional
  
  The organization.
  
  name String
  
  The name of contact owner.
  
  email String
  
  The email address.
  
  phone_number String
  
  The phone number.
  
  phone_cc String
  
  The phone country code.
  
  fax_number String Optional
  
  The fax number.
  
  fax_cc String Optional
  
  The fax country code.
  
  address1 String
  
  The address1.
  
  address2 String Optional
  
  The address2.
  
  city String
  
  The city.
  
  state String Optional
  
  The state.
  
  zip String
  
  The zip.
  
  country String
  
  The country.
  
  contact_extension Object Optional
  
  The contactExtension.
  
  Show Properties
  
  tld String
  
  The TLD of this contact extension.
- admin_contact Object Optional
  The admin contact.
  
  Show Properties
  
  organization String Optional
  
  The organization.
  
  name String
  
  The name of contact owner.
  
  email String
  
  The email address.
  
  phone_number String
  
  The phone number.
  
  phone_cc String
  
  The phone country code.
  
  fax_number String Optional
  
  The fax number.
  
  fax_cc String Optional
  
  The fax country code.
  
  address1 String
  
  The address1.
  
  address2 String Optional
  
  The address2.
  
  city String
  
  The city.
  
  state String Optional
  
  The state.
  
  zip String
  
  The zip.
  
  country String
  
  The country.
  
  contact_extension Object Optional
  
  The contactExtension.
  
  Show Properties
  
  tld String
  
  The TLD of this contact extension.
- tech_contact Object Optional
  The tech contact.
  
  Show Properties
  
  organization String Optional
  
  The organization.
  
  name String
  
  The name of contact owner.
  
  email String
  
  The email address.
  
  phone_number String
  
  The phone number.
  
  phone_cc String
  
  The phone country code.
  
  fax_number String Optional
  
  The fax number.
  
  fax_cc String Optional
  
  The fax country code.
  
  address1 String
  
  The address1.
  
  address2 String Optional
  
  The address2.
  
  city String
  
  The city.
  
  state String Optional
  
  The state.
  
  zip String
  
  The zip.
  
  country String
  
  The country.
  
  contact_extension Object Optional
  
  The contactExtension.
  
  Show Properties
  
  tld String
  
  The TLD of this contact extension.
- billing_contact Object Optional
  The billing contact.
  
  Show Properties
  
  organization String Optional
  
  The organization.
  
  name String
  
  The name of contact owner.
  
  email String
  
  The email address.
  
  phone_number String
  
  The phone number.
  
  phone_cc String
  
  The phone country code.
  
  fax_number String Optional
  
  The fax number.
  
  fax_cc String Optional
  
  The fax country code.
  
  address1 String
  
  The address1.
  
  address2 String Optional
  
  The address2.
  
  city String
  
  The city.
  
  state String Optional
  
  The state.
  
  zip String
  
  The zip.
  
  country String
  
  The country.
  
  contact_extension Object Optional
  
  The contactExtension.
  
  Show Properties
  
  tld String
  
  The TLD of this contact extension.
- customer_id int
  
  The domain name.
- name_server_list List Optional
  
  The name server list.
- privacy Enum
  
  Is the domain require privacy.
  Supported valuesOFF, PARTIAL, FULL
currency Enum Optional

The currency.
Supported valuesUSD, GBP, EUR, INR, PLN, ZAR, LTL, CNY, CAD, JPY, NZD, RUB, AUD, MXN, BRL, IDR, ARS, COP, DKK, RSD, HKD, CHF, AED, MYR, NGN, KES, CZK
register_premium boolean Optional

If you're considering registering a premium domain.
coupon_code String Optional

The coupon code plan to be used in the order.

Result Parameters Expand All

domain_name String

The domain name.
expiration_date long

The expiration date in timestamp.

Api Request and Header

POST https://api.dynadot.com/restful/v1/domains/{domain_name}/register

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

X-Signature: {signature}

Request Body

{

domain: {
- duration: 0,
- auth_code: "String",
- registrant_contact_id: 0,
- admin_contact_id: 0,
- tech_contact_id: 0,
- billing_contact_id: 0,
- registrant_contact: {
  - organization: "String",
  - name: "String",
  - email: "String",
  - phone_number: "String",
  - phone_cc: "String",
  - fax_number: "String",
  - fax_cc: "String",
  - address1: "String",
  - address2: "String",
  - city: "String",
  - state: "String",
  - zip: "String",
  - country: "String",
  - contact_extension: {
    - tld: "String"
    1 item}
  14 items},
- admin_contact: {
  - organization: "String",
  - name: "String",
  - email: "String",
  - phone_number: "String",
  - phone_cc: "String",
  - fax_number: "String",
  - fax_cc: "String",
  - address1: "String",
  - address2: "String",
  - city: "String",
  - state: "String",
  - zip: "String",
  - country: "String",
  - contact_extension: {
    - tld: "String"
    1 item}
  14 items},
- tech_contact: {
  - organization: "String",
  - name: "String",
  - email: "String",
  - phone_number: "String",
  - phone_cc: "String",
  - fax_number: "String",
  - fax_cc: "String",
  - address1: "String",
  - address2: "String",
  - city: "String",
  - state: "String",
  - zip: "String",
  - country: "String",
  - contact_extension: {
    - tld: "String"
    1 item}
  14 items},
- billing_contact: {
  - organization: "String",
  - name: "String",
  - email: "String",
  - phone_number: "String",
  - phone_cc: "String",
  - fax_number: "String",
  - fax_cc: "String",
  - address1: "String",
  - address2: "String",
  - city: "String",
  - state: "String",
  - zip: "String",
  - country: "String",
  - contact_extension: {
    - tld: "String"
    1 item}
  14 items},
- customer_id: 0,
- name_server_list: [
  1. "String"
  1 item],
- privacy: "String"
13 items},
currency: "String",
register_premium: false,
coupon_code: "String"

}

Response

{

code: "Integer",
message: "String",
data: {
- domain_name: "String",
- expiration_date: "Long"
}

}

RENEW Command

Support multi-thread

Support API Sandbox

Require X-Signature

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

Request Parameters Expand All

duration Integer

renewal duration in years.
year Integer

year to renew.
currency Enum Optional

The currency you would like to use for the purchase.
Supported valuesUSD, GBP, EUR, INR, PLN, ZAR, LTL, CNY, CAD, JPY, NZD, RUB, AUD, MXN, BRL, IDR, ARS, COP, DKK, RSD, HKD, CHF, AED, MYR, NGN, KES, CZK
coupon String Optional

coupon code.
no_renew_if_late_renew_fee_needed boolean Optional

Do not renew if late renew fee needed.

Result Parameters Expand All

expiration_date Long

expiration date of the domain.

Api Request and Header

POST https://api.dynadot.com/restful/v1/domains/{domain_name}/renew

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

X-Signature: {signature}

Request Body

{

duration: 0,
year: 0,
currency: "String",
coupon: "String",
no_renew_if_late_renew_fee_needed: false

}

Response

{

code: "Integer",
message: "String",
data: {
- expiration_date: "Long"
}

}

TRANSFER_IN Command

Support multi-thread

Support API Sandbox

Require X-Signature

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

Request Parameters Expand All

domain Object
The domain name.
Show Properties
- duration int
  
  The duration of domain.
- auth_code String Optional
  
  The authCode of domain, used only for transfer in action.
- registrant_contact_id int Optional
  
  The registrant contact id.
- admin_contact_id int Optional
  
  The admin contact id.
- tech_contact_id int Optional
  
  The tech contact id.
- billing_contact_id int Optional
  
  The billing contact id.
- registrant_contact Object Optional
  The registrant contact.
  
  Show Properties
  
  organization String Optional
  
  The organization.
  
  name String
  
  The name of contact owner.
  
  email String
  
  The email address.
  
  phone_number String
  
  The phone number.
  
  phone_cc String
  
  The phone country code.
  
  fax_number String Optional
  
  The fax number.
  
  fax_cc String Optional
  
  The fax country code.
  
  address1 String
  
  The address1.
  
  address2 String Optional
  
  The address2.
  
  city String
  
  The city.
  
  state String Optional
  
  The state.
  
  zip String
  
  The zip.
  
  country String
  
  The country.
  
  contact_extension Object Optional
  
  The contactExtension.
  
  Show Properties
  
  tld String
  
  The TLD of this contact extension.
- admin_contact Object Optional
  The admin contact.
  
  Show Properties
  
  organization String Optional
  
  The organization.
  
  name String
  
  The name of contact owner.
  
  email String
  
  The email address.
  
  phone_number String
  
  The phone number.
  
  phone_cc String
  
  The phone country code.
  
  fax_number String Optional
  
  The fax number.
  
  fax_cc String Optional
  
  The fax country code.
  
  address1 String
  
  The address1.
  
  address2 String Optional
  
  The address2.
  
  city String
  
  The city.
  
  state String Optional
  
  The state.
  
  zip String
  
  The zip.
  
  country String
  
  The country.
  
  contact_extension Object Optional
  
  The contactExtension.
  
  Show Properties
  
  tld String
  
  The TLD of this contact extension.
- tech_contact Object Optional
  The tech contact.
  
  Show Properties
  
  organization String Optional
  
  The organization.
  
  name String
  
  The name of contact owner.
  
  email String
  
  The email address.
  
  phone_number String
  
  The phone number.
  
  phone_cc String
  
  The phone country code.
  
  fax_number String Optional
  
  The fax number.
  
  fax_cc String Optional
  
  The fax country code.
  
  address1 String
  
  The address1.
  
  address2 String Optional
  
  The address2.
  
  city String
  
  The city.
  
  state String Optional
  
  The state.
  
  zip String
  
  The zip.
  
  country String
  
  The country.
  
  contact_extension Object Optional
  
  The contactExtension.
  
  Show Properties
  
  tld String
  
  The TLD of this contact extension.
- billing_contact Object Optional
  The billing contact.
  
  Show Properties
  
  organization String Optional
  
  The organization.
  
  name String
  
  The name of contact owner.
  
  email String
  
  The email address.
  
  phone_number String
  
  The phone number.
  
  phone_cc String
  
  The phone country code.
  
  fax_number String Optional
  
  The fax number.
  
  fax_cc String Optional
  
  The fax country code.
  
  address1 String
  
  The address1.
  
  address2 String Optional
  
  The address2.
  
  city String
  
  The city.
  
  state String Optional
  
  The state.
  
  zip String
  
  The zip.
  
  country String
  
  The country.
  
  contact_extension Object Optional
  
  The contactExtension.
  
  Show Properties
  
  tld String
  
  The TLD of this contact extension.
- customer_id int
  
  The domain name.
- name_server_list List Optional
  
  The name server list.
- privacy Enum
  
  Is the domain require privacy.
  Supported valuesOFF, PARTIAL, FULL
currency Enum Optional

The currency.
Supported valuesUSD, GBP, EUR, INR, PLN, ZAR, LTL, CNY, CAD, JPY, NZD, RUB, AUD, MXN, BRL, IDR, ARS, COP, DKK, RSD, HKD, CHF, AED, MYR, NGN, KES, CZK
transfer_premium boolean Optional

If you're considering transfer a premium domain.
coupon_code String Optional

The coupon code plan to be used in the order.

Api Request and Header

POST https://api.dynadot.com/restful/v1/domains/{domain_name}/transfer_in

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

X-Signature: {signature}

Request Body

{

domain: {
- duration: 0,
- auth_code: "String",
- registrant_contact_id: 0,
- admin_contact_id: 0,
- tech_contact_id: 0,
- billing_contact_id: 0,
- registrant_contact: {
  - organization: "String",
  - name: "String",
  - email: "String",
  - phone_number: "String",
  - phone_cc: "String",
  - fax_number: "String",
  - fax_cc: "String",
  - address1: "String",
  - address2: "String",
  - city: "String",
  - state: "String",
  - zip: "String",
  - country: "String",
  - contact_extension: {
    - tld: "String"
    1 item}
  14 items},
- admin_contact: {
  - organization: "String",
  - name: "String",
  - email: "String",
  - phone_number: "String",
  - phone_cc: "String",
  - fax_number: "String",
  - fax_cc: "String",
  - address1: "String",
  - address2: "String",
  - city: "String",
  - state: "String",
  - zip: "String",
  - country: "String",
  - contact_extension: {
    - tld: "String"
    1 item}
  14 items},
- tech_contact: {
  - organization: "String",
  - name: "String",
  - email: "String",
  - phone_number: "String",
  - phone_cc: "String",
  - fax_number: "String",
  - fax_cc: "String",
  - address1: "String",
  - address2: "String",
  - city: "String",
  - state: "String",
  - zip: "String",
  - country: "String",
  - contact_extension: {
    - tld: "String"
    1 item}
  14 items},
- billing_contact: {
  - organization: "String",
  - name: "String",
  - email: "String",
  - phone_number: "String",
  - phone_cc: "String",
  - fax_number: "String",
  - fax_cc: "String",
  - address1: "String",
  - address2: "String",
  - city: "String",
  - state: "String",
  - zip: "String",
  - country: "String",
  - contact_extension: {
    - tld: "String"
    1 item}
  14 items},
- customer_id: 0,
- name_server_list: [
  1. "String"
  1 item],
- privacy: "String"
13 items},
currency: "String",
transfer_premium: false,
coupon_code: "String"

}

Response

{

code: "Integer",
message: "String"

}

RESTORE Command

Support multi-thread

Support API Sandbox

Require X-Signature

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

Request Parameters Expand All

currency Enum Optional

The currency.
Supported valuesUSD, GBP, EUR, INR, PLN, ZAR, LTL, CNY, CAD, JPY, NZD, RUB, AUD, MXN, BRL, IDR, ARS, COP, DKK, RSD, HKD, CHF, AED, MYR, NGN, KES, CZK
coupon_code String Optional

The coupon code plan to be used in the order.

Api Request and Header

POST https://api.dynadot.com/restful/v1/domains/{domain_name}/restore

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

X-Signature: {signature}

Request Body

{

currency: "String",
coupon_code: "String"

}

Response

{

code: "Integer",
message: "String"

}

GRACE_DELETE Command

Support multi-thread

Support API Sandbox

Require X-Signature

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

Request Parameters Expand All

add_to_waiting_list boolean Optional

If need to add this domain to grace delete waiting list if the grace delete quota has been reached.

Api Request and Header

DELETE https://api.dynadot.com/restful/v1/domains/{domain_name}/grace_delete

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

X-Signature: {signature}

Response

{

code: "Integer",
message: "String"

}

SET_FOLDER Command

Support multi-thread

Support API Sandbox

Require X-Signature

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

Request Parameters Expand All

Api Request and Header

PUT https://api.dynadot.com/restful/v1/domains/{domain_name}/folders/{folder_name}

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

X-Signature: {signature}

Request Body

{}

Response

{

code: "Integer",
message: "String"

}

SET_DOMAIN_FORWARDING Command

Support multi-thread

Support API Sandbox

Require X-Signature

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

Request Parameters Expand All

forward_url String

The URL you want your domain to forward to. Please note that the parameter must be encoded so that the API call is interpreted properly.
is_temporary Boolean Optional

Forward status of your domain you want, default value is "true", if you want to forward permanently, use this parameter with "false".

Api Request and Header

PUT https://api.dynadot.com/restful/v1/domains/{domain_name}/domain_forwarding

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

X-Signature: {signature}

Request Body

{

forward_url: "String",
is_temporary: false

}

Response

{

code: "Integer",
message: "String"

}

SET_STEALTH_FORWARDING Command

Support multi-thread

Support API Sandbox

Require X-Signature

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

Request Parameters Expand All

stealth_url String

The URL you want your domain to forward to. Please note that the parameter must be encoded so that the API call is interpreted properly.
stealth_title String

The title of the page.

Api Request and Header

PUT https://api.dynadot.com/restful/v1/domains/{domain_name}/stealth_forwarding

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

X-Signature: {signature}

Request Body

{

stealth_url: "String",
stealth_title: "String"

}

Response

{

code: "Integer",
message: "String"

}

SET_EMAIL_FORWARDING Command

Support multi-thread

Support API Sandbox

Require X-Signature

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

Request Parameters Expand All

forward_type Enum

Forward type, it can be "donot": Do not forward email, "mx": Deliver email to another mail host (MX record), "forward": Deliver email to another mail host.
Supported valuesNONE, MX, FORWARD
forward_detail_list List Optional
Only used when "forwardType" is "forward".
Show Properties
- username String
  
  The username of the target user for forwarding.
- email String
  
  The email address associated with the target user for receiving forwarded content.
mx_record_list List Optional
Only used when "forwardType" is "mx".
Show Properties
- host String
  
  The domain name of the mail server responsible for receiving emails.
- distance String
  
  The priority of the MX record, where smaller values indicate higher priority.

Api Request and Header

PUT https://api.dynadot.com/restful/v1/domains/{domain_name}/email_forwarding

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

X-Signature: {signature}

Request Body

{

forward_type: "String",
forward_detail_list: [
1. {
  - username: "String",
  - email: "String"
  2 items}
1 item],
mx_record_list: [
1. {
  - host: "String",
  - distance: "String"
  2 items}
1 item]

}

Response

{

code: "Integer",
message: "String"

}

SET_RENEW_OPTION Command

Support multi-thread

Support API Sandbox

Require X-Signature

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

Request Parameters Expand All

renew_option Enum

You can choose a value from the following list to represent.
Supported valuesRESET, AUTO, DONOT

Api Request and Header

PUT https://api.dynadot.com/restful/v1/domains/{domain_name}/renew_option

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

X-Signature: {signature}

Request Body

{

renew_option: "String"

}

Response

{

code: "Integer",
message: "String"

}

SET_CONTACTS Command

Support multi-thread

Support API Sandbox

Require X-Signature

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

Request Parameters Expand All

registrant_contact_id Integer

Please select the contact ID you want to set as the registered contact ID.
admin_contact_id Integer

Please select the contact ID you want to set as the admin contact ID.
technical_contact_id Integer

Please select the contact ID you want to set as the technical contact ID.
billing_contact_id Integer

Please select the contact ID you want to set as the billing contact ID.

Api Request and Header

PUT https://api.dynadot.com/restful/v1/domains/{domain_name}/contacts

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

X-Signature: {signature}

Request Body

{

registrant_contact_id: 0,
admin_contact_id: 0,
technical_contact_id: 0,
billing_contact_id: 0

}

Response

{

code: "Integer",
message: "String"

}

GET_TRANSFER_STATUS Command

Support multi-thread

Support API Sandbox

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

Request Parameters Expand All

Result Parameters Expand All

domain_transfer_status_list List
The domain transfer status list information.
Show Properties
- order_id String
  
  The order ID of the transfer.
- transfer_status String
  
  The status of the transfer.
- failed_reason String
  
  The reason of the failure.
- expiration_date long
  
  The expiration time of the transfer.

Api Request and Header

GET https://api.dynadot.com/restful/v1/domains/{domain_name}/transfer_status/{transfer_type}

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

Response

{

code: "Integer",
message: "String",
data: {
- domain_transfer_status_list: [
  1. {
    - order_id: "String",
    - transfer_status: "String"
    }
  ]
}

}

DOMAIN_GET_NAMESERVER Command

Support multi-thread

Support API Sandbox

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

Request Parameters Expand All

domain_name String

The domain whose name server info you want to get.

Result Parameters Expand All

nameserver_list List

The list of nameservers for the domain.
server_name String

The name of the nameserver.

Api Request and Header

GET https://api.dynadot.com/restful/v1/domains/{domain_name}/nameservers

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

Response

{

code: "Integer",
message: "String",
data: {
- name_servers: [
  1. {
    - host: "String",
    - ns_name: "String"
    }
  ]
}

}

DOMAIN_SET_NAMESERVER Command

Support multi-thread

Support API Sandbox

Require X-Signature

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

Request Parameters Expand All

nameserver_list List

The list of nameservers you want to set.

Api Request and Header

PUT https://api.dynadot.com/restful/v1/domains/{domain_name}/nameservers

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

X-Signature: {signature}

Request Body

{

nameserver_list: [
1. "String"
1 item]

}

Response

{

code: "Integer",
message: "String"

}

SET_HOSTING Command

Support multi-thread

Support API Sandbox

Require X-Signature

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

Request Parameters Expand All

hosting_type Enum

Type of the hosting you want, you can select in "Advanced" and "Basic".
Supported valuesBASIC, ADVANCED
is_model_view Boolean

Only when hostingType is "advanced", can you use this parameter as "true".

Api Request and Header

PUT https://api.dynadot.com/restful/v1/domains/{domain_name}/hosts

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

X-Signature: {signature}

Request Body

{

hosting_type: "String",
is_model_view: false

}

Response

{

code: "Integer",
message: "String"

}

SET_PARKING Command

Support multi-thread

Support API Sandbox

Require X-Signature

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

Request Parameters Expand All

with_ads Boolean Optional

If you do not want a 3rd-party ads, you can use this parameter with "false".

Api Request and Header

PUT https://api.dynadot.com/restful/v1/domains/{domain_name}/parking

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

X-Signature: {signature}

Request Body

{

with_ads: false

}

Response

{

code: "Integer",
message: "String"

}

SET_PRIVACY Command

Support multi-thread

Support API Sandbox

Require X-Signature

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

Request Parameters Expand All

privacy_level Enum

The privacy status of the domain you want to set.
Supported valuesOFF, PARTIAL, FULL
whois_privacy_option Boolean

The whois privacy option of the domain you want to set.

Api Request and Header

PUT https://api.dynadot.com/restful/v1/domains/{domain_name}/privacy

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

X-Signature: {signature}

Request Body

{

privacy_level: "String",
whois_privacy_option: false

}

Response

{

code: "Integer",
message: "String"

}

SET_DNSSEC Command

Support multi-thread

Support API Sandbox

Require X-Signature

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

Request Parameters Expand All

key_tag Integer Optional

The key tag is a 16-bit unsigned integer (0 - 65535) used to uniquely identify a DNSSEC key pair. It ensures DS records match their corresponding DNS KEY records during DNSSEC validation.
digest_type Enum Optional

You can choose the digest_type type listed below.
Supported valuesSHA1, SHA256, GOST, SHA384
digest String Optional

Please enter the value corresponding to the digest type you have selected.
algorithm Enum

You can choose the type of algorithm listed below.
Supported valuesRSA_MD5, DIFFIE_HELLMAN, DSA_SHA1, ELLIPTIC_CURVE, RSA_SHA1, DSA_NSEC3_SHA1, RSA_SHA1_NSEC3_SHA1, RSA_SHA256, RSA_SHA512, GOST, ECDSA_P256_SHA256, ECDSA_P384_SHA384, ED25519, ED448, INDIRECT, PRIVATE_DNS, PRIVATE_OID
flags Enum Optional

You can choose the type of flags listed below.
Supported valuesZSK, KSK
public_key String Optional

The public key must be in base64 encoding.

Api Request and Header

PUT https://api.dynadot.com/restful/v1/domains/{domain_name}/dnssec

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

X-Signature: {signature}

Request Body

{

key_tag: 0,
digest_type: "String",
digest: "String",
algorithm: "String",
flags: "String",
public_key: "String"

}

Response

{

code: "Integer",
message: "String"

}

GET_DNSSEC Command

Support multi-thread

Support API Sandbox

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

Request Parameters Expand All

Result Parameters Expand All

dnssec_info_list List
dnssecInfoList.
Show Properties
- key_tag int
  
  The key tag of the DNSSEC record.
- algorithm String
  
  The algorithm of the DNSSEC record.
- digest_type String
  
  The digest type of the DNSSEC record.
- digest String
  
  The digest of the DNSSEC record.

Api Request and Header

GET https://api.dynadot.com/restful/v1/domains/{domain_name}/dnssec

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

Response

{

code: "Integer",
message: "String",
data: {
- dnssec_info_list: [
  1. {
    - key_tag: "Integer",
    - algorithm: "String",
    - digest_type: "String",
    - digest: "String"
    }
  ]
}

}

CLEAR_DNSSEC Command

Support multi-thread

Support API Sandbox

Require X-Signature

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

Request Parameters Expand All

Api Request and Header

DELETE https://api.dynadot.com/restful/v1/domains/{domain_name}/dnssec

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

X-Signature: {signature}

Response

{

code: "Integer",
message: "String"

}

CLEAR_DOMAIN_SETTING Command

Support multi-thread

Support API Sandbox

Require X-Signature

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

Request Parameters Expand All

service_type Enum

The service you want to clear the domain settings for, you can enter forward, stealth, email_forwarding, free, dns, nameservers.
Supported valuesFORWARD, STEALTH, EMAIL_FORWARDING, DNS, NAMESERVERS

Api Request and Header

PUT https://api.dynadot.com/restful/v1/domains/{domain_name}/clear_domain_setting

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

X-Signature: {signature}

Request Body

{

service_type: "String"

}

Response

{

code: "Integer",
message: "String"

}

SET_DOMAIN_LOCK_STATUS Command

Support multi-thread

Support API Sandbox

Require X-Signature

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

Request Parameters Expand All

lock Boolean

Set to true to lock the domain, false to unlock the domain.

Api Request and Header

PUT https://api.dynadot.com/restful/v1/domains/{domain_name}/domain_lock

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

X-Signature: {signature}

Request Body

{

lock: false

}

Response

{

code: "Integer",
message: "String"

}

PUSH Command

Support multi-thread

Support API Sandbox

Require X-Signature

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

Request Parameters Expand All

receiver_push_username String

The receiver's push username.
receiver_email String Optional

The receiver email.

Api Request and Header

POST https://api.dynadot.com/restful/v1/domains/{domain_name}/push

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

X-Signature: {signature}

Request Body

{

receiver_push_username: "String",
receiver_email: "String"

}

Response

{

code: "Integer",
message: "String"

}

ACCEPT_PUSH Command

Support multi-thread

Support API Sandbox

Require X-Signature

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

Request Parameters Expand All

push_action Enum

The action of the order to be processed.
Supported valuesACCEPT, DECLINE

Api Request and Header

POST https://api.dynadot.com/restful/v1/domains/{domain_name}/accept_push

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

X-Signature: {signature}

Request Body

{

push_action: "String"

}

Response

{

code: "Integer",
message: "String"

}

GET_PENDING_PUSH_ACCEPT_REQUEST Command

Support multi-thread

Support API Sandbox

Require X-Signature

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

Request Parameters Expand All

Result Parameters Expand All

domain_name_list List

List of domain names.

Api Request and Header

GET https://api.dynadot.com/restful/v1/domains/pending_accept_pushes

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

X-Signature: {signature}

Response

{

code: "Integer",
message: "String",
data: {
- domain_name_list: [
  1. "String"
  ]
}

}

GET_DNS Command

Support multi-thread

Support API Sandbox

Require X-Signature

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

Request Parameters Expand All

Result Parameters Expand All

glue_info Object
The dns setting of the domain.
Show Properties
- glue_type Enum
  
  The type of the nameserver.
  Supported valuesTYPE_NULL, TYPE_PARK, TYPE_DNS, TYPE_USER, TYPE_FORWARD, TYPE_STEALTH, TYPE_WEBHOST_BASIC, TYPE_DYNASITE, TYPE_WEBHOST_ADVANCED, TYPE_FREE_WEBHOST, TYPE_SITEBUILDER, TYPE_FORSALE, TYPE_RESELLER_STOREFRONT, TYPE_PARK_BOT
- nameservers List
  The nameservers.
  
  Show Properties
  
  server_name String Optional
  
  The name of the nameserver.
  
  ip_list Array Optional
  
  The IP list of the nameserver.
- with_ads String
  
  The status of the ads.
- forward_to String
  
  The forward to.
- forward_type String
  
  The forward type.
- website_title String
  
  The title of the website.
- email_forward_type Enum
  
  The email forwarding settings.
  Supported valuesMTYPE_NONE, MTYPE_FORWARD, MTYPE_MX
- mail_exchanges List
  The mail exchanges.
  
  Show Properties
  
  host String Optional
  
  Mail host, only used when forward type is mx, only used when "forward_type" is "mx".
  
  distance String Optional
  
  Distance is the highest priority, only used when "forward_type" is "mx".
- email_alias_list List
  The email alias list.
  
  Show Properties
  
  username String Optional
  
  The user name of the email alias, only used when "forward_type" is "forward".
  
  to_email String Optional
  
  The email address of the email alias, only used when "forward_type" is "forward".
- dns_main_list List
  The dns main list.
  
  Show Properties
  
  record_type Enum Optional
  
  The type of the record.
  Supported valuesA, AAAA, CNAME, ANAME, FORWARD, TXT, SRV, MX, STEALTH, EMAIL, CAA
  
  record_value1 String Optional
  
  The value of the record.
  
  record_value2 String Optional
  
  The second value of the record.
- dns_sub_list List
  The dns sub list.
  
  Show Properties
  
  sub_host String Optional
  
  The subhost of the DNS record.
  
  record_type Enum Optional
  
  The record type of the DNS record.
  Supported valuesA, AAAA, CNAME, ANAME, FORWARD, TXT, SRV, MX, STEALTH, EMAIL, CAA
  
  record_value1 String Optional
  
  The value of the DNS record.
  
  record_value2 String Optional
  
  The second value of the DNS record.
- ttl String
  
  The time to live.

Api Request and Header

GET https://api.dynadot.com/restful/v1/domains/{domain_name}/records

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

X-Signature: {signature}

Response

{

code: "Integer",
message: "String",
data: {
- name_server_settings: {
  - type: "String",
  - with_ads: "String"
  }
}

}

SET_DNS Command

Support multi-thread

Support API Sandbox

Require X-Signature

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

Request Parameters Expand All

dns_main_list List
List of main DNS records, max 20.
Show Properties
- record_type Enum Optional
  
  The type of the record.
  Supported valuesA, AAAA, CNAME, ANAME, FORWARD, TXT, SRV, MX, STEALTH, EMAIL, CAA
- record_value1 String Optional
  
  The value of the record.
- record_value2 String Optional
  
  The second value of the record.
sub_list List Optional
List of sub DNS records, max 100.
Show Properties
- sub_host String Optional
  
  The subhost of the DNS record.
- record_type Enum Optional
  
  The record type of the DNS record.
  Supported valuesA, AAAA, CNAME, ANAME, FORWARD, TXT, SRV, MX, STEALTH, EMAIL, CAA
- record_value1 String Optional
  
  The value of the DNS record.
- record_value2 String Optional
  
  The second value of the DNS record.
ttl Long Optional

Time to live for DNS records, default is 86400.
add_dns_to_current_setting Boolean Optional

Add DNS records to current settings, default is false.

Api Request and Header

POST https://api.dynadot.com/restful/v1/domains/{domain_name}/records

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

X-Signature: {signature}

Request Body

{

dns_main_list: [
1. {
  - record_type: "String",
  - record_value1: "String",
  - record_value2: "String"
  3 items}
1 item],
sub_list: [
1. {
  - sub_host: "String",
  - record_type: "String",
  - record_value1: "String",
  - record_value2: "String"
  4 items}
1 item],
ttl: 0,
add_dns_to_current_setting: false

}

Response

{

code: "Integer",
message: "String"

}

SET_NOTE Command

Support multi-thread

Support API Sandbox

Require X-Signature

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

Request Parameters Expand All

note String

this domain's note.

Api Request and Header

PUT https://api.dynadot.com/restful/v1/domains/{domain_name}/notes

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

X-Signature: {signature}

Request Body

{

note: "String"

}

Response

{

code: "Integer",
message: "String"

}

GET_TRANSFER_AUTH_CODE Command

Support multi-thread

Support API Sandbox

Require X-Signature

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

Request Parameters Expand All

new_code Boolean Optional

Set to true if you want to generate a new auth code.
unlock_domain_for_transfer Boolean Optional

Set to true if you want to unlock the domain for transfer.

Result Parameters Expand All

auth_code String

The transfer auth code.

Api Request and Header

GET https://api.dynadot.com/restful/v1/domains/{domain_name}/transfer_auth_code

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

X-Signature: {signature}

Response

{

code: "Integer",
message: "String",
data: {
- auth_code: "String"
}

}

GET_TLD_PRICE Command

Support multi-thread

Support API Sandbox

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

Request Parameters Expand All

currency Enum

The currency you would like to use for the search.
Supported valuesUSD, GBP, EUR, INR, PLN, ZAR, LTL, CNY, CAD, JPY, NZD, RUB, AUD, MXN, BRL, IDR, ARS, COP, DKK, RSD, HKD, CHF, AED, MYR, NGN, KES, CZK
page_index Integer Optional

The page index.
count_per_page Integer Optional

The count per page.
sort Enum Optional

The sort : nameAsc, nameDesc, etc.
Supported valuesRANK_ASC, RANK_DESC, NAME_ASC, NAME_DESC, SALES_ASC, SALES_DESC, LAUNCH_DATE_ASC, LAUNCH_DATE_DESC, COUNT_ASC, COUNT_DESC, REGISTRY_ASC, REGISTRY_DESC
show_multi_year Boolean Optional

Whether to show multi-year prices.

Result Parameters Expand All

page_index Integer

The page index.
count_per_page Integer

The count per page.
sort Enum

The sort : nameAsc, nameDesc, etc.
Supported valuesRANK_ASC, RANK_DESC, NAME_ASC, NAME_DESC, SALES_ASC, SALES_DESC, LAUNCH_DATE_ASC, LAUNCH_DATE_DESC, COUNT_ASC, COUNT_DESC, REGISTRY_ASC, REGISTRY_DESC
price_level String

The price level.
currency String

The currency you would like to use for the search.
show_multi_year_price Boolean

Whether to show multi-year prices.
tld_price_list List
The list of TLD prices.
Show Properties
- tld String
  
  The TLD.
- usage String
  
  The usage.
- price_unit String
  
  The price unit.
- all_years_register_price Array
  
  The price for all years registration.
- all_years_renew_price Array
  
  The price for all years renewal.
- transfer_price String
  
  The transfer price.
- restore_price String
  
  The restore price.
- grace_fee_price String
  
  The grace fee price.
- support_privacy String
  
  The support privacy.
- grace_period_unit String
  
  The grace period unit.
- renew_grace_period String
  
  The renew grace period.
- restore_period String
  
  The restore period.
- delete_grace_period String
  
  The delete grace period.
- is_idn String
  
  The IDN.
- restriction String
  
  The restriction.

Api Request and Header

GET https://api.dynadot.com/restful/v1/domains/get_tld_price

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

Response

{

code: "Integer",
message: "String",
data: {
- page_index: "Integer",
- count_per_page: "Integer",
- sort: "String",
- price_level: "String",
- currency: "String",
- show_multi_year_price: "String",
- tldPriceList: [
  1. {
    - tld: "String",
    - usage: "String",
    - priceUnit: "String",
    - allYearsRegisterPrice: [],
    - allYearsRenewPrice: [],
    - transferPrice: "String",
    - restorePrice: "String",
    - graceFeePrice: "String",
    - supportPrivacy: "String",
    - gracePeriodUnit: "String",
    - renewGracePeriod: "String",
    - restorePeriod: "String",
    - deleteGracePeriod: "String",
    - isIdn: "String",
    - restriction: "String"
    }
  ]
}

}

DOMAIN_LIST Command

Support multi-thread

Support API Sandbox

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

Request Parameters Expand All

sort Enum Optional

The sort type.
Supported valuesCOUNT_ASC, COUNT_DESC, NAME_ASC, NAME_DESC
count_per_page int Optional

The count per page.
page_index int Optional

The page index.

Result Parameters Expand All

List
.
Show Properties
- domain_name String
  
  Domain name.
- expiration long
  
  Expiration date.
- registration long
  
  Registration date.
- glue_info Object
  Glue information.
  
  Show Properties
  
  glue_type Enum Optional
  
  The type of the nameserver.
  Supported valuesTYPE_NULL, TYPE_PARK, TYPE_DNS, TYPE_USER, TYPE_FORWARD, TYPE_STEALTH, TYPE_WEBHOST_BASIC, TYPE_DYNASITE, TYPE_WEBHOST_ADVANCED, TYPE_FREE_WEBHOST, TYPE_SITEBUILDER, TYPE_FORSALE, TYPE_RESELLER_STOREFRONT, TYPE_PARK_BOT
  
  nameservers List Optional
  
  The nameservers.
  
  Show Properties
  
  server_name String Optional
  
  The name of the nameserver.
  
  ip_list Array Optional
  
  The IP list of the nameserver.
  
  with_ads String Optional
  
  The status of the ads.
  
  forward_to String Optional
  
  The forward to.
  
  forward_type String Optional
  
  The forward type.
  
  website_title String Optional
  
  The title of the website.
  
  email_forward_type Enum Optional
  
  The email forwarding settings.
  Supported valuesMTYPE_NONE, MTYPE_FORWARD, MTYPE_MX
  
  mail_exchanges List Optional
  
  The mail exchanges.
  
  Show Properties
  
  host String Optional
  
  Mail host, only used when forward type is mx, only used when "forward_type" is "mx".
  
  distance String Optional
  
  Distance is the highest priority, only used when "forward_type" is "mx".
  
  email_alias_list List Optional
  
  The email alias list.
  
  Show Properties
  
  username String Optional
  
  The user name of the email alias, only used when "forward_type" is "forward".
  
  to_email String Optional
  
  The email address of the email alias, only used when "forward_type" is "forward".
  
  dns_main_list List Optional
  
  The dns main list.
  
  Show Properties
  
  record_type Enum Optional
  
  The type of the record.
  Supported valuesA, AAAA, CNAME, ANAME, FORWARD, TXT, SRV, MX, STEALTH, EMAIL, CAA
  
  record_value1 String Optional
  
  The value of the record.
  
  record_value2 String Optional
  
  The second value of the record.
  
  dns_sub_list List Optional
  
  The dns sub list.
  
  Show Properties
  
  sub_host String Optional
  
  The subhost of the DNS record.
  
  record_type Enum Optional
  
  The record type of the DNS record.
  Supported valuesA, AAAA, CNAME, ANAME, FORWARD, TXT, SRV, MX, STEALTH, EMAIL, CAA
  
  record_value1 String Optional
  
  The value of the DNS record.
  
  record_value2 String Optional
  
  The second value of the DNS record.
  
  ttl String Optional
  
  The time to live.
- registrant_contact_id int
  
  Registrar contact ID.
- admin_contact_id int
  
  Admin contact ID.
- tech_contact_id int
  
  Tech contact ID.
- billing_contact_id int
  
  Billing contact ID.
- locked Boolean
  
  Domain locked status.
- disabled Boolean
  
  Domain disabled status.
- udrp_locked Boolean
  
  UDRP locked status.
- registrant_unverified Boolean
  
  Registrant unverified status.
- hold Boolean
  
  Hold status.
- privacy String
  
  Privacy status.
- is_for_sale Boolean
  
  Is for sale status.
- renew_option String
  
  Renew option.
- note String
  
  Note.
- folder_id int
  
  Folder ID.
- folder_name String
  
  Folder name.
- status String
  
  Status.

Api Request and Header

GET https://api.dynadot.com/restful/v1/domains

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

Response

GET_CONTACT Command

Support multi-thread

Support API Sandbox

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

Request Parameters Expand All

Result Parameters Expand All

contact Object
The contact object.
Show Properties
- organization String
  
  The organization.
- name String
  
  The name of contact owner.
- email String
  
  The email address.
- phone_number String
  
  The phone number.
- phone_cc String
  
  The phone country code.
- fax_number String
  
  The fax number.
- fax_cc String
  
  The fax country code.
- address1 String
  
  The address1.
- address2 String
  
  The address2.
- city String
  
  The city.
- state String
  
  The state.
- zip String
  
  The zip.
- country String
  
  The country.
- contact_extension Object
  The contactExtension.
  
  Show Properties
  
  tld String
  
  The TLD of this contact extension.

Api Request and Header

GET https://api.dynadot.com/restful/v1/contacts/{contact_id}

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

Response

{

code: "Integer",
message: "String",
data: {
- organization: "String",
- name: "String",
- email: "String",
- phone_number: "String",
- phone_cc: "String",
- fax_number: "String",
- fax_cc: "String",
- address1: "String",
- address2: "String",
- city: "String",
- state: "String",
- zip: "String",
- country: "String"
}

}

CONTACT_LIST Command

Support multi-thread

Support API Sandbox

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

Request Parameters Expand All

Result Parameters Expand All

contact_list List
The list of contacts.
Show Properties
- contact_id int
  
  The contact_id.
- organization String
  
  The organization.
- name String
  
  The name of contact owner.
- email String
  
  The email address.
- phone_number String
  
  The phone number.
- phone_cc String
  
  The phone country code.
- fax_number String
  
  The fax number.
- fax_cc String
  
  The fax country code.
- address1 String
  
  The address1.
- address2 String
  
  The address2.
- city String
  
  The city.
- state String
  
  The state.
- zip String
  
  The zip.
- country String
  
  The country.
- contact_extension Object
  The contactExtension.
  
  Show Properties
  
  tld String
  
  The TLD of this contact extension.

Api Request and Header

GET https://api.dynadot.com/restful/v1/contacts

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

Response

{

code: "Integer",
message: "String",
data: {
- contact_list: [
  1. {
    - contact_id: "Integer",
    - organization: "String",
    - name: "String",
    - email: "String",
    - phone_number: "String",
    - phone_cc: "String",
    - fax_number: "String",
    - fax_cc: "String",
    - address1: "String",
    - address2: "String",
    - city: "String",
    - state: "String",
    - zip: "String",
    - country: "String"
    }
  ]
}

}

CONTACT_CREATE Command

Support multi-thread

Support API Sandbox

Require X-Signature

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

Request Parameters Expand All

contact Object
The Contact.
Show Properties
- organization String Optional
  
  The organization.
- name String
  
  The name of contact owner.
- email String
  
  The email address.
- phone_number String
  
  The phone number.
- phone_cc String
  
  The phone country code.
- fax_number String Optional
  
  The fax number.
- fax_cc String Optional
  
  The fax country code.
- address1 String
  
  The address1.
- address2 String Optional
  
  The address2.
- city String
  
  The city.
- state String Optional
  
  The state.
- zip String
  
  The zip.
- country String
  
  The country.
- contact_extension Object Optional
  The contactExtension.
  
  Show Properties
  
  tld String
  
  The TLD of this contact extension.

Result Parameters Expand All

contact_id int

.

Api Request and Header

POST https://api.dynadot.com/restful/v1/contacts

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

X-Signature: {signature}

Request Body

{

contact: {
- organization: "String",
- name: "String",
- email: "String",
- phone_number: "String",
- phone_cc: "String",
- fax_number: "String",
- fax_cc: "String",
- address1: "String",
- address2: "String",
- city: "String",
- state: "String",
- zip: "String",
- country: "String",
- contact_extension: {
  - tld: "String"
  1 item}
14 items}

}

Response

{

code: "Integer",
message: "String",
data: {
- contact_id: "Integer"
}

}

CONTACT_UPDATE Command

Support multi-thread

Support API Sandbox

Require X-Signature

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

Request Parameters Expand All

contact Object
The contact.
Show Properties
- organization String Optional
  
  The organization.
- name String
  
  The name of contact owner.
- email String
  
  The email address.
- phone_number String
  
  The phone number.
- phone_cc String
  
  The phone country code.
- fax_number String Optional
  
  The fax number.
- fax_cc String Optional
  
  The fax country code.
- address1 String
  
  The address1.
- address2 String Optional
  
  The address2.
- city String
  
  The city.
- state String Optional
  
  The state.
- zip String
  
  The zip.
- country String
  
  The country.
- contact_extension Object Optional
  The contactExtension.
  
  Show Properties
  
  tld String
  
  The TLD of this contact extension.

Result Parameters Expand All

contact_id int

The contact id.

Api Request and Header

PUT https://api.dynadot.com/restful/v1/contacts/{contact_id}

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

X-Signature: {signature}

Request Body

{

contact: {
- organization: "String",
- name: "String",
- email: "String",
- phone_number: "String",
- phone_cc: "String",
- fax_number: "String",
- fax_cc: "String",
- address1: "String",
- address2: "String",
- city: "String",
- state: "String",
- zip: "String",
- country: "String",
- contact_extension: {
  - tld: "String"
  1 item}
14 items}

}

Response

{

code: "Integer",
message: "String",
data: {
- contact_id: "Integer"
}

}

CONTACT_DELETE Command

Support multi-thread

Support API Sandbox

Require X-Signature

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

Request Parameters Expand All

Result Parameters Expand All

contact_id int

The Id of contact.

Api Request and Header

DELETE https://api.dynadot.com/restful/v1/contacts/{contact_id}

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

X-Signature: {signature}

Response

{

code: "Integer",
message: "String",
data: {
- contact_id: "Integer"
}

}

CREATE_CN_AUDIT Command

Support multi-thread

Support API Sandbox

Require X-Signature

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

Request Parameters Expand All

contact_type Enum

When the contact type is ENTERPRISE, you need to enter enterprise_id_type,enterprise_license_id, enterprise_url.
Supported valuesINDIVIDUAL, ENTERPRISE
individual_id_type Enum

Individual ID type.
Supported valuesJGZ, SFZ, HZ, GAJMTX, TWJMTX, WJLSFZ, GAJZZ, TWJZZ, QT
individual_url String

Document of natural person license ID. The file url on the server. Only jpg, gif, png, jpeg are allowed.
individual_license_id String

The individual license ID.
enterprise_id_type Enum Optional

Enterprise type.
Supported valuesORG, YYZZ, TYDM, BDDM, JDDWFW, SYDWFR, WGCZJG, SHTTFR, ZJCS, MBFQY, JJHFR, LSZY, WGZHWH, WLCZJG, SFJD, JWJG, SHFWJG, MBXXBX, YLJGZY, GZJGZY, BJWSXX, QTTYDM, QT
enterprise_license_id String Optional

The License number of enterprise document.
enterprise_url String Optional

Document of enterprise license. The file url on the server. Only jpg, gif, png, jpeg are allowed.

Api Request and Header

POST https://api.dynadot.com/restful/v1/contacts/{contact_id}/create_cn_audit

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

X-Signature: {signature}

Request Body

{

contact_type: "String",
individual_id_type: "String",
individual_url: "String",
individual_license_id: "String",
enterprise_id_type: "String",
enterprise_license_id: "String",
enterprise_url: "String"

}

Response

{

code: "Integer",
message: "String"

}

GET_CN_AUDIT_STATUS Command

Support multi-thread

Support API Sandbox

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

Request Parameters Expand All

is_gtld Boolean

If you query the audit result of the cnnic-gtld, please set this parameter to true.

Result Parameters Expand All

audit_status String

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

If the audit unpassable, the failed reason will be displayed.

Api Request and Header

GET https://api.dynadot.com/restful/v1/contacts/{contact_id}/get_cn_audit_status

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

Response

{

code: "Integer",
message: "String",
data: {
- audit_status: "String"
}

}

SET_CONTACT_EU_SETTING Command

Support multi-thread

Support API Sandbox

Require X-Signature

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

Request Parameters Expand All

contact_extension Object
The contact extension for eu.
Show Properties
- country_of_citizenship Enum
  
  The country code of the citizenship. If a contact's address is set to any country outside of Europe, you must provide a valid country of citizenship order to use the contact for .EU domains.
  Supported valuesAT, BE, BG, CZ, CY, DE, DK, ES, EE, FI, FR, GR, HR, HU, IE, IT, LT, LU, LV, MT, NL, PL, PT, RO, SE, SI, SK, IS, LI, NO
- tld String
  
  The TLD of this contact extension.

Result Parameters Expand All

contact_id int

The contact.

Api Request and Header

PUT https://api.dynadot.com/restful/v1/contacts/{contact_id}/set_eu_setting

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

X-Signature: {signature}

Request Body

{

contact_extension: {
- country_of_citizenship: "String",
- tld: "String"
2 items}

}

Response

{

code: "Integer",
message: "String",
data: {
- contact_id: "Integer"
}

}

SET_CONTACT_LT_SETTING Command

Support multi-thread

Support API Sandbox

Require X-Signature

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

Request Parameters Expand All

contact_extension Object
The contact extension for lt.
Show Properties
- organization_code String
  
  The organization code of the contact.
- tld String
  
  The TLD of this contact extension.

Result Parameters Expand All

account_id int

The account ID.

Api Request and Header

PUT https://api.dynadot.com/restful/v1/contacts/{contact_id}/set_lt_setting

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

X-Signature: {signature}

Request Body

{

contact_extension: {
- organization_code: "String",
- tld: "String"
2 items}

}

Response

{

code: "Integer",
message: "String",
data: {
- contact_id: "Integer"
}

}

SET_CONTACT_LV_SETTING Command

Support multi-thread

Support API Sandbox

Require X-Signature

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

Request Parameters Expand All

contact_extension Object
The contact extension for lv.
Show Properties
- registration_number String
  
  - 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 String
  
  VAT number for foreign legal entities registered within European Union countries (this includes also Latvian companies).
- tld String
  
  The TLD of this contact extension.

Result Parameters Expand All

contact_id int

The contact's ID you want to edit.

Api Request and Header

PUT https://api.dynadot.com/restful/v1/contacts/{contact_id}/set_lv_setting

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

X-Signature: {signature}

Request Body

{

contact_extension: {
- registration_number: "String",
- vat_number: "String",
- tld: "String"
3 items}

}

Response

{

code: "Integer",
message: "String",
data: {
- contact_id: "Integer"
}

}

SET_CONTACT_IT_SETTING Command

Support multi-thread

Support API Sandbox

Require X-Signature

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

Request Parameters Expand All

contact_extension Object
The contact extension for it.
Show Properties
- country_of_citizenship String
  
  The nationality code.
- codice_doc_number String
  
  The codice document number.
- tld String
  
  The TLD of this contact extension.

Result Parameters Expand All

contact_id int

The contact's ID you want to edit.

Api Request and Header

PUT https://api.dynadot.com/restful/v1/contacts/{contact_id}/set_it_setting

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

X-Signature: {signature}

Request Body

{

contact_extension: {
- country_of_citizenship: "String",
- codice_doc_number: "String",
- tld: "String"
3 items}

}

Response

{

code: "Integer",
message: "String",
data: {
- contact_id: "Integer"
}

}

NAMESERVER_GET Command

Support multi-thread

Support API Sandbox

Require X-Signature

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

Request Parameters Expand All

Result Parameters Expand All

nameserver Object
The name server.
Show Properties
- server_name String
  
  The name of the nameserver.
- ip_list Array
  
  The IP list of the nameserver.

Api Request and Header

GET https://api.dynadot.com/restful/v1/nameservers/{nameserver}

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

X-Signature: {signature}

Response

{

code: "Integer",
message: "String",
data: {
- server_name: "String",
- ip_list: [
  1. "String"
  ]
}

}

NAMESERVER_LIST Command

Support multi-thread

Support API Sandbox

Require X-Signature

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

Request Parameters Expand All

Result Parameters Expand All

nameserver_list List
The list of nameservers.
Show Properties
- server_name String
  
  The name of the nameserver.
- ip_list Array
  
  The IP list of the nameserver.

Api Request and Header

GET https://api.dynadot.com/restful/v1/nameservers

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

X-Signature: {signature}

Response

{

code: "Integer",
message: "String",
data: {
- nameserver_list: [
  1. {
    - server_name: "String",
    - ip_list: [
      1. "String"
      ]
    }
  ]
}

}

NAMESERVER_REGISTER Command

Support multi-thread

Support API Sandbox

Require X-Signature

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

Request Parameters Expand All

name_server Object
The name server.
Show Properties
- server_name String
  
  The name server, example: ns1.domain.com.
- ip String
  
  The ip of server, example: 127.0.0.1.

Api Request and Header

POST https://api.dynadot.com/restful/v1/nameservers/register

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

X-Signature: {signature}

Request Body

{

name_server: {
- server_name: "String",
- ip: "String"
2 items}

}

Response

{

code: "Integer",
message: "String"

}

NAMESERVER_ADD_EXTERNAL Command

Support multi-thread

Support API Sandbox

Require X-Signature

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

Request Parameters Expand All

Api Request and Header

POST https://api.dynadot.com/restful/v1/nameservers/{nameserver}/add_external

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

X-Signature: {signature}

Request Body

{}

Response

{

code: "Integer",
message: "String"

}

NAMESERVER_SET_IP Command

Support multi-thread

Support API Sandbox

Require X-Signature

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

Request Parameters Expand All

ip_list List

The list of IPs you want to set to the name server.

Result Parameters Expand All

host String

The name server host.
server_id Integer

server id.

Api Request and Header

PUT https://api.dynadot.com/restful/v1/nameservers/{nameserver}/set_ip

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

X-Signature: {signature}

Request Body

{

ip_list: [
1. "String"
1 item]

}

Response

{

code: "Integer",
message: "String",
data: {
- host: "String",
- server_id: "Integer"
}

}

NAMESERVER_DELETE Command

Support multi-thread

Support API Sandbox

Require X-Signature

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

Request Parameters Expand All

Api Request and Header

DELETE https://api.dynadot.com/restful/v1/nameservers/{nameserver}

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

X-Signature: {signature}

Response

{

code: "Integer",
message: "String"

}

GET_INFO Command

Support multi-thread

Support API Sandbox

Require X-Signature

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

Request Parameters Expand All

Result Parameters Expand All

account_info Object
The account information.
Show Properties
- username String
  
  The username of the account.
- forum_name String
  
  The forum name of the account.
- avatar_url String
  
  The avatar URL of the account.
- account_contact Object
  The contact information of the account.
  
  Show Properties
  
  organization String Optional
  
  The organization.
  
  name String
  
  The name of contact owner.
  
  email String
  
  The email address.
  
  phone_number String
  
  The phone number.
  
  phone_cc String
  
  The phone country code.
  
  fax_number String Optional
  
  The fax number.
  
  fax_cc String Optional
  
  The fax country code.
  
  address1 String
  
  The address1.
  
  address2 String Optional
  
  The address2.
  
  city String
  
  The city.
  
  state String Optional
  
  The state.
  
  zip String
  
  The zip.
  
  country String
  
  The country.
  
  contact_extension Object Optional
  
  The contactExtension.
  
  Show Properties
  
  tld String
  
  The TLD of this contact extension.
- customer_since Long
  
  The customer since date of the account.
- account_lock String
  
  The account lock status of the account.
- custom_time_zone String
  
  The custom time zone of the account.
- default_registrant_contact_id Integer
  
  The default registrant contact ID of the account.
- default_admin_contact_id Integer
  
  The default admin contact ID of the account.
- default_technical_contact_id Integer
  
  The default technical contact ID of the account.
- default_billing_contact_id Integer
  
  The default billing contact ID of the account.
- glue_info Object
  The default DNS setting of the account.
  
  Show Properties
  
  glue_type Enum Optional
  
  The type of the nameserver.
  Supported valuesTYPE_NULL, TYPE_PARK, TYPE_DNS, TYPE_USER, TYPE_FORWARD, TYPE_STEALTH, TYPE_WEBHOST_BASIC, TYPE_DYNASITE, TYPE_WEBHOST_ADVANCED, TYPE_FREE_WEBHOST, TYPE_SITEBUILDER, TYPE_FORSALE, TYPE_RESELLER_STOREFRONT, TYPE_PARK_BOT
  
  nameservers List Optional
  
  The nameservers.
  
  Show Properties
  
  server_name String Optional
  
  The name of the nameserver.
  
  ip_list Array Optional
  
  The IP list of the nameserver.
  
  with_ads String Optional
  
  The status of the ads.
  
  forward_to String Optional
  
  The forward to.
  
  forward_type String Optional
  
  The forward type.
  
  website_title String Optional
  
  The title of the website.
  
  email_forward_type Enum Optional
  
  The email forwarding settings.
  Supported valuesMTYPE_NONE, MTYPE_FORWARD, MTYPE_MX
  
  mail_exchanges List Optional
  
  The mail exchanges.
  
  Show Properties
  
  host String Optional
  
  Mail host, only used when forward type is mx, only used when "forward_type" is "mx".
  
  distance String Optional
  
  Distance is the highest priority, only used when "forward_type" is "mx".
  
  email_alias_list List Optional
  
  The email alias list.
  
  Show Properties
  
  username String Optional
  
  The user name of the email alias, only used when "forward_type" is "forward".
  
  to_email String Optional
  
  The email address of the email alias, only used when "forward_type" is "forward".
  
  dns_main_list List Optional
  
  The dns main list.
  
  Show Properties
  
  record_type Enum Optional
  
  The type of the record.
  Supported valuesA, AAAA, CNAME, ANAME, FORWARD, TXT, SRV, MX, STEALTH, EMAIL, CAA
  
  record_value1 String Optional
  
  The value of the record.
  
  record_value2 String Optional
  
  The second value of the record.
  
  dns_sub_list List Optional
  
  The dns sub list.
  
  Show Properties
  
  sub_host String Optional
  
  The subhost of the DNS record.
  
  record_type Enum Optional
  
  The record type of the DNS record.
  Supported valuesA, AAAA, CNAME, ANAME, FORWARD, TXT, SRV, MX, STEALTH, EMAIL, CAA
  
  record_value1 String Optional
  
  The value of the DNS record.
  
  record_value2 String Optional
  
  The second value of the DNS record.
  
  ttl String Optional
  
  The time to live.
- total_spending String
  
  The total spending of the account.
- price_level String
  
  The price level of the account.
- account_balance String
  
  The current account balance of the account.
- balance_list List
  The default of the account balance in currency.
  
  Show Properties
  
  currency String Optional
  
  The currency of the balance.
  
  amount String Optional
  
  The amount of the balance.

Api Request and Header

GET https://api.dynadot.com/restful/v1/accounts/info

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

X-Signature: {signature}

Response

{

code: "Integer",
message: "String",
data: {
- account_info: {
  - username: "String",
  - forum_name: "String",
  - avatar_url: "String",
  - account_contact: {
    - organization: "String",
    - name: "String",
    - email: "String",
    - phone_number: "String",
    - phone_cc: "String",
    - fax_number: "String",
    - fax_cc: "String",
    - address1: "String",
    - address2: "String",
    - city: "String",
    - state: "String",
    - zip: "String",
    - country: "String"
    },
  - customer_since: "Long",
  - account_lock: "String",
  - custom_time_zone: "String",
  - default_registrant_contact_id: "Integer",
  - default_admin_contact_id: "Integer",
  - default_technical_contact_id: "Integer",
  - default_billing_contact_id: "Integer",
  - default_name_server_settings: {
    - type: "String",
    - with_ads: "String",
    - forward_to: "String",
    - forward_type: "String",
    - website_title: "String",
    - ttl: "String",
    - email_forwarding: {
      - type: "String"
      }
    },
  - total_spending: "String",
  - price_level: "String",
  - account_balance: "String",
  - balance_list: [
    1. {
      - currency: "String",
      - amount: "String"
      }
    ]
  }
}

}

SET_DEFAULT_NAMESERVERS Command

Support multi-thread

Support API Sandbox

Require X-Signature

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

Request Parameters Expand All

nameserver_list List

The list of nameservers you want to set.

Result Parameters Expand All

nameserver_list List
The list of nameserver you want to set.
Show Properties
- server_name String
  
  The name of the nameserver.
- ip_list Array
  
  The IP list of the nameserver.

Api Request and Header

PUT https://api.dynadot.com/restful/v1/accounts/default_nameservers

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

X-Signature: {signature}

Request Body

{

nameserver_list: [
1. "String"
1 item]

}

Response

{

code: "Integer",
message: "String",
data: {
- name_servers: [
  1. {
    - server_name: "String"
    }
  ]
}

}

SET_DEFAULT_DOMAIN_FORWARDING Command

Support multi-thread

Support API Sandbox

Require X-Signature

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

Request Parameters Expand All

forward_url String

The URL you want your domain to forward to. Please note that the parameter must be encoded so that the API call is interpreted properly.
is_temporary Boolean Optional

Whether the forwarding is temporary or permanent. If set to true, the forwarding will be removed after the first request is forwarded.

Api Request and Header

PUT https://api.dynadot.com/restful/v1/accounts/default_domain_forwarding

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

X-Signature: {signature}

Request Body

{

forward_url: "String",
is_temporary: false

}

Response

{

code: "Integer",
message: "String"

}

SET_DEFAULT_STEALTH_FORWARDING Command

Support multi-thread

Support API Sandbox

Require X-Signature

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

Request Parameters Expand All

stealth_url String

The URL you want to set as the default stealth URL.
stealth_title String Optional

The title of the page that the domain will forward to.

Api Request and Header

PUT https://api.dynadot.com/restful/v1/accounts/default_stealth_forwarding

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

X-Signature: {signature}

Request Body

{

stealth_url: "String",
stealth_title: "String"

}

Response

{

code: "Integer",
message: "String"

}

SET_DEFAULT_EMAIL_FORWARDING Command

Support multi-thread

Support API Sandbox

Require X-Signature

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

Request Parameters Expand All

email_forward_type Enum

The type of email forwarding you want to set.
Supported valuesMTYPE_NONE, MTYPE_FORWARD, MTYPE_MX
email_alias_list List Optional
The email alias list you want to set.
Show Properties
- username String Optional
  
  The user name of the email alias, only used when "forward_type" is "forward".
- to_email String Optional
  
  The email address of the email alias, only used when "forward_type" is "forward".
mail_exchange_list List Optional
The mail exchange list you want to set.
Show Properties
- host String Optional
  
  Mail host, only used when forward type is mx, only used when "forward_type" is "mx".
- distance String Optional
  
  Distance is the highest priority, only used when "forward_type" is "mx".

Api Request and Header

PUT https://api.dynadot.com/restful/v1/accounts/default_email_forwarding

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

X-Signature: {signature}

Request Body

{

email_forward_type: "String",
email_alias_list: [
1. {
  - username: "String",
  - to_email: "String"
  2 items}
1 item],
mail_exchange_list: [
1. {
  - host: "String",
  - distance: "String"
  2 items}
1 item]

}

Response

{

code: "Integer",
message: "String"

}

SET_DEFAULT_CONTACTS Command

Support multi-thread

Support API Sandbox

Require X-Signature

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

Request Parameters Expand All

registrant_contact_id Integer

The ID of the contact you want to set as the default WHOIS registrant contact.
admin_contact_id Integer

The ID of the contact you want to set as the default WHOIS admin contact.
technical_contact_id Integer

The ID of the contact you want to set as the default WHOIS technical contact.
billing_contact_id Integer

The ID of the contact you want to set as the default WHOIS billing contact.

Api Request and Header

PUT https://api.dynadot.com/restful/v1/accounts/default_contacts

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

X-Signature: {signature}

Request Body

{

registrant_contact_id: 0,
admin_contact_id: 0,
technical_contact_id: 0,
billing_contact_id: 0

}

Response

{

code: "Integer",
message: "String"

}

SET_DEFAULT_PARKING Command

Support multi-thread

Support API Sandbox

Require X-Signature

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

Request Parameters Expand All

with_ads Boolean Optional

If you do not want a 3rd-party ads on the parking page.

Api Request and Header

PUT https://api.dynadot.com/restful/v1/accounts/default_parking

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

X-Signature: {signature}

Request Body

{

with_ads: false

}

Response

{

code: "Integer",
message: "String"

}

SET_DEFAULT_HOSTING Command

Support multi-thread

Support API Sandbox

Require X-Signature

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

Request Parameters Expand All

hosting_type Enum

The default hosting type of the account you want to set.
Supported valuesBASIC, ADVANCED

Api Request and Header

PUT https://api.dynadot.com/restful/v1/accounts/default_hosts

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

X-Signature: {signature}

Request Body

{

hosting_type: "String"

}

Response

{

code: "Integer",
message: "String"

}

SET_DEFAULT_RENEW_OPTION Command

Support multi-thread

Support API Sandbox

Require X-Signature

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

Request Parameters Expand All

renew_option Enum

The renew option you want to set.
Supported valuesRESET, AUTO, DONOT

Api Request and Header

PUT https://api.dynadot.com/restful/v1/accounts/default_renew_option

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

X-Signature: {signature}

Request Body

{

renew_option: "String"

}

Response

{

code: "Integer",
message: "String"

}

CLEAR_DEFAULT_SETTING Command

Support multi-thread

Support API Sandbox

Require X-Signature

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

Request Parameters Expand All

service_type Enum

The service type for the default account setting you wish to reset.
Supported valuesFORWARD, STEALTH, EMAIL_FORWARDING, DNS, NAMESERVERS

Api Request and Header

PUT https://api.dynadot.com/restful/v1/accounts/clear_default_setting

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

X-Signature: {signature}

Request Body

{

service_type: "String"

}

Response

{

code: "Integer",
message: "String"

}

SET_DEFAULT_DNS Command

Support multi-thread

Support API Sandbox

Require X-Signature

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

Request Parameters Expand All

dns_main_list List
List of main DNS records, max 20.
Show Properties
- record_type Enum Optional
  
  The type of the record.
  Supported valuesA, AAAA, CNAME, ANAME, FORWARD, TXT, SRV, MX, STEALTH, EMAIL, CAA
- record_value1 String Optional
  
  The value of the record.
- record_value2 String Optional
  
  The second value of the record.
sub_list List Optional
List of sub DNS records, max 100.
Show Properties
- sub_host String Optional
  
  The subhost of the DNS record.
- record_type Enum Optional
  
  The record type of the DNS record.
  Supported valuesA, AAAA, CNAME, ANAME, FORWARD, TXT, SRV, MX, STEALTH, EMAIL, CAA
- record_value1 String Optional
  
  The value of the DNS record.
- record_value2 String Optional
  
  The second value of the DNS record.
ttl Long Optional

Time to live for DNS records, default is 86400.
add_dns_to_current_setting Boolean Optional

Add DNS records to current settings, default is false.

Api Request and Header

PUT https://api.dynadot.com/restful/v1/default_records

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

X-Signature: {signature}

Request Body

{

dns_main_list: [
1. {
  - record_type: "String",
  - record_value1: "String",
  - record_value2: "String"
  3 items}
1 item],
sub_list: [
1. {
  - sub_host: "String",
  - record_type: "String",
  - record_value1: "String",
  - record_value2: "String"
  4 items}
1 item],
ttl: 0,
add_dns_to_current_setting: false

}

Response

{

code: "Integer",
message: "String"

}

FOLDER_LIST Command

Support multi-thread

Support API Sandbox

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

Request Parameters Expand All

Result Parameters Expand All

folder_list List
The list of folders.
Show Properties
- folder_id String
  
  The ID of the folder.
- folder_name String
  
  The name of the folder.
- default_whois_enable_status String
  
  The default whois enable status.
- default_registrant_id String
  
  The default registrant ID.
- default_admin_id String
  
  The default admin ID.
- default_technical_id String
  
  The default technical ID.
- default_billing_id String
  
  The default billing ID.
- default_name_server_enable_status String
  
  The default name server enable status.
- default_name_server_setting Object
  The default name server setting.
  
  Show Properties
  
  glue_type Enum Optional
  
  The type of the nameserver.
  Supported valuesTYPE_NULL, TYPE_PARK, TYPE_DNS, TYPE_USER, TYPE_FORWARD, TYPE_STEALTH, TYPE_WEBHOST_BASIC, TYPE_DYNASITE, TYPE_WEBHOST_ADVANCED, TYPE_FREE_WEBHOST, TYPE_SITEBUILDER, TYPE_FORSALE, TYPE_RESELLER_STOREFRONT, TYPE_PARK_BOT
  
  nameservers List Optional
  
  The nameservers.
  
  Show Properties
  
  server_name String Optional
  
  The name of the nameserver.
  
  ip_list Array Optional
  
  The IP list of the nameserver.
  
  with_ads String Optional
  
  The status of the ads.
  
  forward_to String Optional
  
  The forward to.
  
  forward_type String Optional
  
  The forward type.
  
  website_title String Optional
  
  The title of the website.
  
  email_forward_type Enum Optional
  
  The email forwarding settings.
  Supported valuesMTYPE_NONE, MTYPE_FORWARD, MTYPE_MX
  
  mail_exchanges List Optional
  
  The mail exchanges.
  
  Show Properties
  
  host String Optional
  
  Mail host, only used when forward type is mx, only used when "forward_type" is "mx".
  
  distance String Optional
  
  Distance is the highest priority, only used when "forward_type" is "mx".
  
  email_alias_list List Optional
  
  The email alias list.
  
  Show Properties
  
  username String Optional
  
  The user name of the email alias, only used when "forward_type" is "forward".
  
  to_email String Optional
  
  The email address of the email alias, only used when "forward_type" is "forward".
  
  dns_main_list List Optional
  
  The dns main list.
  
  Show Properties
  
  record_type Enum Optional
  
  The type of the record.
  Supported valuesA, AAAA, CNAME, ANAME, FORWARD, TXT, SRV, MX, STEALTH, EMAIL, CAA
  
  record_value1 String Optional
  
  The value of the record.
  
  record_value2 String Optional
  
  The second value of the record.
  
  dns_sub_list List Optional
  
  The dns sub list.
  
  Show Properties
  
  sub_host String Optional
  
  The subhost of the DNS record.
  
  record_type Enum Optional
  
  The record type of the DNS record.
  Supported valuesA, AAAA, CNAME, ANAME, FORWARD, TXT, SRV, MX, STEALTH, EMAIL, CAA
  
  record_value1 String Optional
  
  The value of the DNS record.
  
  record_value2 String Optional
  
  The second value of the DNS record.
  
  ttl String Optional
  
  The time to live.
- default_renew_option_enable_status String
  
  The default renew option enable status.
- default_renew_option String
  
  The default renew option.
- default_transfer_lock_enable_status String
  
  The default transfer lock enable status.
- default_lock_status String
  
  The default lock status.

Api Request and Header

GET https://api.dynadot.com/restful/v1/folders

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

Response

{

code: "Integer",
message: "String",
data: {
- folder_list: [
  1. {
    - folder_id: "Integer",
    - folder_name: "String",
    - default_whois: {
      - default_whois_enable_status: "String",
      - default_registrant: {
        contact_id: "Integer"
        },
      - default_admin: {
        contact_id: "Integer"
        },
      - default_technical: {
        contact_id: "Integer"
        },
      - default_billing: {
        contact_id: "Integer"
        }
      },
    - default_nameservers: {
      - default_name_server_enable_status: "String",
      - name_server_settings: {
        type: "String",
        with_ads: "String"
        }
      },
    - default_renew_option: {
      - default_renew_option_enable_status: "String",
      - renew_option: "String"
      },
    - default_transfer_lock: {
      - default_transfer_lock_enable_status: "String",
      - lock_status: "String"
      }
    }
  ]
}

}

FOLDER_CREATE Command

Support multi-thread

Support API Sandbox

Require X-Signature

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

Request Parameters Expand All

folder_name String

The name of the folder that you wish to create.

Result Parameters Expand All

folder_name String

The name of the folder you created.
folder_id int

The ID of the folder you created.

Api Request and Header

POST https://api.dynadot.com/restful/v1/folders

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

X-Signature: {signature}

Request Body

{

folder_name: "String"

}

Response

{

code: "Integer",
message: "String",
data: {
- folder_id: "Integer",
- folder_name: "String"
}

}

FOLDER_DELETE Command

Support multi-thread

Support API Sandbox

Require X-Signature

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

Request Parameters Expand All

Api Request and Header

DELETE https://api.dynadot.com/restful/v1/folders/{folder_name}

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

X-Signature: {signature}

Response

{

code: "Integer",
message: "String"

}

FOLDER_SET_NAME Command

Support multi-thread

Support API Sandbox

Require X-Signature

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

Request Parameters Expand All

new_folder_name String

The new name for the folder you wish to configure.

Api Request and Header

PUT https://api.dynadot.com/restful/v1/folders/{folder_name}/name

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

X-Signature: {signature}

Request Body

{

new_folder_name: "String"

}

Response

{

code: "Integer",
message: "String"

}

FOLDER_SET_DNS Command

Support multi-thread

Support API Sandbox

Require X-Signature

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

Request Parameters Expand All

dns_main_list List
The DNS main-records that you wish to configure for the DNS records.
Show Properties
- record_type Enum Optional
  
  The type of the record.
  Supported valuesA, AAAA, CNAME, ANAME, FORWARD, TXT, SRV, MX, STEALTH, EMAIL, CAA
- record_value1 String Optional
  
  The value of the record.
- record_value2 String Optional
  
  The second value of the record.
dns_sub_list List Optional
The DNS sub-records that you wish to configure for the DNS records.
Show Properties
- sub_host String Optional
  
  The subhost of the DNS record.
- record_type Enum Optional
  
  The record type of the DNS record.
  Supported valuesA, AAAA, CNAME, ANAME, FORWARD, TXT, SRV, MX, STEALTH, EMAIL, CAA
- record_value1 String Optional
  
  The value of the DNS record.
- record_value2 String Optional
  
  The second value of the DNS record.
ttl String Optional

The TTL("Time To Live") of you wish to configure DNS records.
apply_for_future_domain Boolean Optional

Apply this setting to domains that will be moved to this folder in the future.
sync_setting_to_existing_domains_in_this_folder Boolean Optional

Synchronize the settings of all domains in this folder.

Api Request and Header

PUT https://api.dynadot.com/restful/v1/folders/{folder_name}/records

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

X-Signature: {signature}

Request Body

{

dns_main_list: [
1. {
  - record_type: "String",
  - record_value1: "String",
  - record_value2: "String"
  3 items}
1 item],
dns_sub_list: [
1. {
  - sub_host: "String",
  - record_type: "String",
  - record_value1: "String",
  - record_value2: "String"
  4 items}
1 item],
ttl: "String",
apply_for_future_domain: false,
sync_setting_to_existing_domains_in_this_folder: false

}

Response

{

code: "Integer",
message: "String"

}

FOLDER_SET_NAMESERVER Command

Support multi-thread

Support API Sandbox

Require X-Signature

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

Request Parameters Expand All

folder_nameserver_list List

The list of nameservers you wish to configure.
apply_for_future_domain Boolean Optional

Apply this setting to domains that will be moved to this folder in the future.
sync_setting_to_existing_domains_in_this_folder Boolean Optional

Synchronize the settings of all domains in this folder.

Result Parameters Expand All

servers List
servers.
Show Properties
- server_name String
  
  The name of the nameserver.
- ip_list Array
  
  The IP list of the nameserver.

Api Request and Header

PUT https://api.dynadot.com/restful/v1/folders/{folder_name}/nameservers

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

X-Signature: {signature}

Request Body

{

folder_nameserver_list: [
1. "String"
1 item],
apply_for_future_domain: false,
sync_setting_to_existing_domains_in_this_folder: false

}

Response

{

code: "Integer",
message: "String",
data: {
- servers: [
  1. {
    - server_name: "String"
    }
  ]
}

}

FOLDER_SET_CONTACTS Command

Support multi-thread

Support API Sandbox

Require X-Signature

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

Request Parameters Expand All

reg_contact_id Integer

The ID of the contact you wish to configure as the registrant contact.
admin_contact_id Integer

The ID of the contact you wish to configure as the administrative contact.
tech_contact_id Integer

The ID of the contact you wish to configure as the technical contact.
bill_contact_id Integer

The ID of the contact you wish to configure as the billing contact.
apply_for_future_domain Boolean Optional

Apply this setting to domains that will be moved to this folder in the future.
sync_setting_to_existing_domains_in_this_folder Boolean Optional

Synchronize the settings of all domains in this folder.

Api Request and Header

PUT https://api.dynadot.com/restful/v1/folders/{folder_name}/contacts

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

X-Signature: {signature}

Request Body

{

reg_contact_id: 0,
admin_contact_id: 0,
tech_contact_id: 0,
bill_contact_id: 0,
apply_for_future_domain: false,
sync_setting_to_existing_domains_in_this_folder: false

}

Response

{

code: "Integer",
message: "String"

}

FOLDER_SET_PARKING Command

Support multi-thread

Support API Sandbox

Require X-Signature

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

Request Parameters Expand All

with_ads Boolean Optional

Determines whether to display advertisements on the parking page. Set to 'true' to enable ads, or 'false' to keep the page ad-free. Default is 'false'.
apply_for_future_domain Boolean Optional

Apply this setting to domains that will be moved to this folder in the future.
sync_setting_to_existing_domains_in_this_folder Boolean Optional

Synchronize the settings of all domains in this folder.

Api Request and Header

PUT https://api.dynadot.com/restful/v1/folders/{folder_name}/parking

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

X-Signature: {signature}

Request Body

{

with_ads: false,
apply_for_future_domain: false,
sync_setting_to_existing_domains_in_this_folder: false

}

Response

{

code: "Integer",
message: "String"

}

FOLDER_SET_DOMAIN_FORWARDING Command

Support multi-thread

Support API Sandbox

Require X-Signature

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

Request Parameters Expand All

forward_url String

The URL you want your domain to forward to. Please note that the parameter must be encoded so that the API call is interpreted properly.
is_temporary Boolean Optional

The forward status of your domain you want, default value is "true", if you wish to forward permanently, use this parameter with "false".
apply_for_future_domain Boolean Optional

Apply this setting to domains that will be moved to this folder in the future.
sync_setting_to_existing_domains_in_this_folder Boolean Optional

Synchronize the settings of all domains in this folder.

Api Request and Header

PUT https://api.dynadot.com/restful/v1/folders/{folder_name}/domain_forwarding

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

X-Signature: {signature}

Request Body

{

forward_url: "String",
is_temporary: false,
apply_for_future_domain: false,
sync_setting_to_existing_domains_in_this_folder: false

}

Response

{

code: "Integer",
message: "String"

}

FOLDER_SET_STEALTH_FORWARDING Command

Support multi-thread

Support API Sandbox

Require X-Signature

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

Request Parameters Expand All

stealth_url String

The URL you want your domain to forward to. Please note that the parameter must be encoded so that the API call is interpreted properly.
stealth_title String Optional

The title of the page that the domain will forward to.
apply_for_future_domain Boolean Optional

Apply this setting to domains that will be moved to this folder in the future.
sync_setting_to_existing_domains_in_this_folder Boolean Optional

Synchronize the settings of all domains in this folder.

Api Request and Header

PUT https://api.dynadot.com/restful/v1/folders/{folder_name}/stealth_forwarding

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

X-Signature: {signature}

Request Body

{

stealth_url: "String",
stealth_title: "String",
apply_for_future_domain: false,
sync_setting_to_existing_domains_in_this_folder: false

}

Response

{

code: "Integer",
message: "String"

}

FOLDER_SET_EMAIL_FORWARDING Command

Support multi-thread

Support API Sandbox

Require X-Signature

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

Request Parameters Expand All

email_forward_type Enum

The email forwarding type you wish to configure email forwarding, MTYPE_NONE: Do not forward email, MTYPE_FORWARD: Deliver email to another mail host, MTYPE_MX: Deliver email to another mail host (MX record).
Supported valuesMTYPE_NONE, MTYPE_FORWARD, MTYPE_MX
email_alias_list List Optional
The email alias list you wish to configure email forwarding.
Show Properties
- username String Optional
  
  The user name of the email alias, only used when "forward_type" is "forward".
- to_email String Optional
  
  The email address of the email alias, only used when "forward_type" is "forward".
mail_exchange_list List Optional
The mail exchange list you wish to configure email forwarding.
Show Properties
- host String Optional
  
  Mail host, only used when forward type is mx, only used when "forward_type" is "mx".
- distance String Optional
  
  Distance is the highest priority, only used when "forward_type" is "mx".
apply_for_future_domain Boolean Optional

Apply this setting to domains that will be moved to this folder in the future.
sync_setting_to_existing_domains_in_this_folder Boolean Optional

Synchronize the settings of all domains in this folder.

Api Request and Header

PUT https://api.dynadot.com/restful/v1/folders/{folder_name}/email_forwarding

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

X-Signature: {signature}

Request Body

{

email_forward_type: "String",
email_alias_list: [
1. {
  - username: "String",
  - to_email: "String"
  2 items}
1 item],
mail_exchange_list: [
1. {
  - host: "String",
  - distance: "String"
  2 items}
1 item],
apply_for_future_domain: false,
sync_setting_to_existing_domains_in_this_folder: false

}

Response

{

code: "Integer",
message: "String"

}

FOLDER_SET_HOSTING Command

Support multi-thread

Support API Sandbox

Require X-Signature

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

Request Parameters Expand All

hosting_type Enum

The hosting type of the folder that you wish to set hosting.
Supported valuesBASIC, ADVANCED
apply_for_future_domain Boolean Optional

Apply this setting to domains that will be moved to this folder in the future.
sync_setting_to_existing_domains_in_this_folder Boolean Optional

Synchronize the settings of all domains in this folder.

Api Request and Header

PUT https://api.dynadot.com/restful/v1/folders/{folder_name}/hosts

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

X-Signature: {signature}

Request Body

{

hosting_type: "String",
apply_for_future_domain: false,
sync_setting_to_existing_domains_in_this_folder: false

}

Response

{

code: "Integer",
message: "String"

}

FOLDER_SET_RENEW_OPTION Command

Support multi-thread

Support API Sandbox

Require X-Signature

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

Request Parameters Expand All

renew_option Enum

The renew option you wish to configure.
Supported valuesRESET, AUTO, DONOT
apply_for_future_domain Boolean Optional

Apply this setting to domains that will be moved to this folder in the future.
sync_setting_to_existing_domains_in_this_folder Boolean Optional

Synchronize the settings of all domains in this folder.

Api Request and Header

PUT https://api.dynadot.com/restful/v1/folders/{folder_name}/renew_option

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

X-Signature: {signature}

Request Body

{

renew_option: "String",
apply_for_future_domain: false,
sync_setting_to_existing_domains_in_this_folder: false

}

Response

{

code: "Integer",
message: "String"

}

FOLDER_CLEAR_SETTING Command

Support multi-thread

Support API Sandbox

Require X-Signature

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

Request Parameters Expand All

service_type Enum

The service type you wish to clear the setting.
Supported valuesFORWARD, STEALTH, EMAIL_FORWARDING, DNS, NAMESERVERS

Api Request and Header

PUT https://api.dynadot.com/restful/v1/folders/{folder_name}/clear_setting

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

X-Signature: {signature}

Request Body

{

service_type: "String"

}

Response

{

code: "Integer",
message: "String"

}

ORDER_GET_STATUS Command

Support multi-thread

Support API Sandbox

Require X-Signature

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

Request Parameters Expand All

Result Parameters Expand All

order_id int

The id of the order to be queried.
order_status String

the status of the order.
order_status_list List
order status list.
Show Properties
- type String
  
  Order type.
- name String
  
  Order name.
- duration Integer
  
  Order duration.
- cost String
  
  Order cost.
- status String
  
  Order status.

Api Request and Header

GET https://api.dynadot.com/restful/v1/orders/{order_id}

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

X-Signature: {signature}

Response

{

code: "Integer",
message: "String",
data: {
- order_id: "Integer",
- order_status: "String",
- order_status_item_list: [
  1. {
    - item_type: "String",
    - item_domain: "String",
    - item_status: "String"
    }
  ]
}

}

ORDER_GET_HISTORY Command

Support multi-thread

Support API Sandbox

Require X-Signature

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

Request Parameters Expand All

domain_name_list Array Optional

When the type of searchType is DOMAIN, you need to enter the correct domain name.
order_id_list Array Optional

When the type of searchType is ORDER_ID, you need to enter the correct orderId.
search_type Enum

You can choose a value from the following list to represent.
Supported valuesDATE_RANGE, DOMAIN, ORDER_ID
start_time Long Optional

When the search type is DATE_RANGE, you need to enter the correct order start timestamp, enter a 13-digit numberand the start and end timestamp lengths need to be consistent.
end_time Long Optional

When the search type is DATE_RANGE, you need to enter the correct order start timestamp, enter a 13-digit numberand the start and end timestamp lengths need to be consistent.
payment_method Array Optional

When the type of searchType is DOMAIN, You can choose one or more payment types from the following list:PAYPAL, ACCOUNT_BALANCE, CREDIT_CARD. If not specified, all payment types will be selected by default.

Result Parameters Expand All

order_list List
The list of orders.
Show Properties
- order_id Integer
  
  The order ID.
- submitted_date Long
  
  The order date.
- currency String
  
  The currency.
- total_cost String
  
  The total amount.
- total_paid String
  
  The total paid.
- payment_method String
  
  The payment method.
- status String
  
  Contains the status of the order.
- order_item_list List
  The order item list.
  
  Show Properties
  
  type String
  
  Order type.
  
  name String
  
  Order name.
  
  duration Integer
  
  Order duration.
  
  cost String
  
  Order cost.
  
  status String
  
  Order status.

Api Request and Header

GET https://api.dynadot.com/restful/v1/orders

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

X-Signature: {signature}

Response

<?xml version="1.0" encoding="UTF-8"?> <Response> <Status> <Code>200</Code> <Message>Success</Message> </Status> <Data> <OrderList> <Order> <OrderId>123456</OrderId> <SubmittedTime>1743783677090</SubmittedTime> <Currency>USD</Currency> <PaymentMethod>Account Balance</PaymentMethod> <TotalCost>$8.00</TotalCost> <TotalPaid>$8.00</TotalPaid> <Status>Problem</Status> <OrderItem> <OrderItem> <Type>Domain Registration</Type> <Name>test.com</Name> <Duration>1</Duration> <Cost>2.99</Cost> <Status>Completed</Status> </OrderItem> <OrderItem> <Type>Domain Renewal</Type> <Name>test1.ac</Name> <Duration>1</Duration> <Cost>3.99</Cost> <Status>Completed</Status> </OrderItem> <OrderItem> <Type>Domain Transfer</Type> <Name>test2.de</Name> <Duration>1</Duration> <Cost>4.99</Cost> <Status>Completed</Status> </OrderItem> </OrderItem> </Order> <Order> <OrderId>123457</OrderId> <SubmittedTime>1743783677090</SubmittedTime> <Currency>EUR</Currency> <PaymentMethod>Paypal</PaymentMethod> <TotalCost>$100.00</TotalCost> <TotalPaid>$100.00</TotalPaid> <Status>Submitted</Status> <OrderItem> <OrderItem> <Type>Domain Registration</Type> <Name>test3.gg</Name> <Duration>1</Duration> <Cost>5.99</Cost> <Status>Completed</Status> </OrderItem> <OrderItem> <Type>Domain Renewal</Type> <Name>test4.uk</Name> <Duration>1</Duration> <Cost>6.99</Cost> <Status>Completed</Status> </OrderItem> <OrderItem> <Type>Domain Transfer</Type> <Name>test5.net</Name> <Duration>1</Duration> <Cost>7.99</Cost> <Status>Completed</Status> </OrderItem> </OrderItem> </Order> </OrderList> </Data> </Response>

{

code: "Integer",
message: "String",
data: {
- order_list: [
  1. {
    - order_id: "Integer",
    - submitted_time: "Long",
    - currency: "String",
    - payment_method: "String",
    - total_cost: "String",
    - total_paid: "String",
    - status: "String",
    - order_item: [
      1. {
        type: "String",
        name: "String",
        duration: "Integer",
        cost: "String",
        status: "String"
        }
      ]
    }
  ]
}

}

CANCEL_TRANSFER Command

Support multi-thread

Support API Sandbox

Require X-Signature

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

Request Parameters Expand All

domain_name String

your domain name.

Api Request and Header

POST https://api.dynadot.com/restful/v1/orders/{order_id}/cancel_transfer

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

X-Signature: {signature}

Request Body

{

domain_name: "String"

}

Response

{

code: "Integer",
message: "String"

}

AUTHORIZE_TRANSFER_AWAY Command

Support multi-thread

Support API Sandbox

Require X-Signature

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

Request Parameters Expand All

domain_name String

The domain name to authorize transfer away.
approve Boolean

Whether to approve the transfer away.

Api Request and Header

POST https://api.dynadot.com/restful/v1/orders/{order_id}/authorize_transfer_away

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

X-Signature: {signature}

Request Body

{

domain_name: "String",
approve: false

}

Response

{

code: "Integer",
message: "String"

}

SET_TRANSFER_AUTH_CODE Command

Support multi-thread

Support API Sandbox

Require X-Signature

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

Request Parameters Expand All

domain_name String

your domain name.
auth_code String

your transfer auth code.

Api Request and Header

POST https://api.dynadot.com/restful/v1/orders/{order_id}/update_transfer_auth_code

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

X-Signature: {signature}

Request Body

{

domain_name: "String",
auth_code: "String"

}

Response

{

code: "Integer",
message: "String"

}

ADD_NEW_LEAD Command

Support multi-thread

Support API Sandbox

Require X-Signature

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

Request Parameters Expand All

lead_type Enum

The lead type you want to set the lead for. Acceptable values are "buy_now", "make_offer".
Supported valuesBUY_NOW, MAKE_OFFER
domain_name String

The domain name you want to add lead for, only 1 domain can be entered per request.
price String

The price you want to set the lead for.
buyer_name String

The buyers' name.
buyer_email String

The buyers' email.

Api Request and Header

POST https://api.dynadot.com/restful/v1/aftermarkets/leads

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

X-Signature: {signature}

Request Body

{

lead_type: "String",
domain_name: "String",
price: "String",
buyer_name: "String",
buyer_email: "String"

}

Response

{

code: "Integer",
message: "String"

}

SET_FOR_SALE Command

Support multi-thread

Support API Sandbox

Require X-Signature

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

Request Parameters Expand All

for_sale_type Enum

The type of sale you want to set for the domain(s).
Supported valuesNOT_FOR_SALE, MARKETPLACE, AUCTION, PORTFOLIO_AUCTION
currency Enum Optional

The currency you want to set the domain(s) for sale in.
Supported valuesUSD, GBP, EUR, INR, PLN, ZAR, LTL, CNY, CAD, JPY, NZD, RUB, AUD, MXN, BRL, IDR, ARS, COP, DKK, RSD, HKD, CHF, AED, MYR, NGN, KES, CZK
listing_type Enum Optional

The type of listing you want to set the domain(s) for sale as.
Supported valuesBUY_NOW, MAKE_OFFER, BUY_NOW_AND_MAKE_OFFER
price String Optional

The price you want to set the domain(s) for sale at.
minimum_offer_price String Optional

The minimum offer price you want to set the domain(s) for sale at.
installment String Optional

The installment plan you want to set the domain(s) for sale with.
maximum_installments Integer Optional

The maximum number of installments you want to set the domain(s) for sale with.
category Enum Optional

The category you want to set the domain(s) for sale in.
Supported valuesADVERTISING, AUTOMOTIVE, BUSINESS, CARERRS_EDUCATION, CONSUMER_GOODS, ENTERTAINMENT, FASHION, FINANCE, GAMBLING, HEALTH, INTERNET, OTHER, PLACES, REAL_ESTATE, SCIENCE, SOCIETY, SPORTS, TECHNOLOGY, UNCATEGORIZED, ADULT, HOME, AI, AEROSPACE, AGENCY, AGRICULTURE_COMPANY, ANALYTICS, ALCOHOL, BABIES_KIDS, BIOTECH, CLEAN_ENERGY, CLEANING, COMMUNITY, CONSTRUCTION_ORGANIZATION, CRYPTOCURRENCY_BLOCKCHAIN, DATING_RELATIONSHIP, DAYCARE, DENTAL, DRONE, ECOMMERCE, FOOD_DRINK, FURNITURE, GAMES, INSURANCE, INTERIOR_DESIGN, LEGAL_LAW, MOTIVATIONAL, MANUFACTURING, MARKETING, MEDICAL, METAVERSE, MOVIES_TV, MUSIC_AUDIO, NEWS_MEDIA, NFT, OUTDOOR, PAYMENT, PETS, POLITICS, PROPERTY_MANAGEMENT, RECRUITMENT_STAFFING, SERVICES, SECURITY, SOCIAL, TRANSPORTATION, TRAVEL, VIDEO_BOOKS_MAGAZINES, VITUAL_REALITY, WEBSITE_DESIGN
sub_category Enum Optional

The sub-category you want to set the domain(s) for sale in.
Supported valuesMARKETING, RETAIL, SALES, CARS_TRUCKS, ENTHUSIASTS, MOTORSPORTS, INVESTMENT, LAW, MONEY, PROFESSIONS, SERVICES, APPAREL, ELECTRONICS, GAMES, POP_CULTURE, CASINO, SPORTS, FITNESS, MEDICINE, BLOGS, ECOMMERCE, DOMAINS, WEB_DESIGN, WEB_HOSTING, AFRICA, ASIA, EUROPE, NORTH_AMERICA, SOUTH_AMERICA, CULTURE, NEWS, POLITICS, RELIGION, LEISURE_ACTIVITIES, PROFESSIONAL, COMPUTERS
description String Optional

The description you want to set the domain(s) for sale with.
allow_seo_index Boolean Optional

Whether you want to allow search engine indexing for the domain(s).

Api Request and Header

PUT https://api.dynadot.com/restful/v1/aftermarkets/domains/{domain_name}/for_sales

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

X-Signature: {signature}

Request Body

{

for_sale_type: "String",
currency: "String",
listing_type: "String",
price: "String",
minimum_offer_price: "String",
installment: "String",
maximum_installments: 0,
category: "String",
sub_category: "String",
description: "String",
allow_seo_index: false

}

Response

{

code: "Integer",
message: "String"

}

SET_OTHER_PLATFORM_CONFIRM_ACTION Command

Support multi-thread

Support API Sandbox

Require X-Signature

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

Request Parameters Expand All

action Enum

The action to be performed.
Supported valuesCONFIRM, DELETE
platform_type Enum

The type of the platform type.
Supported valuesAFTERNIC, SEDO

Api Request and Header

POST https://api.dynadot.com/restful/v1/aftermarket/domains/{domain_name}/opt_in_fast_transfer

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

X-Signature: {signature}

Request Body

{

action: "String",
platform_type: "String"

}

Response

{

code: "Integer",
message: "String"

}

GET_LISTINGS Command

Support multi-thread

Support API Sandbox

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

Request Parameters Expand All

currency Enum

The currency you would like to use for the search.
Supported valuesUSD, GBP, EUR, INR, PLN, ZAR, LTL, CNY, CAD, JPY, NZD, RUB, AUD, MXN, BRL, IDR, ARS, COP, DKK, RSD, HKD, CHF, AED, MYR, NGN, KES, CZK
exclude_pending_sale Boolean Optional

Exclude pending sale.
show_other_registrar Boolean Optional

Show other registrar.

Result Parameters Expand All

listing_item_list List
List of listings.
Show Properties
- listing_id Integer
  
  The unique identifier of the listing.
- domain String
  
  The domain name.
- price String
  
  The price of the domain.
- in_bound_links Integer
  
  The number of inbound links to the domain.
- age Integer
  
  The age of the domain.
- is_pending_sale_locked Boolean
  
  Whether the domain is locked for pending sale.

Api Request and Header

GET https://api.dynadot.com/restful/v1/aftermarket/listings

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

Response

{

code: "Integer",
message: "String",
data: {
- listing_item_list: [
  1. {
    - listing_id: "Integer",
    - domain: "String",
    - price: "String",
    - in_bound_links: "Integer",
    - age: "Integer",
    - is_pending_sale_locked: "String"
    }
  ]
}

}

GET_LISTING_ITEM Command

Support multi-thread

Support API Sandbox

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

Request Parameters Expand All

currency Enum

The currency you would like to use for the search.
Supported valuesUSD, GBP, EUR, INR, PLN, ZAR, LTL, CNY, CAD, JPY, NZD, RUB, AUD, MXN, BRL, IDR, ARS, COP, DKK, RSD, HKD, CHF, AED, MYR, NGN, KES, CZK

Result Parameters Expand All

listing_item Object
The listing item.
Show Properties
- listing_id Integer
  
  The unique identifier of the listing.
- domain String
  
  The domain name.
- price String
  
  The price of the domain.
- in_bound_links Integer
  
  The number of inbound links to the domain.
- age Integer
  
  The age of the domain.
- is_pending_sale_locked Boolean
  
  Whether the domain is locked for pending sale.

Api Request and Header

GET https://api.dynadot.com/restful/v1/aftermarket/listings/{domain_name}

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

Response

{

code: "Integer",
message: "String",
data: {
- listing_item: {
  - listing_id: "Integer",
  - domain: "String",
  - price: "String",
  - in_bound_links: "Integer",
  - age: "Integer",
  - is_pending_sale_locked: "String"
  }
}

}

BUY_IT_NOW Command

Support multi-thread

Support API Sandbox

Require X-Signature

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

Request Parameters Expand All

currency Enum Optional

The currency you would like to use for the purchase.
Supported valuesUSD, GBP, EUR, INR, PLN, ZAR, LTL, CNY, CAD, JPY, NZD, RUB, AUD, MXN, BRL, IDR, ARS, COP, DKK, RSD, HKD, CHF, AED, MYR, NGN, KES, CZK

Api Request and Header

POST https://api.dynadot.com/restful/v1/aftermarket/listings/{domain_name}/buy_it_now

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

X-Signature: {signature}

Request Body

{

currency: "String"

}

Response

{

code: "Integer",
message: "String"

}

BUY_EXPIRED_CLOSEOUT_DOMAIN Command

Support multi-thread

Support API Sandbox

Require X-Signature

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

Request Parameters Expand All

currency Enum Optional

The currency you would like to use for the purchase.
Supported valuesUSD, GBP, EUR, INR, PLN, ZAR, LTL, CNY, CAD, JPY, NZD, RUB, AUD, MXN, BRL, IDR, ARS, COP, DKK, RSD, HKD, CHF, AED, MYR, NGN, KES, CZK

Api Request and Header

POST https://api.dynadot.com/restful/v1/aftermarket/expired_closeouts/{domain_name}/purchase

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

X-Signature: {signature}

Request Body

{

currency: "String"

}

Response

{

code: "Integer",
message: "String"

}

BACKORDER_REQUEST_LIST Command

Support multi-thread

Support API Sandbox

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

Request Parameters Expand All

start_time Long

The start time of the backorder request, in milliseconds since epoch.
end_time Long

The end time of the backorder request, in milliseconds since epoch.

Result Parameters Expand All

backorder_request_list List
The list of backorder requests.
Show Properties
- domain_name String
  
  The domain name of the backorder request.
- cut_off_time Long
  
  The cut-off time of the backorder request, in milliseconds since epoch.
- backorder_request_status String
  
  The status of the backorder request.

Api Request and Header

GET https://api.dynadot.com/restful/v1/aftermarket/backorders/requests

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

Response

{

code: "Integer",
message: "String",
data: {
- backorder_request_list: [
  1. {
    - domain_name: "String",
    - cut_off_time: "Long",
    - backorder_request_status: "String"
    }
  ]
}

}

ADD_BACKORDER_REQUEST Command

Support multi-thread

Support API Sandbox

Require X-Signature

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

Request Parameters Expand All

Api Request and Header

POST https://api.dynadot.com/restful/v1/aftermarket/backorders/requests/{domain_name}

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

X-Signature: {signature}

Request Body

{}

Response

{

code: "Integer",
message: "String"

}

DELETE_BACKORDER_REQUEST Command

Support multi-thread

Support API Sandbox

Require X-Signature

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

Request Parameters Expand All

Api Request and Header

DELETE https://api.dynadot.com/restful/v1/aftermarket/backorders/requests/{domain_name}

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

X-Signature: {signature}

Response

{

code: "Integer",
message: "String"

}

PLACE_AUCTION_BID Command

Support multi-thread

Support API Sandbox

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

Request Parameters Expand All

currency Enum

The currency to use for the bid.
Supported valuesUSD, GBP, EUR, INR, PLN, ZAR, LTL, CNY, CAD, JPY, NZD, RUB, AUD, MXN, BRL, IDR, ARS, COP, DKK, RSD, HKD, CHF, AED, MYR, NGN, KES, CZK
bid_amount Double

The amount to bid.
is_backorder_auction Boolean Optional

Whether to backorder the domain.

Result Parameters Expand All

auction_item_details Object
The auction item details.
Show Properties
- auction_id Integer
  
  The auction ID.
- domain_name String
  
  The domain name.
- utf_domain String
  
  The domain name in UTF-8.
- is_idn Boolean
  
  Whether the domain is an IDN.
- auction_type Enum
  
  The type of auction.
  Supported valuesExpired, User, Portfolio, Backorder, Registrar, Registry, RegistryExpired, PremiumUser
- current_bid_price String
  
  The current bid price.
- accepted_bid_price String
  
  The accepted bid price.
- currency Enum
  
  The currency of the auction.
  Supported valuesUSD, GBP, EUR, INR, PLN, ZAR, LTL, CNY, CAD, JPY, NZD, RUB, AUD, MXN, BRL, IDR, ARS, COP, DKK, RSD, HKD, CHF, AED, MYR, NGN, KES, CZK
- is_high_bidder Boolean
  
  Whether the user is the high bidder.
- bids Integer
  
  The number of bids.
- bidders Integer
  
  The number of bidders.
- auction_status_id Integer
  
  The auction status ID.
- time_left String
  
  The time left in the auction.
- start_time String
  
  The start time of the auction.
- start_time_stamp Long
  
  The start time of the auction in milliseconds since the epoch.
- end_time String
  
  The end time of the auction.
- end_time_stamp Long
  
  The end time of the auction in milliseconds since the epoch.
- revenue String
  
  The revenue.
- visitors Long
  
  The number of visitors.
- links String
  
  The links.
- age Integer
  
  The age of the domain.
- estibot_appraisal String
  
  The Estibot appraisal.
- auction_ended Boolean
  
  Whether the auction has ended.
- customer_bided Boolean
  
  Whether the customer bided.
- customer_bid String
  
  The customer bid.
- customer_proxy_bid String
  
  The customer proxy bid.
- is_premium Boolean
  
  Whether the domain is premium.
- renewal_price String
  
  The renewal price.
- revenue_currency String
  
  The revenue currency.
- start_price String
  
  The start price.
- bid_history List
  The bid history.
  
  Show Properties
  
  bidder_name String Optional
  
  The bidder name.
  
  bid_price String Optional
  
  The bid price.
  
  currency String Optional
  
  The currency.
  
  timestamp Long Optional
  
  The timestamp.
  
  bid_status String Optional
  
  The bid status.
  
  is_proxy_auto_bid Boolean Optional
  
  Whether the bid is a proxy auto bid.
- auction_status_name String
  
  The auction status name.

Api Request and Header

POST https://api.dynadot.com/restful/v1/aftermarket/auctions/bids/{domain_name}

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

Request Body

{

currency: "String",
bid_amount: 0,
is_backorder_auction: false

}

Response

GET_AUCTION_BIDS Command

Support multi-thread

Support API Sandbox

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

Request Parameters Expand All

currency Enum

The currency you would like to use for the purchase.
Supported valuesUSD, GBP, EUR, INR, PLN, ZAR, LTL, CNY, CAD, JPY, NZD, RUB, AUD, MXN, BRL, IDR, ARS, COP, DKK, RSD, HKD, CHF, AED, MYR, NGN, KES, CZK

Result Parameters Expand All

auction_bid_details List
The list of auction bids.
Show Properties
- bid_id int
  
  The bid ID.
- auction_id int
  
  The auction ID.
- account_id String
  
  The account ID.
- domain String
  
  The domain name.
- domain_utf String
  
  The domain name in UTF-8.
- is_idn_domain boolean
  
  Whether the domain is an IDN domain.
- auction_type Enum
  
  The auction type.
  Supported valuesExpired, User, Portfolio, Backorder, Registrar, Registry, RegistryExpired, PremiumUser
- current_bid String
  
  The current bid.
- proxy_bid String
  
  The proxy bid amount.
- bid_status String
  
  The bid status.
- is_high_bidder boolean
  
  Whether the bidder is the high bidder.
- active_bidders int
  
  The number of active bidders.
- time_left String
  
  The time left.
- end_time String
  
  The end time.
- end_time_stamp Long
  
  The end time stamp.

Api Request and Header

GET https://api.dynadot.com/restful/v1/aftermarket/auctions/bids

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

Response

{

code: "Integer",
message: "String",
data: {
- auction_bid_details: [
  1. {
    - bid_id: "Integer",
    - auction_id: "Integer",
    - account_id: "String",
    - domain: "String",
    - domain_utf: "String",
    - is_idn_domain: "String",
    - auction_type: "String",
    - current_bid: "String",
    - proxy_bid: "String",
    - bid_status: "String",
    - is_high_bidder: "String",
    - active_bidders: "Integer",
    - time_left: "String",
    - end_time: "String",
    - end_time_stamp: "Long"
    }
  ]
}

}

GET_CLOSED_AUCTIONS Command

Support multi-thread

Support API Sandbox

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

Request Parameters Expand All

currency Enum

The currency you would like to use for the purchase.
Supported valuesUSD, GBP, EUR, INR, PLN, ZAR, LTL, CNY, CAD, JPY, NZD, RUB, AUD, MXN, BRL, IDR, ARS, COP, DKK, RSD, HKD, CHF, AED, MYR, NGN, KES, CZK
start_time Long

The timestamp indicating the start time of the search period.
end_time Long

The timestamp indicating the end time of the search period.

Result Parameters Expand All

closed_auction_list List
List of closed auctions.
Show Properties
- auction_id Integer
  
  The unique identifier of the auction.
- domain String
  
  The domain name of the auction.
- auction_status Enum
  
  The status of the auction.
  Supported valuesIN_PROGRESS, CLOSED_BY_USER, CLOSED_BY_ADMIN, CLOSED_BY_RENEWAL, COMPLETE, CLOSED_BY_TRANSFER_AWAY, REVERSED, IN_FUTURE, CLOSED_BY_REGISTRAR, CLOSED_BY_NOT_MEET_RESERVE, CLOSED_BY_REGISTRY
- bid_price String
  
  The bid price of the auction.
- currency Enum
  
  The currency of the auction.
  Supported valuesUSD, GBP, EUR, INR, PLN, ZAR, LTL, CNY, CAD, JPY, NZD, RUB, AUD, MXN, BRL, IDR, ARS, COP, DKK, RSD, HKD, CHF, AED, MYR, NGN, KES, CZK
- bids Integer
  
  The number of bids on the auction.
- end_time String
  
  The end time of the auction.
- end_timestamp Long
  
  The end timestamp of the auction.
- auction_won_status String
  
  The status of the auction won.
- your_high_bid Double
  
  Your high bid.
- your_proxy_bid Double
  
  Your proxy bid.

Api Request and Header

GET https://api.dynadot.com/restful/v1/aftermarket/auctions/closed

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

Response

{

code: "Integer",
message: "String",
data: {
- ClosedAuctionList: [
  1. {
    - auction_id: "Integer",
    - domain: "String",
    - auction_status: "String",
    - bid_price: "String",
    - bids: "String",
    - end_time: "String",
    - end_timestamp: "Long",
    - auction_won_status: "String",
    - your_high_bid: "String",
    - your_proxy_bid: "String"
    }
  ]
}

}

GET_OPEN_AUCTIONS Command

Support multi-thread

Support API Sandbox

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

Request Parameters Expand All

currency Enum

Currency of the auction.
Supported valuesUSD, GBP, EUR, INR, PLN, ZAR, LTL, CNY, CAD, JPY, NZD, RUB, AUD, MXN, BRL, IDR, ARS, COP, DKK, RSD, HKD, CHF, AED, MYR, NGN, KES, CZK
auction_types Array Optional

Auction types to get.

Result Parameters Expand All

auction_detail_info_list List
List of auction details.
Show Properties
- auction_id int
  
  Auction ID.
- domain_name_utf String
  
  Domain name in UTF-8.
- current_price String
  
  Current price.
- currency String
  
  Currency of the current price.
- bids int
  
  Number of bids.
- end_time_utc String
  
  End time in UTC.
- end_time_stamp long
  
  End time in timestamp.
- revenue String
  
  Revenue.
- revenue_currency String
  
  Currency of the revenue.
- visitors long
  
  Number of visitors.
- inbound_links int
  
  Number of inbound links.
- age int
  
  Age.

Api Request and Header

GET https://api.dynadot.com/restful/v1/aftermarket/auctions/open

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

Response

{

code: "Integer",
message: "String",
data: {
- auction_detail_info_list: [
  1. {
    - auction_id: "Integer",
    - domain_name_utf: "String",
    - current_price: "String",
    - currency: "String",
    - bids: "Integer",
    - end_time_utc: "String",
    - end_time_stamp: "Integer",
    - revenue: "String",
    - revenue_currency: "String",
    - visitors: "Integer",
    - inbound_links: "Integer",
    - age: "Integer"
    }
  ]
}

}

GET_AUCTION_DETAILS Command

Support multi-thread

Support API Sandbox

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

Request Parameters Expand All

currency Enum

The currency you would like to use for the purchase.
Supported valuesUSD, GBP, EUR, INR, PLN, ZAR, LTL, CNY, CAD, JPY, NZD, RUB, AUD, MXN, BRL, IDR, ARS, COP, DKK, RSD, HKD, CHF, AED, MYR, NGN, KES, CZK

Result Parameters Expand All

api_auction_item_details Object
auction item detail.
Show Properties
- auction_id Integer
  
  The auction ID.
- domain_name String
  
  The domain name.
- utf_domain String
  
  The domain name in UTF-8.
- is_idn Boolean
  
  Whether the domain is an IDN.
- auction_type Enum
  
  The type of auction.
  Supported valuesExpired, User, Portfolio, Backorder, Registrar, Registry, RegistryExpired, PremiumUser
- current_bid_price String
  
  The current bid price.
- accepted_bid_price String
  
  The accepted bid price.
- currency Enum
  
  The currency of the auction.
  Supported valuesUSD, GBP, EUR, INR, PLN, ZAR, LTL, CNY, CAD, JPY, NZD, RUB, AUD, MXN, BRL, IDR, ARS, COP, DKK, RSD, HKD, CHF, AED, MYR, NGN, KES, CZK
- is_high_bidder Boolean
  
  Whether the user is the high bidder.
- bids Integer
  
  The number of bids.
- bidders Integer
  
  The number of bidders.
- auction_status_id Integer
  
  The auction status ID.
- time_left String
  
  The time left in the auction.
- start_time String
  
  The start time of the auction.
- start_time_stamp Long
  
  The start time of the auction in milliseconds since the epoch.
- end_time String
  
  The end time of the auction.
- end_time_stamp Long
  
  The end time of the auction in milliseconds since the epoch.
- revenue String
  
  The revenue.
- visitors Long
  
  The number of visitors.
- links String
  
  The links.
- age Integer
  
  The age of the domain.
- estibot_appraisal String
  
  The Estibot appraisal.
- auction_ended Boolean
  
  Whether the auction has ended.
- customer_bided Boolean
  
  Whether the customer bided.
- customer_bid String
  
  The customer bid.
- customer_proxy_bid String
  
  The customer proxy bid.
- is_premium Boolean
  
  Whether the domain is premium.
- renewal_price String
  
  The renewal price.
- revenue_currency String
  
  The revenue currency.
- start_price String
  
  The start price.
- bid_history List
  The bid history.
  
  Show Properties
  
  bidder_name String Optional
  
  The bidder name.
  
  bid_price String Optional
  
  The bid price.
  
  currency String Optional
  
  The currency.
  
  timestamp Long Optional
  
  The timestamp.
  
  bid_status String Optional
  
  The bid status.
  
  is_proxy_auto_bid Boolean Optional
  
  Whether the bid is a proxy auto bid.
- auction_status_name String
  
  The auction status name.

Api Request and Header

GET https://api.dynadot.com/restful/v1/aftermarket/auctions/{domain_name}

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

Response

<?xml version="1.0" encoding="UTF-8"?> <Response> <Status> <Code>200</Code> <Message>Success</Message> </Status> <Data> <AuctionItemDetails> <AuctionId>12345</AuctionId> <DomainName>example.com</DomainName> <UtfName>example.com</UtfName> <IsIdn>false</IsIdn> <AuctionType>Registrar</AuctionType> <CurrentBidPrice>150.00</CurrentBidPrice> <AcceptedBidPrice>150.00</AcceptedBidPrice> <Currency>USD</Currency> <IsHighBidder>true</IsHighBidder> <Bids>2</Bids> <Bidders>2</Bidders> <AuctionStatusId>1</AuctionStatusId> <TimeLeft>1 hour</TimeLeft> <StartTime>2023-10-01T12:00:00Z</StartTime> <EndTime>2023-10-02T12:00:00Z</EndTime> <Revenue>10.00</Revenue> <Visitors>100</Visitors> <Links>https://example.com/auction/12345</Links> <Age>5</Age> <EstibotAppraisal>High</EstibotAppraisal> <AuctionEnded>false</AuctionEnded> <CustomerBided>true</CustomerBided> <CustomerBid>150.00</CustomerBid> <CustomerProxyBid>160.00</CustomerProxyBid> <IsPremium>true</IsPremium> <RenewalPrice>20.00</RenewalPrice> <RevenueCurrency>USD</RevenueCurrency> <StartPrice>100.00</StartPrice> <BidHistoryItemList> <BidHistoryItem> <BidderName>Bidder1</BidderName> <BidPrice>100.00</BidPrice> <Currency>USD</Currency> <Timestamp>1743783677097</Timestamp> <BidStatus>Active</BidStatus> <IsProxyAutoBid>true</IsProxyAutoBid> </BidHistoryItem> <BidHistoryItem> <BidderName>Bidder2</BidderName> <BidPrice>150.00</BidPrice> <Currency>USD</Currency> <Timestamp>1743783676097</Timestamp> <BidStatus>Active</BidStatus> <IsProxyAutoBid>false</IsProxyAutoBid> </BidHistoryItem> </BidHistoryItemList> <AuctionStatusName>Active</AuctionStatusName> </AuctionItemDetails> </Data> </Response>

{

code: "Integer",
message: "String",
data: {
- auction_item_details: {
  - auction_id: "Integer",
  - domain_name: "String",
  - utf_name: "String",
  - is_idn: "String",
  - auction_type: "String",
  - current_bid_price: "String",
  - accepted_bid_price: "String",
  - currency: "String",
  - is_high_bidder: "String",
  - bids: "Integer",
  - bidders: "Integer",
  - auction_status_id: "Integer",
  - time_left: "String",
  - start_time: "String",
  - end_time: "String",
  - revenue: "String",
  - visitors: "Long",
  - links: "String",
  - age: "Integer",
  - estibot_appraisal: "String",
  - auction_ended: "String",
  - customer_bided: "String",
  - customer_bid: "String",
  - customer_proxy_bid: "String",
  - is_premium: "String",
  - renewal_price: "String",
  - revenue_currency: "String",
  - start_price: "String",
  - bid_history_item_list: [
    1. {
      - bidder_name: "String",
      - bid_price: "String",
      - currency: "String",
      - timestamp: "Long",
      - bid_status: "String",
      - is_proxy_auto_bid: "String"
      }
    ],
  - auction_status_name: "String"
  }
}

}

GET_WHOIS_STATS Command

Support multi-thread

Support API Sandbox

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

Request Parameters Expand All

domain_name String

The domain name to get whois stats for.
date_type Enum

The date type to get whois stats for.
Supported valuesLAST_7_DAYS, LAST_30_DAYS, CURRENT_YEAR, LAST_YEAR

Result Parameters Expand All

stats List
The whois stats for the domain.
Show Properties
- date String
  
  The date of the whois stats.
- count long
  
  The count of the whois stats.

Api Request and Header

GET https://api.dynadot.com/restful/v1/aftermarket/whois_stats

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

Response

{

code: "Integer",
message: "String",
data: {
- stats: [
  1. {
    - date: "String",
    - count: "Long"
    }
  ]
}

}

GET_EXPIRED_CLOSEOUT_DOMAINS Command

Support multi-thread

Support API Sandbox

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

Request Parameters Expand All

Result Parameters Expand All

closeout_item_list List
The list of closeout items.
Show Properties
- domain_name String
  
  Domain name.
- domain_name_utf String
  
  Domain name in UTF-8.
- current_price String
  
  Current price.
- is_idn boolean
  
  Is IDN.
- end_time_stamp long
  
  End time stamp.
- renewal_price String
  
  Renewal price.
- expired_revenue String
  
  Expired revenue.
- estibot_appraisal String
  
  Estibot appraisal.
- inbound_links int
  
  Inbound links.
- monthly_visitors int
  
  Monthly visitors.
- currency String
  
  Currency.
- is_active boolean
  
  Is active.
- auction_id int
  
  Auction ID.
- closeout_id int
  
  Closeout ID.
- age int
  
  Age.
- current_price_usd long
  
  Current price USD.
- price_usd long
  
  Price USD.
- seller_price long
  
  Seller price.
- registrar_account_id String
  
  Registrar account ID.
- order_status int
  
  Order status.

Api Request and Header

GET https://api.dynadot.com/restful/v1/aftermarket/get_expired_closeout_domain/{currency}/{page_num}/{page_size}

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

Response

{

code: "Integer",
message: "String",
data: {
- closeout_item_list: [
  1. {
    - domain_name: "String",
    - domain_name_utf: "String",
    - current_price: "String",
    - is_idn: "String",
    - end_time_stamp: "Long",
    - renewal_price: "String",
    - expired_revenue: "String",
    - estibot_appraisal: "String",
    - inbound_links: "Integer",
    - monthly_visitors: "Integer",
    - currency: "String",
    - is_active: "String",
    - auction_id: "Integer",
    - closeout_id: "Integer",
    - age: "Integer",
    - current_price_usd: "Long",
    - price_usd: "Long",
    - seller_price: "Long",
    - registrar_account_id: "String",
    - order_status: "Integer"
    }
  ]
}

}

GET_SITE_BUILDER Command

Support multi-thread

Support API Sandbox

Require X-Signature

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

Request Parameters Expand All

Result Parameters Expand All

Object
.
Show Properties
- domain_name String
  
  The name server, example: ns1.domain.com.
- template Enum
  
  The template of the sitebuilder.
  Supported valuesCOMPASS, SKYLINE, COASTAL, PIECES, COLUMN, SIMPLES, SERENDIPITY, MERIDIAN, JOURNEY, ARCHITECTURE, STUDIO, LINK, COMMON, NO
- plan Enum
  
  The plan of sitebuilder.
  Supported valuesFREE, BASIC, PRO, BUSINESS, PAID
- is_published boolean
  
  If the sitebuilder has been published.

Api Request and Header

GET https://api.dynadot.com/restful/v1/sitebuilders/{domain_name}

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

X-Signature: {signature}

Response

{

code: "Integer",
message: "String",
data: {
- sitebuilder: {
  - domain_name: "String",
  - template: "String",
  - plan: "String",
  - isPublished: "String"
  }
}

}

LIST_SITE_BUILDER Command

Support multi-thread

Support API Sandbox

Require X-Signature

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

Request Parameters Expand All

Result Parameters Expand All

sitebuilder_list List
The list of sitebuilder.
Show Properties
- domain_name String
  
  The name server, example: ns1.domain.com.
- template Enum
  
  The template of the sitebuilder.
  Supported valuesCOMPASS, SKYLINE, COASTAL, PIECES, COLUMN, SIMPLES, SERENDIPITY, MERIDIAN, JOURNEY, ARCHITECTURE, STUDIO, LINK, COMMON, NO
- plan Enum
  
  The plan of sitebuilder.
  Supported valuesFREE, BASIC, PRO, BUSINESS, PAID
- is_published boolean
  
  If the sitebuilder has been published.

Api Request and Header

GET https://api.dynadot.com/restful/v1/sitebuilders

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

X-Signature: {signature}

Response

{

code: "Integer",
message: "String",
data: {
- sitebuilder_list: [
  1. {
    - domain_name: "String",
    - template: "String",
    - plan: "String",
    - isPublished: "String"
    }
  ]
}

}

CREATE_SITE_BUILDER Command

Support multi-thread

Support API Sandbox

Require X-Signature

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

Request Parameters Expand All

set_domain_dns Boolean Optional

Whether to set the domain's DNS to the site builder's DNS.

Result Parameters Expand All

domain_name String

The domain name of the site builder.
server_url String

The URL of the site builder.

Api Request and Header

POST https://api.dynadot.com/restful/v1/sitebuilders/{domain_name}

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

X-Signature: {signature}

Request Body

{

set_domain_dns: false

}

Response

{

code: "Integer",
message: "String",
data: {
- domain_name: "String",
- server_url: "String"
}

}

UPGRADE_SITE_BUILDER Command

Support multi-thread

Support API Sandbox

Require X-Signature

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

Request Parameters Expand All

set_domain_dns Boolean Optional

Whether to set the domain's DNS to the site builder's DNS.

Result Parameters Expand All

domain_name String

The domain name of the site builder.
server_url String

The URL of the site builder.

Api Request and Header

POST https://api.dynadot.com/restful/v1/sitebuilders/{domain_name}/upgrade

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

X-Signature: {signature}

Request Body

{

set_domain_dns: false

}

Response

{

code: "Integer",
message: "String",
data: {
- domain_name: "String",
- server_url: "String"
}

}

LIST_COUPONS Command

Support multi-thread

Support API Sandbox

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

Request Parameters Expand All

coupon_type Enum

The list of coupon types to get.
Supported valuesDOMAIN, RENEW, TRANSFER, RESTORE, PRIVACY, EMAIL_WEBHOST, VPS_WEBHOST, SSL, SITEBUILDER, SITEBUILDER_RENEW, EMAIL_WEBHOST_DOMAIN_BUNDLE, VPS_WEBHOST_DOMAIN_BUNDLE, SITEBUILDER_DOMAIN_BUNDLE, ORDER_LEVEL_DISCOUNT, DOMAIN_REGISTRATION_MATCH, DOMAIN_BUNDLE, DROP_CATCH, LOGO_BUILDER, RENEW_RESTORE

Result Parameters Expand All

coupons List
The list of coupons.
Show Properties
- code String
  
  Coupon code.
- description String
  
  Coupon description.
- coupon_category Enum
  
  Coupon category.
  Supported valuesDOMAIN_COUPONS, HOSTING_SSL_COUPONS, BUNDLE_COUPONS, OTHER
- discount_type Enum
  
  Discount type.
  Supported valuesSALE, DOLLAR_AMOUNT_OFF, PERCENTAGE_OFF, USE_RENEW_PRICE
- discount_info Object
  Discount information.
  
  Show Properties
  
  USD String Optional
  
  The discount amount in USD.
  
  GBP String Optional
  
  The discount amount in GBP.
  
  EUR String Optional
  
  The discount amount in EUR.
  
  JPY String Optional
  
  The discount amount in JPY.
  
  CAD String Optional
  
  The discount amount in CAD.
  
  CNY String Optional
  
  The discount amount in CNY.
  
  AUD String Optional
  
  The discount amount in AUD.
  
  MXN String Optional
  
  The discount amount in MXN.
  
  BRL String Optional
  
  The discount amount in BRL.
  
  IDR String Optional
  
  The discount amount in IDR.
  
  percentage String Optional
  
  The discount percentage.
- restriction Object
  Coupon restriction.
  
  Show Properties
  
  price_levels List Optional
  
  the price levels that the coupon is applicable to.
  
  uses_per_account int Optional
  
  the number of times a coupon can be used per account.
  
  uses_system_wide int Optional
  
  the number of times a coupon can be used system wide.
  
  uses_per_order int Optional
  
  the number of times a coupon can be used per order.
  
  uses_per_day int Optional
  
  the number of times a coupon can be used per day.
  
  items_per_account int Optional
  
  the number of items a coupon can be used on per account.
  
  items_per_order int Optional
  
  the number of items a coupon can be used on per order.
  
  items_per_ip int Optional
  
  the number of items a coupon can be used on per IP.
  
  domain_duration_min int Optional
  
  the minimum domain duration for the coupon.
  
  domain_duration_max int Optional
  
  the maximum domain duration for the coupon.
  
  idn_restriction String Optional
  
  the IDN restriction for the coupon.
- tlds List
  
  TLDs.
- start_date long
  
  Start date.
- end_date long
  
  End date.
- currencies List
  
  Currencies.

Api Request and Header

GET https://api.dynadot.com/restful/v1/orders/coupons

Content-Type: application/json

Accept: application/json

Authorization: Bearer API_KEY

Response

<?xml version="1.0" encoding="UTF-8"?> <Response> <Status> <Code>200</Code> <Message>Success</Message> </Status> <Data> <Coupons> <Coupon> <Code>code</Code> <Description>description</Description> <CouponType>DOMAIN_COUPONS</CouponType> <DiscountType>PERCENTAGE_OFF</DiscountType> <DiscountInfo> <Percentage>10.0%</Percentage> </DiscountInfo> <Restriction> <PriceLevels> <PriceLevel>RETAIL</PriceLevel> <PriceLevel>BULK</PriceLevel> <PriceLevel>BULK1</PriceLevel> </PriceLevels> <UsesPerAccount>1</UsesPerAccount> <UsesSystemWide>1</UsesSystemWide> <UsesPerIp>1</UsesPerIp> <ItemsPerAccount>1</ItemsPerAccount> <ItemsSystemWide>1</ItemsSystemWide> <ItemsPerOrder>1</ItemsPerOrder> <ItemsPerDay>1</ItemsPerDay> <DomainDurationMin>1</DomainDurationMin> <DomainDurationMax>1</DomainDurationMax> <IdnRestriction>IDN</IdnRestriction> <Tlds> <Tld>com</Tld> <Tld>net</Tld> <Tld>org</Tld> </Tlds> <Currencies> <Currency>USD</Currency> <Currency>GBP</Currency> <Currency>EUR</Currency> <Currency>INR</Currency> <Currency>CAD</Currency> <Currency>CNY</Currency> <Currency>AUD</Currency> <Currency>MXN</Currency> <Currency>BRL</Currency> <Currency>IDR</Currency> </Currencies> </Restriction> <StartDate>0</StartDate> <EndDate>0</EndDate> </Coupon> <Coupon> <Code>code</Code> <Description>description</Description> <CouponType>BUNDLE_COUPONS</CouponType> <DiscountType>SALE</DiscountType> <DiscountInfo> <USD>$0.00</USD> <GBP>�0.00</GBP> <EUR>�0.00</EUR> <INR>�0.00</INR> <CAD>C$0.00</CAD> <CNY>�0.00</CNY> <AUD>A$0.00</AUD> <MXN>Mex$0.00</MXN> <BRL>R$0.00</BRL> <IDR>Rp0.00</IDR> </DiscountInfo> <Restriction> <PriceLevels> <PriceLevel>RETAIL</PriceLevel> <PriceLevel>BULK</PriceLevel> <PriceLevel>BULK1</PriceLevel> </PriceLevels> <UsesPerAccount>1</UsesPerAccount> <UsesSystemWide>1</UsesSystemWide> <UsesPerIp>1</UsesPerIp> <ItemsPerAccount>1</ItemsPerAccount> <ItemsSystemWide>1</ItemsSystemWide> <ItemsPerOrder>1</ItemsPerOrder> <ItemsPerDay>1</ItemsPerDay> <DomainDurationMin>1</DomainDurationMin> <DomainDurationMax>1</DomainDurationMax> <IdnRestriction>IDN</IdnRestriction> <Tlds> <Tld>com</Tld> <Tld>net</Tld> <Tld>org</Tld> </Tlds> <Currencies> <Currency>USD</Currency> <Currency>GBP</Currency> <Currency>EUR</Currency> <Currency>INR</Currency> <Currency>CAD</Currency> <Currency>CNY</Currency> <Currency>AUD</Currency> <Currency>MXN</Currency> <Currency>BRL</Currency> <Currency>IDR</Currency> </Currencies> </Restriction> <StartDate>0</StartDate> <EndDate>0</EndDate> </Coupon> </Coupons> </Data> </Response>

{

code: "Integer",
message: "String",
data: {
- coupons: [
  1. {
    - code: "String",
    - description: "String",
    - coupon_type: "String",
    - discount_type: "String",
    - discount_info: {
      - Percentage: "String"
      },
    - restriction: {
      - price_levels: [
        "String"
        ],
      - uses_per_account: "Integer",
      - uses_system_wide: "Integer",
      - uses_per_ip: "Integer",
      - items_per_account: "Integer",
      - items_system_wide: "Integer",
      - items_per_order: "Integer",
      - items_per_day: "Integer",
      - domain_duration_min: "Integer",
      - domain_duration_max: "Integer",
      - idn_restriction: "String",
      - tlds: [
        "String"
        ],
      - currencies: [
        "String"
        ]
      },
    - start_date: "Long",
    - end_date: "Long"
    }
  ]
}

}

Privacy Notice