hello,
Home Page
Overview
Error Handling
Error Handling
Methods
- Account/Auth/
- Account/SSH/Key/
- Billing/Invoice/
- Billing/Payment/
- Cloud/Backup/
- Cloud/Config/
- Cloud/IP/Pool/
- Cloud/Image/
- Cloud/Server/
- Cloud/Template/
- Monitoring/Bandwidth/
- Monitoring/Load/
- Monitoring/Services/
- Network/DNS/Domain/
- Network/DNS/Record/
- Network/DNS/Reverse/
- Network/DNS/Zone/
- Network/Firewall/
- Network/Firewall/Ruleset/
- Network/IP/
- Network/LoadBalancer/
- Network/Pool/
- Network/Private/
- Network/Region/
- Network/Zone/
- Notifications/
- Order/AddOn/
- Product/
- Server/
- Server/VirtualDomain/
- Storage/Block/Cluster/
- Storage/Block/Volume/
- Support/Alert/
- Utilities/Info/
- VIP/
- VPN/
API Documentation (API Version v1)
Network/DNS/Domain/
DESCRIPTION
This section of the API allows for listing registered domains and renewing those domains.
list
URL:
https://api.liquidweb.com/v1/Network/DNS/Domain/list
Description:
Returns the list of domain registrations for a given account.
Parameters:
| Parameter | Type | Notes | ||||||
|---|---|---|---|---|---|---|---|---|
| alsowith | A single word, consisting of only letters, digits, and underscores. | |||||||
| domain | A fragment of a valid domain name, suitable for partial domain searching | |||||||
| order_by | An associative array containing the fields: | |||||||
| ||||||||
| page_num | A positive integer value (i.e. 1 and up). | * Optional
| ||||||
| page_size | A positive integer value (i.e. 1 and up). | * Optional
| ||||||
| transfers | A boolean value (0 or 1). | * Optional
| ||||||
| uniq_id | A six-character identifier, containing only capital letters and digits. | |||||||
Returns:
| Field | Type | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| item_count | A non-negative integer value (i.e. 0 and up). | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
| item_total | A non-negative integer value (i.e. 0 and up). | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
| items | An array of associative arrays containing | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| page_num | A positive integer value (i.e. 1 and up). | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
| page_size | A positive integer value (i.e. 1 and up). | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
| page_total | A positive integer value (i.e. 1 and up). | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
register
URL:
https://api.liquidweb.com/v1/Network/DNS/Domain/register
Description:
Create a domain registration request.
Parameters:
| Parameter | Type | Notes | ||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| autoRenew | A boolean value (0 or 1). | * Optional
| ||||||||||||||||||||||||||||||||||||||||||
| contact | An associative array containing the fields: | |||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||
| domain | A fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc) | * Required | ||||||||||||||||||||||||||||||||||||||||||
| duration | One of: '1', '10', '2', '3', '4', '5', '6', '7', '8', '9' | * Optional
| ||||||||||||||||||||||||||||||||||||||||||
| lwtech | A boolean value (0 or 1). | * Optional
| ||||||||||||||||||||||||||||||||||||||||||
| nameServers | An array of a fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc) | |||||||||||||||||||||||||||||||||||||||||||
| privacy | A boolean value (0 or 1). | * Optional
| ||||||||||||||||||||||||||||||||||||||||||
| reseller | A boolean value (0 or 1). | * Optional
| ||||||||||||||||||||||||||||||||||||||||||
Returns:
| Field | Type | Notes |
|---|---|---|
| autorenew | A boolean value (0 or 1). | * Optional |
| autorenew_only | A boolean value (0 or 1). | |
| autorenew_value | One of: 'Disabled', 'Off', 'On', 'Registration.AutoRenew' | |
| domain | A fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc) | |
| duration | One of: '1', '10', '2', '3', '4', '5', '6', '7', '8', '9' | |
| expiration | A valid date and time in YYYY-MM-DD HH:MM:SS format. | |
| has_privacy | A boolean value (0 or 1). | |
| is_expired | A boolean value (0 or 1). | |
| is_renewable | A boolean value (0 or 1). | |
| is_rgp | A boolean value (0 or 1). | |
| is_transfer | A boolean value (0 or 1). | |
| privacy | One of: 'Disabled', 'Off', 'On' | |
| privacy_allowed | A boolean value (0 or 1). | |
| redemption_order_id | A string of text, containing no newlines or other control characters. | * Optional |
| redemption_price | A positive monetary value, such as $.05, 0.05, or 5.00 | * Required if:
|
| renewal_max_years | A positive integer value (i.e. 1 and up). | * Optional |
| renewal_price | A positive monetary value, such as $.05, 0.05, or 5.00 | * Required if:
|
| uniq_id | A six-character identifier, containing only capital letters and digits. |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
renew
URL:
https://api.liquidweb.com/v1/Network/DNS/Domain/renew
Description:
Renews a domain.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| autoRenew | A boolean value (0 or 1). | * Optional
|
| domain | A fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc) | * Required |
| duration | One of: '1', '10', '2', '3', '4', '5', '6', '7', '8', '9' | * Optional
|
| privacy | A boolean value (0 or 1). | * Optional
|
Returns:
| Field | Type | Notes |
|---|---|---|
| autorenew | A boolean value (0 or 1). | * Optional |
| autorenew_only | A boolean value (0 or 1). | |
| autorenew_value | One of: 'Disabled', 'Off', 'On', 'Registration.AutoRenew' | |
| domain | A fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc) | |
| duration | One of: '1', '10', '2', '3', '4', '5', '6', '7', '8', '9' | |
| expiration | A valid date and time in YYYY-MM-DD HH:MM:SS format. | |
| has_privacy | A boolean value (0 or 1). | |
| is_expired | A boolean value (0 or 1). | |
| is_renewable | A boolean value (0 or 1). | |
| is_rgp | A boolean value (0 or 1). | |
| is_transfer | A boolean value (0 or 1). | |
| privacy | One of: 'Disabled', 'Off', 'On' | |
| privacy_allowed | A boolean value (0 or 1). | |
| redemption_order_id | A string of text, containing no newlines or other control characters. | * Optional |
| redemption_price | A positive monetary value, such as $.05, 0.05, or 5.00 | * Required if:
|
| renewal_max_years | A positive integer value (i.e. 1 and up). | * Optional |
| renewal_price | A positive monetary value, such as $.05, 0.05, or 5.00 | * Required if:
|
| uniq_id | A six-character identifier, containing only capital letters and digits. |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
