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)
Server/VirtualDomain/
DESCRIPTION
API methods for interacting with add-on domains for shared servers.
create
URL:
https://api.liquidweb.com/v1/Server/VirtualDomain/create
Description:
Create a new add-on domain for a shared subaccnt.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| domain | A hostname or fully-qualified domain name (i.e. localhost, liquidweb.com, www.liquidweb.com, etc) | * Required |
| 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
freeCount
URL:
https://api.liquidweb.com/v1/Server/VirtualDomain/freeCount
Description:
Returns a large number of free VIRs for any account type Keeping for backward compatibility of v1
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| type | A valid product code, at least 3 chars long, including at least one letter. | * Required |
Returns:
| Field | Type |
|---|---|
| count | A positive integer value (i.e. 1 and up). |
| type | A valid subaccnt type descriptor (i.e. DS.W1, GUARD, etc), at least 3 chars long. |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
list
URL:
https://api.liquidweb.com/v1/Server/VirtualDomain/list
Description:
Lists the domains for a given server.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| page_num | A positive integer value (i.e. 1 and up). | * Optional
|
| page_size | A positive integer value (i.e. 1 and up). | * Optional
|
| uniq_id | A six-character identifier, containing only capital letters and digits. | * Required |
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
listOrphans
URL:
https://api.liquidweb.com/v1/Server/VirtualDomain/listOrphans
Description:
Lists the domains in an account that are not linked to a server.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| page_num | A positive integer value (i.e. 1 and up). | * Optional
|
| page_size | A positive integer value (i.e. 1 and up). | * Optional
|
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
relink
URL:
https://api.liquidweb.com/v1/Server/VirtualDomain/relink
Description:
Links an existing orphaned add-on domain to a shared subaccnt.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| owner | A six-character identifier, containing only capital letters and digits. | * Required |
| 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
