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)
VIP/
DESCRIPTION
This section contains methods to manage the Virtual IP services of a particular account.
create
URL:
https://api.liquidweb.com/v1/VIP/create
Description:
create a new Virtual IP service.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| domain | A string of text, containing no newlines or other control characters. | * Required |
| zone | An integer value. | * Required |
Returns:
| Field | Type |
|---|---|
| active | A boolean value (0 or 1). |
| activeStatus | A single word, consisting of only letters and digits. |
| domain | A string of text, containing no newlines or other control characters. |
| uniq_id | A six-character identifier, containing only capital letters and digits. |
| zone | A positive integer value (i.e. 1 and up). |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
destroy
URL:
https://api.liquidweb.com/v1/VIP/destroy
Description:
remove a Virtual IP service.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| 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 |
|---|---|
| destroyed | A six-character identifier, containing only capital letters and digits. |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
details
URL:
https://api.liquidweb.com/v1/VIP/details
Description:
Get information about the VIP subaccnt.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| uniq_id | A six-character identifier, containing only capital letters and digits. | * Required |
Returns:
| Field | Type |
|---|---|
| active | A boolean value (0 or 1). |
| activeStatus | A single word, consisting of only letters and digits. |
| domain | A string of text, containing no newlines or other control characters. |
| uniq_id | A six-character identifier, containing only capital letters and digits. |
| zone | A positive integer value (i.e. 1 and up). |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
