hello,
Home Page
Overview
Error Handling
Error Handling
Methods
- Account/
- Account/Auth/
- Account/Auth/TwoFactor/
- Account/BillingAddress/
- Account/ChangeOrder/Source/
- Account/ChatPassword/
- Account/Contact/
- Account/CreditCard/
- Account/Cycle/
- Account/Limits/
- Account/PasswordReset/
- Account/Paymethod/
- Account/SSH/Key/
- Account/Settings/
- Account/Subscriptions/
- Account/User/
- Account/User/StateData/
- Acronis/Backup/
- Asset/
- Asset/Connections/
- Asset/ControlPanel/Credentials/
- Asset/Measurements/
- Asset/Monitoring/
- Attribution/
- Basket/
- Basket/Domain/
- Basket/Item/
- Basket/Item/Config/
- Billing/
- Billing/Bill/
- Billing/Credit/
- Billing/CreditCard/Profile/
- Billing/Cycle/
- Billing/Invoice/
- Billing/Invoice/Preview/
- Billing/PayPal/Agreement/
- Billing/PayPal/Payment/
- Billing/Payment/
- Billing/Payment/Profile/
- BusinessEmail/Customer/
- BusinessEmail/Domain/
- Cloud/Backup/
- Cloud/Config/
- Cloud/IP/Pool/
- Cloud/Image/
- Cloud/Private/Parent/
- Cloud/Server/
- Cloud/Template/
- CloudSites/
- CloudSites/Usage/
- CodeGuard/User/
- Contact/
- Coupon/
- Coupon/Claim/
- Domain/
- Domain/Services/
- HostedEmail/Customer/
- HostedEmail/Domain/
- Licensing/
- Licensing/Cpanel/
- Licensing/Plesk/
- Market/Bundle/
- Market/Bundle/Package/
- Market/Cart/
- Market/Cart/Admin/Quote/
- Market/Cart/Discount/
- Market/Cart/Helpers/Configurator/
- Market/Cart/Item/
- Market/Package/
- Market/Package/Product/
- Market/Place/
- Meta/Timing/
- Migration/
- Migration/Account/
- Migration/Account/Server/
- Migration/Account/Server/Access/
- Migration/Destination/
- Monitoring/Bandwidth/
- Monitoring/Load/
- Monitoring/MWP/
- Monitoring/Services/
- Network/CDN/User/
- Network/CDN/Zone/
- Network/DNS/Domain/
- Network/DNS/Domain/Contact/
- Network/DNS/Domain/Nameserver/
- Network/DNS/Domain/Transfer/
- Network/DNS/Record/
- Network/DNS/Reverse/
- Network/DNS/Zone/
- Network/DNS/Zone/History/
- Network/Firewall/
- Network/Firewall/Ruleset/
- Network/IP/
- Network/LoadBalancer/
- Network/Pool/
- Network/Private/
- Network/Region/
- Network/SSHKey/
- Network/Util/
- Network/Zone/
- Notifications/
- OneTimeSecret/
- Order/AddOn/
- Product/
- Product/Addon/
- Product/Marketplace/
- Product/Series/
- Project/
- SSL/Certificate/
- Salesforce/Account/InterWorx/
- Salesforce/Chat/Auth/
- Salesforce/User/
- Server/
- Server/Auth/
- Server/Power/
- Server/VirtualDomain/
- Server/WHM/AccessHash/
- Server/WHM/DNS/
- Server/WHM/Firewall/
- Signup/Basic/
- Storage/Block/Cluster/
- Storage/Block/Volume/
- Storage/ObjectStore/
- Support/Alert/
- Support/Request/
- Support/Request/Attachment/
- Support/SystemStatus/
- Support/Ticket/Auth/
- Tags/Product/
- UserTask/
- Utilities/Info/
- VIP/
- VMware/vCloud/vDC/
- VPN/
- VPN/User/
- WWW/Cart/
- WordPress/Domain/
API Documentation (API Version bleed)
Network/DNS/Domain/
DESCRIPTION
This section of the API allows for listing registered domains and renewing those domains.
autoRenew
URL:
https://api.liquidweb.com/bleed/Network/DNS/Domain/autoRenew
Description:
Turns autorenewal On or Off.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| allow | A boolean value (0 or 1). | * Required |
| subaccnt | A valid id number (a positive integer). | * Required if:
|
| uniq_id | A six-character identifier, containing only capital letters and digits. |
Returns:
| Field | Type |
|---|---|
| allow | A boolean value (0 or 1). |
| domain | A fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc) |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
details
URL:
https://api.liquidweb.com/bleed/Network/DNS/Domain/details
Description:
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| alsowith | A single word, consisting of only letters, digits, and underscores. | |
| domain | A fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc) | * Required |
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
disablePrivacy
URL:
https://api.liquidweb.com/bleed/Network/DNS/Domain/disablePrivacy
Description:
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| uniq_id | A six-character identifier, containing only capital letters and digits. | * Required |
Returns:
| Field | Type |
|---|---|
| success | A boolean value (0 or 1). |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
enablePrivacy
URL:
https://api.liquidweb.com/bleed/Network/DNS/Domain/enablePrivacy
Description:
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| uniq_id | A six-character identifier, containing only capital letters and digits. | * Required |
Returns:
| Field | Type |
|---|---|
| success | A boolean value (0 or 1). |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
list
URL:
https://api.liquidweb.com/bleed/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
multiRegister
URL:
https://api.liquidweb.com/bleed/Network/DNS/Domain/multiRegister
Description:
Register multimple domain, up to five, at the same time.
Parameters:
| Parameter | Type | Notes | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| domains | An array of associative arrays containing | * Required | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Returns:
| Field | Type | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| result | An array of associative arrays containing | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
purchasePrivacy
URL:
https://api.liquidweb.com/bleed/Network/DNS/Domain/purchasePrivacy
Description:
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| uniq_id | A six-character identifier, containing only capital letters and digits. | * Required |
Returns:
| Field | Type |
|---|---|
| method | A string permitting tabs, carriage returns and newlines |
| success | A boolean value (0 or 1). |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
register
URL:
https://api.liquidweb.com/bleed/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
registrationDetails
URL:
https://api.liquidweb.com/bleed/Network/DNS/Domain/registrationDetails
Description:
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| domain | Either: a fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc); or a valid DNS label, consisting of alphanumeric characters and hyphens, between 1 and 63 characters long | * Required |
| skip_suggested_domains | A boolean value (0 or 1). | * Optional
|
Returns:
| Field | Type | Notes | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| available | A boolean value (0 or 1). | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| domain | A fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| enabled | A boolean value (0 or 1). | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| extended_attributes | An array of associative arrays containing | * Optional | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| lax | A boolean value (0 or 1). | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| lockable | A boolean value (0 or 1). | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| max_period | One of: '1', '10', '2', '3', '4', '5', '6', '7', '8', '9' | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| min_period | One of: '1', '10', '2', '3', '4', '5', '6', '7', '8', '9' | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| price | A positive monetary value, such as $.05, 0.05, or 5.00 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| real_time | A boolean value (0 or 1). | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| registerable | A boolean value (0 or 1). | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| suggested | An array of associative arrays containing | * Optional | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
registrationPrice
URL:
https://api.liquidweb.com/bleed/Network/DNS/Domain/registrationPrice
Description:
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| domain | A fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc) | |
| tld | A top level domain (i.e. 'com', 'org', 'co.uk', etc) | * Required if:
|
Returns:
| Field | Type | Notes |
|---|---|---|
| domain | A fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc) | * Optional |
| price | A positive floating-point value representing a price, containing 2 to 5 decimals. | |
| tld | A top level domain (i.e. 'com', 'org', 'co.uk', etc) | * Optional |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
renew
URL:
https://api.liquidweb.com/bleed/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
tldDetails
URL:
https://api.liquidweb.com/bleed/Network/DNS/Domain/tldDetails
Description:
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| domains | Either: a fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc); or An array of a fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc) | * Required |
Returns:
| Field | Type | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| One or more keys matching: a fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc) | An associative array containing the fields: | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
