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)
VPN/
DESCRIPTION
This section contains methods to manage the VPN service of a particular account.
create
URL:
https://api.liquidweb.com/v1/VPN/create
Description:
create a new VPN service.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| domain | A fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc) | * Required |
| features | An associative array of arbitrary keys and values. | * Required |
| region_id | An integer value. | * Required |
Returns:
| Field | Type |
|---|---|
| active | A boolean value (0 or 1). |
| activeStatus | A single word, consisting of only letters and digits. |
| current_users | A non-negative integer value (i.e. 0 and up). |
| domain | A fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc) |
| max_users | A positive integer value (i.e. 1 and up). |
| network_range | An array of an IPv4 IP address, in quad-dotted decimal notation, with a cidr mask (i.e. 127.0.0.1/32, 192.168.1.0/24) |
| region_id | A positive integer value (i.e. 1 and up). |
| 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
details
URL:
https://api.liquidweb.com/v1/VPN/details
Description:
Get information about VPN access for this account.
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. | |||||||
| current_users | A non-negative integer value (i.e. 0 and up). | |||||||
| domain | A fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc) | |||||||
| max_users | A positive integer value (i.e. 1 and up). | |||||||
| network_range | An array of an IPv4 IP address, in quad-dotted decimal notation, with a cidr mask (i.e. 127.0.0.1/32, 192.168.1.0/24) | |||||||
| region_id | A positive integer value (i.e. 1 and up). | |||||||
| uniq_id | A six-character identifier, containing only capital letters and digits. | |||||||
| vpn | An associative array containing the fields: | |||||||
| ||||||||
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
list
URL:
https://api.liquidweb.com/v1/VPN/list
Description:
Lists the authorized VPN users for a given accnt.
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
|
| region_id | A valid id number (a positive integer). | |
| uniq_id | Either: a six-character identifier, containing only capital letters and digits.; or An array of 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
update
URL:
https://api.liquidweb.com/v1/VPN/update
Description:
Update the features of a VPN service.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| domain | A fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc) | |
| features | An associative array of arbitrary keys and values. | |
| 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. |
| current_users | A non-negative integer value (i.e. 0 and up). |
| domain | A fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc) |
| max_users | A positive integer value (i.e. 1 and up). |
| network_range | An array of an IPv4 IP address, in quad-dotted decimal notation, with a cidr mask (i.e. 127.0.0.1/32, 192.168.1.0/24) |
| region_id | A positive integer value (i.e. 1 and up). |
| 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