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/Private/
DESCRIPTION
Private networking provides the option for several Storm servers to contact each other via a network interface that is a) not publicly routeable and b) not metered for bandwidth. Applications that communicate internally will frequently use this for both security and cost-savings.
This section of the API provides methods for attaching and detaching a server to a private network, and for querying information about an existing private network.
attach
URL:
https://api.liquidweb.com/v1/Network/Private/attach
Description:
Attach a given server to your private network.
Note: This will automatically create the private network, if it is not already created.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| uniq_id | A six-character identifier, containing only capital letters and digits. | * Required |
Returns:
| Field | Type |
|---|---|
| attached | A six-character identifier, containing only capital letters and digits. |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
detach
URL:
https://api.liquidweb.com/v1/Network/Private/detach
Description:
Detaches a given server to your private network.
Note: if this is the last server on your private network, the private vlan will be destroyed, so you will not be guaranteed the same private vlan id, should you re-enable private networking later.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| uniq_id | A six-character identifier, containing only capital letters and digits. | * Required |
Returns:
| Field | Type |
|---|---|
| detached | A six-character identifier, containing only capital letters and digits. |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
get
URL:
https://api.liquidweb.com/v1/Network/Private/get
Description:
Gets all of the servers attached to your private network, which zones they are in, and what IPs they are assigned.
Parameters:
| Parameter | Type |
|---|---|
| zone_id | A positive integer value (i.e. 1 and up). |
Returns:
| Field | Type | ||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| zones | An array of associative arrays containing | ||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
getIP
URL:
https://api.liquidweb.com/v1/Network/Private/getIP
Description:
Gets the current private IP for a particular server, if it has one.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| uniq_id | A six-character identifier, containing only capital letters and digits. | * Required |
Returns:
| Field | Type |
|---|---|
| ip | A valid IP address (v4 or v6) |
| legacy | A boolean value (0 or 1). |
| 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
isAttached
URL:
https://api.liquidweb.com/v1/Network/Private/isAttached
Description:
Determine whether a given server is currently attached to your private network.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| uniq_id | A six-character identifier, containing only capital letters and digits. | * Required |
Returns:
| Field | Type |
|---|---|
| is_attached | A boolean value (0 or 1). |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
