Dynadot API

https://www.dynadot.com/domain/api-document
Admin
The Dynadot API provides a RESTful interface for seamless integration with systems, enabling domain...
Tokens:147,273
Snippets:746
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### API Request and Header Example

Source: https://www.dynadot.com/domain/api-document

Example of the HTTP GET request structure for fetching aftermarket listings.

```http
GET https://api.dynadot.com/restful/v2/aftermarket/listings
Accept:  application/json
Authorization:  Bearer API_KEY
```

--------------------------------

### Signature Construction Example

Source: https://www.dynadot.com/domain/api-document

Example values and the resulting string to sign.

```text
webhookKey = "your_webhook_key"
fullPathAndQuery = "/v2/some/endpoint?param=value"
xRequestId = "unique-request-id"
requestBody = "{\"key\":\"value\"}"


stringToSign = "your_webhook_key\n/v2/some/endpoint?param=value\nunique-request-id\n{\"key\":\"value\"}"
```

--------------------------------

### Signature String Example

Source: https://www.dynadot.com/domain/api-document

Concrete example of the string to sign using provided variables.

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


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

--------------------------------

### Nameserver List API Request

Source: https://www.dynadot.com/domain/api-document

Example request for retrieving the list of nameservers using the GET method.

```HTTP
GET https://api.dynadot.com/restful/v2/nameservers
Accept:  application/json
Authorization:  Bearer API_KEY
X-Signature:  {signature}
```

--------------------------------

### Create Folder Response Example

Source: https://www.dynadot.com/domain/api-document

Example response returned upon successful folder creation.

```json
{
  * code: 200,
  * message: "Success",
  * data: {
    * folder_id: 123,
    * folder_name: "TestFolderName"
2 items}

}
```

--------------------------------

### API Request and Header

Source: https://www.dynadot.com/domain/api-document

Example of a GET request to the orders endpoint with required authentication headers.

```http
GET https://api.dynadot.com/restful/v2/orders
Accept:  application/json
Authorization:  Bearer API_KEY
X-Signature:  {signature}
```

--------------------------------

### API URL Example

Source: https://www.dynadot.com/domain/api-document

Example of a full URL structure for a domain search request.

```text
https://api.dynadot.com/restful/v2/domains/{domain_name}/search
```

--------------------------------

### Order GET Status Request Structure

Source: https://www.dynadot.com/domain/api-document

Example of a GET request to the orders endpoint with required headers.

```http
GET https://api.dynadot.com/restful/v2/orders/{order_id}
Accept:  application/json
Authorization:  Bearer API_KEY
X-Signature:  {signature}
```

--------------------------------

### HTTP 400 Bad Request Example

Source: https://www.dynadot.com/domain/api-document

Example response for a missing domain_name parameter.

```json
{
  * code: 400,
  * message: "Bad Request",
  * error: {
    * description: "The required parameter domain_name is missing."
1 item}

}
```

--------------------------------

### API Response Examples

Source: https://www.dynadot.com/domain/api-document

Examples of successful and error responses returned by the API.

```JSON
{
  * code: 200,
  * message: "Success",
  * data: {
    * email_hosting: {
      * username: "root",
      * expiration: 11000,
      * disk_max: 0,
      * disk_used: 0,
      * disk_used_email: 0,
      * bandwidth_max: 0,
      * bandwidth_used: 0,
      * new_email_hosting: "Yes"
8 items}
1 item}

}
```

```JSON
{
  * code: 400,
  * message: "Bad Request",
  * error: {
    * description: "The [domain_name] must be in ascii characters"
1 item}

}
```

```JSON
{
  * code: 401,
  * message: "Unauthorized",
  * error: {
    * description: "The provided API key is invalid, expired, or missing. Please verify your key is correct and active."
1 item}

}
```

```JSON
{
  * code: 429,
  * message: "Too many requests",
  * error: {
    * description: "Too many requests. Rate limit exceeded. Please try again after 60 seconds."
1 item}

}
```

```JSON
{
  * code: 500,
  * message: "Internal Server Error",
  * error: {
    * description: "Unexpected internal server error , please contact our support."
1 item}

}
```

--------------------------------

### Success and Error Response Examples

Source: https://www.dynadot.com/domain/api-document

JSON response examples for successful requests and specific error scenarios for the pending push accept endpoint.

```json
{
  * code: 200,
  * message: "Success",
  * data: {
    * domain_name_list: [
      1. "example.com"
1 item]
1 item}

}
```

```json
{
  * code: "Integer",
  * message: "String",
  * data: {
    * domain_name_list: [
      1. "String"
1 item]
1 item}

}
```

```json
{
  * code: 400,
  * message: "Bad Request",
  * error: {
    * description: "The required parameter domain_name is missing."
1 item}

}
```

```json
{
  * code: 404,
  * message: "Not Found",
  * error: {
    * description: "No push orders found"
1 item}

}
```

--------------------------------

### Get Contact LT Setting Request

Source: https://www.dynadot.com/domain/api-document

Example request for retrieving LT contact settings.

```http
GET https://api.dynadot.com/restful/v2/contacts/{contact_id}/get_lt_setting
Accept:  application/json
Authorization:  Bearer API_KEY
X-Signature:  {signature}
```

```json
{
  * code: 200,
  * message: "Success",
  * data: {
    * contact_extension: {
      * tld: "lt",
      * organization_code: "test_organization_code"
2 items}
1 item}

}
```

--------------------------------

### Webhook Request and Response JSON Examples

Source: https://www.dynadot.com/domain/api-document

Example structures for incoming webhook event payloads and outgoing status responses.

```json
{
  "event": "domain_registration",
  "event_id": 12345,
  "timestamp": 1700000000000,
  "data": {
    "DomainName": "example.com",
    "RegistrationDate": "2022-01-01",
    "ExpirationDate": "2023-01-01",
    "Registrant": {
      "Name": "JohnDoe",
      "Email": "john@dynadot.com",
      "Phone": "+1.1234567890"
    }
  }
}
```

```json
{
  "Status": "200"
}
```

--------------------------------

### API Request and Header

Source: https://www.dynadot.com/domain/api-document

Example of a GET request to the aftermarket auctions endpoint with required authorization headers.

```HTTP
GET https://api.dynadot.com/restful/v2/aftermarket/auctions/open
Accept:  application/json
Authorization:  Bearer API_KEY
```

--------------------------------

### Buy It Now API Request

Source: https://www.dynadot.com/domain/api-document

Example of the POST request structure for the buy_it_now endpoint.

```http
POST https://api.dynadot.com/restful/v2/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",
  * price_to_verify: 0

}
```

--------------------------------

### Nameserver Response Examples

Source: https://www.dynadot.com/domain/api-document

JSON response structures for nameserver retrieval.

```json
{
  * code: 200,
  * message: "Success",
  * data: {
    * nameserver: {
      * server_name: "ns1.testname.com",
      * ip_list: [
        1. "1.1.1.1",
        2. "2.2.2.2"
2 items]
2 items}
1 item}

}
```

```json
{
  * code: "Integer",
  * message: "String",
  * data: {
    * nameserver: {
      * server_name: "String",
      * ip_list: [
        1. "String"
1 item]
2 items}
1 item}

}
```

```json
{
  * code: 400,
  * message: "Bad Request",
  * error: {
    * description: "The required parameter {parameter} is missing."
1 item}

}
```

```json
{
  * code: "Integer",
  * message: "String",
  * error: {
    * description: "String"
1 item}

}
```

```json
{
  * code: 401,
  * message: "Unauthorized",
  * error: {
    * description: "The provided API key is invalid, expired, or missing. Please verify your key is correct and active."
1 item}

}
```

```json
{
  * code: "Integer",
  * message: "String",
  * error: {
    * description: "String"
1 item}

}
```

--------------------------------

### Response Structure Examples

Source: https://www.dynadot.com/domain/api-document

JSON response examples showing both a successful data payload and the expected data types for the response schema.

```json
{
  "code": 200,
  "message": "Success",
  "data": {
    "page": 1,
    "page_size": 10,
    "sort": "name_asc",
    "price_level": "Bulk",
    "currency": "USD",
    "show_multi_year_price": "Yes",
    "tld_price_list": [
      {
         "tld": "com",
         "usage": "COM",
         "price_unit": "(Price/1 year)",
         "all_years_register_price": [],
         "all_years_renew_price": [],
         "transfer_price": "--",
         "restore_price": "--",
         "grace_fee_price": "--",
         "support_privacy": "Yes",
         "grace_period_unit": "(Grace Period/days)",
         "renew_grace_period": "0-20 (variable)",
         "restore_period": "0-20 (variable)",
         "delete_grace_period": "0-20 (variable)",
         "is_idn": "Yes",
         "restriction": "--",
         "on_sale": "Yes",
         "delete_grace_fee": "$3.00",
         "delete_grace_max_rate": "10%",
         "delete_grace_current_rate": "10%",
         "max_duration": 10,
         "min_duration": 1
      }
    ]
  }
}
```

```json
{
  "code": "Integer",
  "message": "String",
  "data": {
    "page": "Integer",
    "page_size": "Integer",
    "sort": "String",
    "price_level": "String",
    "currency": "String",
    "show_multi_year_price": "String",
    "tld_price_list": [
      {
         "tld": "String",
         "usage": "String",
         "price_unit": "String",
         "all_years_register_price": [],
         "all_years_renew_price": [],
         "transfer_price": "String",
         "restore_price": "String",
         "grace_fee_price": "String",
         "support_privacy": "String",
         "grace_period_unit": "String",
         "renew_grace_period": "String",
         "restore_period": "String",
         "delete_grace_period": "String",
         "is_idn": "String",
         "restriction": "String",
         "on_sale": "String",
         "delete_grace_fee": "String",
         "delete_grace_max_rate": "String",
         "delete_grace_current_rate": "String",
         "max_duration": "Integer",
         "min_duration": "Integer"
      }
    ]
  }
}
```

--------------------------------

### API Request and Header

Source: https://www.dynadot.com/domain/api-document

Example of a GET request to retrieve HK contact settings, including required headers.

```HTTP
GET https://api.dynadot.com/restful/v2/contacts/{contact_id}/get_hk_setting
Accept:  application/json
Authorization:  Bearer API_KEY
X-Signature:  {signature}
```

--------------------------------

### Get Music Setting API Request

Source: https://www.dynadot.com/domain/api-document

Example request for retrieving music settings for a specific contact ID.

```HTTP
GET https://api.dynadot.com/restful/v2/contacts/{contact_id}/get_music_setting
Accept:  application/json
Authorization:  Bearer API_KEY
X-Signature:  {signature}
```

--------------------------------

### Nameserver Registration Request

Source: https://www.dynadot.com/domain/api-document

Example of the POST request structure for registering a nameserver.

```http
POST https://api.dynadot.com/restful/v2/nameservers/register
Content-Type:  application/json
Accept:  application/json
Authorization:  Bearer API_KEY
X-Signature:  {signature}
Request Body
{
  * nameserver: {
    * server_name: "String",
    * ip: "String"
2 items}

}
```

--------------------------------

### Accept Header Example

Source: https://www.dynadot.com/domain/api-document

Header used to define the expected response format.

```text
Accept: application/json
```

--------------------------------

### Set Contact IT Setting Request

Source: https://www.dynadot.com/domain/api-document

Example request for updating IT contact settings.

```http
PUT https://api.dynadot.com/restful/v2/contacts/{contact_id}/set_it_setting
Content-Type:  application/json
Accept:  application/json
Authorization:  Bearer API_KEY
X-Signature:  {signature}
```

```json
{
  * contact_extension: {
    * country_of_citizenship: "String",
    * codice_doc_number: "String",
    * tld: "String"
3 items}

}
```

--------------------------------

### HTTP 409 Conflict Example

Source: https://www.dynadot.com/domain/api-document

Example response for expired or expiring domains requiring renewal.

```json
{
  * code: 409,
  * message: "Conflict",
  * error: {
    * description: "Domain expired or expiring, please renew the domain first."
1 item}

}
```

--------------------------------

### API Request and Header Example

Source: https://www.dynadot.com/domain/api-document

The standard HTTP GET request format for the express pay link endpoint, requiring an API key and X-Signature header.

```http
GET https://api.dynadot.com/restful/v2/aftermarket/pay_links/{domain_name}
Accept:  application/json
Authorization:  Bearer API_KEY
X-Signature:  {signature}
```

--------------------------------

### X-Signature Header Example

Source: https://www.dynadot.com/domain/api-document

Placeholder for the final HMAC-SHA256 signature header.

```text
X-Signature: {HMAC-SHA256 Signature}
```

--------------------------------

### HTTP 500 Internal Server Error Example

Source: https://www.dynadot.com/domain/api-document

Example response for server-side failures during sitebuilder creation.

```json
{
  * code: 500,
  * message: "Internal Server Error",
  * error: {
    * description: "Fail creating sitebuilder, please contact customer support."
1 item}

}
```

--------------------------------

### Response Structures

Source: https://www.dynadot.com/domain/api-document

Examples of successful and error response formats.

```JSON
{
  * code: 200,
  * message: "Success",
  * data: {
    * auction_id: 1001
1 item}

}
```

```JSON
{
  * code: "Integer",
  * message: "String",
  * data: {
    * auction_id: "Integer"
1 item}

}
```

```JSON
{
  * code: 400,
  * message: "Bad Request",
  * error: {
    * description: "The required parameter {parameter} is missing."
1 item}

}
```

```JSON
{
  * code: "Integer",
  * message: "String",
  * error: {
    * description: "String"
1 item}

}
```

```JSON
{
  * code: 401,
  * message: "Unauthorized",
  * error: {
    * description: "The provided API key is invalid, expired, or missing. Please verify your key is correct and active."
1 item}

}
```

```JSON
{
  * code: "Integer",
  * message: "String",
  * error: {
    * description: "String"
1 item}

}
```

--------------------------------

### Success and Error Response Examples

Source: https://www.dynadot.com/domain/api-document

Specific response examples for the DELETE_EXPRESS_PAY_LINK command.

```json
{
  * code: 200,
  * message: "Success"

}
```

```json
{
  * code: 400,
  * message: "Bad Request",
  * error: {
    * description: "The required parameter domain_name is missing."
1 item}

}
```

--------------------------------

### API Request and Response Body Examples

Source: https://www.dynadot.com/domain/api-document

Examples of JSON structures for API request payloads and standard response formats.

```json
{
  * domainName: "domain.com",
  * showPrice: "yes",
  * currency: "USD"

}
```

```json
{
  * Code: 200,
  * Message: "Success",
  * Data: {}

}
```

--------------------------------

### Response Structures

Source: https://www.dynadot.com/domain/api-document

Examples of success and error response formats.

```json
{
  * code: 200,
  * message: "Success",
  * data: {
    * contact_id: 10001
1 item}

}
```

```json
{
  * code: "Integer",
  * message: "String",
  * data: {
    * contact_id: "Integer"
1 item}

}
```

```json
{
  * code: 400,
  * message: "Bad Request",
  * error: {
    * description: "The required parameter contact_id is missing."
1 item}

}
```

```json
{
  * code: "Integer",
  * message: "String",
  * error: {
    * description: "String"
1 item}

}
```

```json
{
  * code: 401,
  * message: "Unauthorized",
  * error: {
    * description: "The provided API key is invalid, expired, or missing. Please verify your key is correct and active."
1 item}

}
```

```json
{
  * code: "Integer",
  * message: "String",
  * error: {
    * description: "String"
1 item}

}
```

```json
{
  * code: 404,
  * message: "Not Found",
  * error: {
    * description: "Can not find the account."
1 item}

}
```

```json
{
  * code: "Integer",
  * message: "String",
  * error: {
    * description: "String"
1 item}

}
```

```json
{
  * code: 409,
  * message: "Conflict",
  * error: {
    * description: "The contact is already registered and cannot be associated with an external contact."
1 item}

}
```

```json
{
  * code: "Integer",
  * message: "String",
  * error: {
    * description: "String"
1 item}

}
```

```json
{
  * code: 429,
  * message: "Too many requests",
  * error: {
    * description: "Too many requests. Rate limit exceeded. Please try again after 60 seconds."
1 item}

}
```

```json
{
  * code: "Integer",
  * message: "String",
  * error: {
    * description: "String"
1 item}

}
```

```json
{
  * code: 500,
  * message: "Internal Server Error",
  * error: {
    * description: "The connection to the central registry is busy. Please try again later"
1 item}

}
```

```json
{
  * code: "Integer",
  * message: "String",
  * error: {
    * description: "String"
1 item}

}
```

--------------------------------

### Response Structure Examples

Source: https://www.dynadot.com/domain/api-document

JSON response structures for successful and error scenarios.

```json
{
  * code: 200,
  * message: "Success",
  * data: {
    * glue_info: {
      * glue_type: "REGISTRAR_PARKING",
      * with_ads: "Yes"
2 items}
1 item}

}
```

```json
{
  * code: "Integer",
  * message: "String",
  * data: {
    * glue_info: {
      * glue_type: "String",
      * with_ads: "String"
2 items}
1 item}

}
```

```json
{
  * code: 400,
  * message: "Bad Request",
  * error: {
    * description: "The required parameter domain_name is missing."
1 item}

}
```

```json
{
  * code: "Integer",
  * message: "String",
  * error: {
    * description: "String"
1 item}

}
```

```json
{
  * code: 401,
  * message: "Unauthorized",
  * error: {
    * description: "The provided API key is invalid, expired, or missing. Please verify your key is correct and active."
1 item}

}
```

```json
{
  * code: "Integer",
  * message: "String",
  * error: {
    * description: "String"
1 item}

}
```

```json
{
  * code: 404,
  * message: "Not Found",
  * error: {
    * description: "Can not find the account."
1 item}

}
```

```json
{
  * code: "Integer",
  * message: "String",
  * error: {
    * description: "String"
1 item}

}
```

```json
{
  * code: 429,
  * message: "Too many requests",
  * error: {
    * description: "Too many requests. Rate limit exceeded. Please try again after 60 seconds."
1 item}

}
```

```json
{
  * code: "Integer",
  * message: "String",
  * error: {
    * description: "String"
1 item}

}
```

```json
{
  * code: 500,
  * message: "Internal Server Error",
  * error: {
    * description: "Unexpected internal server error , please contact our support."
1 item}

}
```

```json
{
  * code: "Integer",
  * message: "String",
  * error: {
    * description: "String"
1 item}

}
```

--------------------------------

### GET /restful/v2/nameservers/{nameserver}

Source: https://www.dynadot.com/domain/api-document

Retrieves details for a specific nameserver.

```APIDOC
## GET /restful/v2/nameservers/{nameserver}

### Description
Retrieves the name server object including server name and IP list.

### Method
GET

### Endpoint
https://api.dynadot.com/restful/v2/nameservers/{nameserver}

### Parameters
#### Path Parameters
- **nameserver** (String) - Required - The name of the nameserver to retrieve.

### Response
#### Success Response (200)
- **code** (Integer) - Status code
- **message** (String) - Success message
- **data** (Object) - Contains nameserver object
  - **server_name** (String) - The name of the nameserver
  - **ip_list** (List) - The IP list of the nameserver
```

--------------------------------

### X-Request-ID Header Example

Source: https://www.dynadot.com/domain/api-document

Optional header for tracking requests using a UUID.

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

--------------------------------

### Domain Appraisal Request

Source: https://www.dynadot.com/domain/api-document

Example request for the domain appraisal endpoint.

```http
GET https://api.dynadot.com/restful/v2/domains/{domain_name}/appraisal
Accept:  application/json
Authorization:  Bearer API_KEY
```

--------------------------------

### API Request and Header Configuration

Source: https://www.dynadot.com/domain/api-document

Example request configuration for the SET_DEFAULT_CONTACTS endpoint.

```http
PUT https://api.dynadot.com/restful/v2/accounts/default_contacts
Content-Type:  application/json
Accept:  application/json
Authorization:  Bearer API_KEY
X-Signature:  {signature}
```

--------------------------------

### Authorization Header Example

Source: https://www.dynadot.com/domain/api-document

Authentication header requiring a Bearer token.

```text
Authorization: Bearer YOUR_API_KEY
```

--------------------------------

### Content-Type Header Example

Source: https://www.dynadot.com/domain/api-document

Required header for specifying the request body format.

```text
Content-Type: application/json
```

--------------------------------

### GET WHOIS Stats Request

Source: https://www.dynadot.com/domain/api-document

Example request for the get_whois_stats command using the RESTful API.

```http
GET https://api.dynadot.com/restful/v2/aftermarket/whois_stats
Accept:  application/json
Authorization:  Bearer API_KEY
```

--------------------------------

### GET /restful/v2/aftermarket/auctions/{domain_name}/installment_plan

Source: https://www.dynadot.com/domain/api-document

Retrieves the installment plan details for a specific domain auction.

```APIDOC
## GET /restful/v2/aftermarket/auctions/{domain_name}/installment_plan

### Description
Retrieves the current and available installment plans for a specific domain auction.

### Method
GET

### Endpoint
https://api.dynadot.com/restful/v2/aftermarket/auctions/{domain_name}/installment_plan

### Parameters
#### Path Parameters
- **domain_name** (String) - Required - The domain name to retrieve installment plans for.

### Response
#### Success Response (200)
- **code** (Integer) - Status code
- **message** (String) - Status message
- **data** (Object) - Contains current_plan, available_plans, and currency

#### Response Example
{
  "code": 200,
  "message": "Success",
  "data": {
    "current_plan": {
      "months": 4,
      "monthly_payments": ["725.00", "425.00", "425.00", "425.00"]
    },
    "available_plans": [
      {
        "months": 4,
        "monthly_payments": ["725.00", "425.00", "425.00", "425.00"]
      }
    ],
    "currency": "USD"
  }
}
```

--------------------------------

### Successful Registration Response Example

Source: https://www.dynadot.com/domain/api-document

The expected JSON response format upon a successful domain registration.

```json
{
  "code": 200,
  "message": "Success",
  "data": {
    "domain_name": "domain1.net",
    "expiration_date": "1458379145266"
  }
}
```

--------------------------------

### Folder Set Hosting API Request

Source: https://www.dynadot.com/domain/api-document

Example request for the folder_set_hosting command using a PUT method.

```http
PUT https://api.dynadot.com/restful/v2/folders/{folder_name}/hosts
Content-Type:  application/json
Accept:  application/json
Authorization:  Bearer API_KEY
X-Signature:  {signature}
```

--------------------------------

### GET CN Audit Status Request

Source: https://www.dynadot.com/domain/api-document

Example request for the get_cn_audit_status command using the production endpoint.

```http
GET https://api.dynadot.com/restful/v2/contacts/{contact_id}/get_cn_audit_status
Accept:  application/json
Authorization:  Bearer API_KEY
```

--------------------------------

### Retrieve Contacts API Request

Source: https://www.dynadot.com/domain/api-document

Example of a GET request to the contacts endpoint with required authentication headers.

```http
GET https://api.dynadot.com/restful/v2/contacts
Accept:  application/json
Authorization:  Bearer API_KEY
X-Signature:  {signature}
```

--------------------------------

### List Express Pay Link API Request

Source: https://www.dynadot.com/domain/api-document

Example of the GET request structure for retrieving pay links.

```http
GET https://api.dynadot.com/restful/v2/aftermarket/pay_links
Accept:  application/json
Authorization:  Bearer API_KEY
X-Signature:  {signature}
```

--------------------------------

### Retrieve Domain Transfer Status API Request

Source: https://www.dynadot.com/domain/api-document

Example of a GET request to retrieve the transfer status of a specific domain.

```http
GET https://api.dynadot.com/restful/v2/domains/{domain_name}/transfer_status
Accept:  application/json
Authorization:  Bearer API_KEY
```

--------------------------------

### POST /restful/v2/aftermarket/listings/{domain_name}/buy_it_now

Source: https://www.dynadot.com/domain/api-document

Purchases a domain listing using the 'Buy It Now' functionality.

```APIDOC
## POST /restful/v2/aftermarket/listings/{domain_name}/buy_it_now

### Description
This endpoint allows users to purchase a domain listing immediately using the 'Buy It Now' command. It requires an API key for authorization and an X-Signature header.

### Method
POST

### Endpoint
https://api.dynadot.com/restful/v2/aftermarket/listings/{domain_name}/buy_it_now

### Parameters
#### Path Parameters
- **domain_name** (String) - Required - The name of the domain to purchase.

#### Request Body
- **currency** (String) - Optional - The currency to use for the purchase (e.g., usd, eur, cny, cad, mxn, gbp, brl, inr, idr, aud, thb, php, krw, hkd).
- **price_to_verify** (Long) - Optional - Used to verify the final billing amount.

### Response
#### Success Response (200)
- **code** (Integer) - Status code.
- **message** (String) - Success message.
- **data** (Object) - Contains the order_id.

#### Response Example
{
  "code": 200,
  "message": "Success",
  "data": {
    "order_id": 1
  }
}
```

--------------------------------

### Upgrade Site Builder API Request

Source: https://www.dynadot.com/domain/api-document

Example request for the upgrade_site_builder endpoint including headers and body.

```http
POST https://api.dynadot.com/restful/v2/sitebuilders/{domain_name}/upgrade
Content-Type:  application/json
Accept:  application/json
Authorization:  Bearer API_KEY
X-Signature:  {signature}
```

```json
{
  * set_domain_dns: false

}
```

--------------------------------

### REGISTER Command

Source: https://www.dynadot.com/domain/api-document

The REGISTER command is used to initiate a domain registration. It accepts various contact details, name server configurations, and optional parameters like coupon codes and premium domain flags.

```APIDOC
## REGISTER Command

### Description
Registers a new domain name. This command supports multi-threading and can be tested in the API sandbox.

### Request Body
- **domain** (Object) - Required - The domain name details.
- **duration** (Integer) - Required - The duration of domain registration.
- **auth_code** (String) - Optional - The authCode of domain.
- **registrant_contact_id** (Integer) - Optional - The registrant contact id.
- **admin_contact_id** (Integer) - Optional - The admin contact id.
- **tech_contact_id** (Integer) - Optional - The tech contact id.
- **billing_contact_id** (Integer) - Optional - The billing contact id.
- **registrant_contact** (Object) - Optional - The registrant contact details.
- **admin_contact** (Object) - Optional - The admin contact details.
- **tech_contact** (Object) - Optional - The tech contact details.
- **billing_contact** (Object) - Optional - The billing contact details.
- **customer_id** (Integer) - Optional - Reseller customer ID.
- **name_server_list** (List) - Optional - The name server list.
- **privacy** (String) - Required - Domain privacy setting (off, partial, full).
- **currency** (String) - Optional - Currency code (e.g., usd, gbp).
- **register_premium** (Boolean) - Optional - Flag for premium domain registration.
- **coupon_code** (String) - Optional - Coupon code for the order.

### Response
#### Success Response
- **domain_name** (String) - The registered domain name.
- **expiration_date** (Long) - The expiration date in timestamp.
```

--------------------------------

### POST /restful/v2/sitebuilders/{domain_name}

Source: https://www.dynadot.com/domain/api-document

Creates a new site builder for the specified domain. Requires an API key and X-Signature header.

```APIDOC
## POST /restful/v2/sitebuilders/{domain_name}

### Description
Creates a new site builder instance for a given domain name.

### Method
POST

### Endpoint
https://api.dynadot.com/restful/v2/sitebuilders/{domain_name}

### Parameters
#### Path Parameters
- **domain_name** (String) - Required - The domain name to associate with the site builder.

#### Request Body
- **set_domain_dns** (Boolean) - Optional - Whether to set the domain's DNS to the site builder's DNS.

### Request Example
{
  "set_domain_dns": false
}

### Response
#### Success Response (200)
- **code** (Integer) - Status code
- **message** (String) - Success message
- **data** (Object) - The sitebuilder object containing domain_name, template, plan, is_published, last_update, expiration, and site_url.

#### Response Example
{
  "code": 200,
  "message": "Success",
  "data": {
    "sitebuilder": {
      "domain_name": "example.com",
      "template": "Meridian",
      "plan": "Free",
      "is_published": "Yes",
      "last_update": 0,
      "expiration": 0,
      "site_url": "https://sitebuilder1.example.com"
    }
  }
}
```

--------------------------------

### Get Nameserver Request

Source: https://www.dynadot.com/domain/api-document

Endpoint for retrieving nameserver information via a GET request.

```http
GET https://api.dynadot.com/restful/v2/nameservers/{nameserver}
Accept:  application/json
Authorization:  Bearer API_KEY
X-Signature:  {signature}
```

--------------------------------

### HTTP 429 Too Many Requests Example

Source: https://www.dynadot.com/domain/api-document

Example response when the API rate limit is exceeded.

```json
{
  * code: 429,
  * message: "Too many requests",
  * error: {
    * description: "Too many requests. Rate limit exceeded. Please try again after 60 seconds."
1 item}

}
```

--------------------------------

### GET_SITE_BUILDER Request Configuration

Source: https://www.dynadot.com/domain/api-document

Example request format for retrieving site builder information using the RESTful API.

```http
GET https://api.dynadot.com/restful/v2/sitebuilders/{domain_name}
Accept:  application/json
Authorization:  Bearer API_KEY
X-Signature:  {signature}
```

--------------------------------

### GET_SITE_BUILDER Success and Bad Request Responses

Source: https://www.dynadot.com/domain/api-document

JSON response examples for successful site builder retrieval and common bad request errors.

```json
{
  * code: 200,
  * message: "Success",
  * data: {
    * sitebuilder: {
      * domain_name: "example.com",
      * template: "Meridian",
      * plan: "Free",
      * is_published: "Yes",
      * last_update: 0,
      * expiration: 0,
      * site_url: https://sitebuilder1.example.com
7 items}
1 item}

}
```

```json
{
  * code: "Integer",
  * message: "String",
  * data: {
    * sitebuilder: {
      * domain_name: "String",
      * template: "String",
      * plan: "String",
      * is_published: "String",
      * last_update: "Long",
      * expiration: "Long",
      * site_url: "String"
7 items}
1 item}

}
```

```json
{
  * code: 400,
  * message: "Bad Request",
  * error: {
    * description: "The required parameter domain_name is missing."
1 item}

}
```

--------------------------------

### API Request and Header Configuration

Source: https://www.dynadot.com/domain/api-document

The endpoint URL and required headers for the SET_HOSTING command.

```http
PUT https://api.dynadot.com/restful/v2/domains/{domain_name}/hosts
Content-Type:  application/json
Accept:  application/json
Authorization:  Bearer API_KEY
X-Signature:  {signature}
```

--------------------------------

### API Request and Header Configuration

Source: https://www.dynadot.com/domain/api-document

Standard configuration for making a POST request to the aftermarket domain opt-in endpoint.

```http
POST https://api.dynadot.com/restful/v2/aftermarket/domains/{domain_name}/opt_in_fast_transfer
Content-Type:  application/json
Accept:  application/json
Authorization:  Bearer API_KEY
X-Signature:  {signature}
```

--------------------------------

### List Folders Response Structures

Source: https://www.dynadot.com/domain/api-document

Example JSON response structures for the list folders endpoint, including success and error formats.

```json
{
  * code: 200,
  * message: "Success",
  * data: {
    * folder_list: [
      1. {
         * folder_id: 0,
         * folder_name: "test_folder_name",
         * contacts_enable_status: "disable",
         * registrant_contact_id: 0,
         * admin_contact_id: 0,
         * technical_contact_id: 0,
         * billing_contact_id: 0,
         * glue_info_enable_status: "disable",
         * glue_info: {
           * glue_type: "REGISTRAR_PARKING",
           * with_ads: "Yes"
2 items},
         * renew_option_enable_status: "disable",
         * renew_option: "no renew option",
         * transfer_lock_enable_status: "disable",
         * transfer_lock_status: "locked"
13 items}
1 item]
1 item}

}
```

```json
{
  * code: "Integer",
  * message: "String",
  * data: {
    * folder_list: [
      1. {
         * folder_id: "Integer",
         * folder_name: "String",
         * contacts_enable_status: "String",
         * registrant_contact_id: "Integer",
         * admin_contact_id: "Integer",
         * technical_contact_id: "Integer",
         * billing_contact_id: "Integer",
         * glue_info_enable_status: "String",
         * glue_info: {
           * glue_type: "String",
           * with_ads: "String"
2 items},
         * renew_option_enable_status: "String",
         * renew_option: "String",
         * transfer_lock_enable_status: "String",
         * transfer_lock_status: "String"
13 items}
1 item]
1 item}

}
```

```json
{
  * code: 401,
  * message: "Unauthorized",
  * error: {
    * description: "The provided API key is invalid, expired, or missing. Please verify your key is correct and active."
1 item}

}
```

```json
{
  * code: "Integer",
  * message: "String",
  * error: {
    * description: "String"
1 item}

}
```

```json
{
  * code: 404,
  * message: "Not Found",
  * error: {
    * description: "Can not find the account."
1 item}

}
```

```json
{
  * code: 429,
  * message: "Too many requests",
  * error: {
    * description: "Too many requests. Rate limit exceeded. Please try again after 60 seconds."
1 item}

}
```

```json
{
  * code: 500,
  * message: "Internal Server Error",
  * error: {
    * description: "Unexpected internal server error , please contact our support."
1 item}

}
```

--------------------------------

### Get Aero Setting API Request

Source: https://www.dynadot.com/domain/api-document

Retrieves .aero contact settings using a GET request. Requires an API key and X-Signature header.

```http
GET https://api.dynadot.com/restful/v2/contacts/{contact_id}/get_aero_setting
Accept:  application/json
Authorization:  Bearer API_KEY
X-Signature:  {signature}
```

--------------------------------

### SET_AUCTION_INSTALLMENT_PLAN Command

Source: https://www.dynadot.com/domain/api-document

Configures the installment plan for an auction.

```APIDOC
## SET_AUCTION_INSTALLMENT_PLAN

### Description
Sets the installment payment plan for an auction.

### Parameters
- **installment_status** (String) - Required - Whether to enable installment payment (cancelled, active).
- **installment_months** (Integer) - Optional - Number of months for installment payment (2-12).
- **currency** (String) - Optional - The currency, default is USD.

### Result Parameters
- **monthly_payments** (List) - List of monthly payment amounts.
- **currency** (String) - The currency used.
```

--------------------------------

### Construct the String to Sign

Source: https://www.dynadot.com/domain/api-document

Concatenate the webhook key, path, request ID, and body with newline separators.

```text
webhookKey + "\n" + fullPathAndQuery + "\n" + (xRequestId or empty String) + "\n" + (requestBody or empty String)
```

--------------------------------

### API Request and Header

Source: https://www.dynadot.com/domain/api-document

Example request for retrieving auction details for a specific domain.

```http
GET https://api.dynadot.com/restful/v2/aftermarket/auctions/{domain_name}
Accept:  application/json
Authorization:  Bearer API_KEY
```

--------------------------------

### Success Response Structure

Source: https://www.dynadot.com/domain/api-document

Example of a successful 200 response.

```json
{
  * code: 200,
  * message: "Success",
  * data: {
    * email_hosting: {
      * username: "root",
      * expiration: 11000,
      * disk_max: 0,
      * disk_used: 0,
      * disk_used_email: 0,
      * bandwidth_max: 0,
      * bandwidth_used: 0,
      * new_email_hosting: "Yes"
8 items}
1 item}

}
```

```json
{
  * code: "Integer",
  * message: "String",
  * data: {
    * email_hosting: {
      * username: "String",
      * expiration: "Integer",
      * disk_max: "Integer",
      * disk_used: "Integer",
      * disk_used_email: "Integer",
      * bandwidth_max: "Integer",
      * bandwidth_used: "Integer",
      * new_email_hosting: "String"
8 items}
1 item}

}
```

--------------------------------

### Response Structure Examples

Source: https://www.dynadot.com/domain/api-document

JSON response formats for successful operations and various error scenarios.

```json
{
  * code: 200,
  * message: "Success"

}
{
  * code: "Integer",
  * message: "String"

}
```

```json
{
  * code: 400,
  * message: "Bad Request",
  * error: {
    * description: "The required parameter [domain_name] is missing."
1 item}

}
{
  * code: "Integer",
  * message: "String",
  * error: {
    * description: "String"
1 item}

}
```

```json
{
  * code: 401,
  * message: "Unauthorized",
  * error: {
    * description: "The provided API key is invalid, expired, or missing. Please verify your key is correct and active."
1 item}

}
{
  * code: "Integer",
  * message: "String",
  * error: {
    * description: "String"
1 item}

}
```

```json
{
  * code: 403,
  * message: "Forbidden",
  * error: {
    * description: "The request is not allowed from the current IP address. Please contact our support."
1 item}

}
{
  * code: "Integer",
  * message: "String",
  * error: {
    * description: "String"
1 item}

}
```

```json
{
  * code: 404,
  * message: "Not Found",
  * error: {
    * description: "Can not find the [account]."
1 item}

}
{
  * code: "Integer",
  * message: "String",
  * error: {
    * description: "String"
1 item}

}
```

```json
{
  * code: 429,
  * message: "Too many requests",
  * error: {
    * description: "Too many requests. Rate limit exceeded. Please try again after 60 seconds."
1 item}

}
{
  * code: "Integer",
  * message: "String",
  * error: {
    * description: "String"
1 item}

}
```

```json
{
  * code: 500,
  * message: "Internal Server Error",
  * error: {
    * description: "The request could not be processed due to an invalid request format. Please contact our support."
1 item}

}
{
  * code: "Integer",
  * message: "String",
  * error: {
    * description: "String"
1 item}

}
```

```json
{
  * code: 502,
  * message: "Bad Gateway",
  * error: {
    * description: "An unexpected error occurred while processing your request. Please contact our support."
1 item}

}
{
  * code: "Integer",
  * message: "String",
  * error: {
    * description: "String"
1 item}

}
```

--------------------------------

### Close Auction API Request

Source: https://www.dynadot.com/domain/api-document

Example request for the close_auction command.

```http
POST https://api.dynadot.com/restful/v2/aftermarket/auctions/{auction_id}/close
Content-Type:  application/json
Accept:  application/json
Authorization:  Bearer API_KEY
X-Signature:  {signature}
Request Body
{}
```

--------------------------------

### SET_PARKING API Request

Source: https://www.dynadot.com/domain/api-document

Example of a PUT request to configure domain parking settings.

```http
PUT https://api.dynadot.com/restful/v2/domains/{domain_name}/parking
Content-Type:  application/json
Accept:  application/json
Authorization:  Bearer API_KEY
X-Signature:  {signature}
Request Body
{
  * with_ads: false

}
```

--------------------------------

### Authorize Transfer Away Request

Source: https://www.dynadot.com/domain/api-document

Example request for the authorize_transfer_away command.

```http
POST https://api.dynadot.com/restful/v2/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

}
```
Tokens:
Raw