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/Pool/
DESCRIPTION
Through these api methods, you can manage network IP Pools.
create
URL:
https://api.liquidweb.com/v1/Network/Pool/create
Description:
Create a new IP Pool
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| add_ips | An array of an IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1) or an IPv6 address w/mask (e.g. 2001:DB8:0BFF:202:B3FF:FE1E:8329:0BFF/64) | * Required if:
|
| new_ips | A non-negative integer value (i.e. 0 and up). | * Required if:
|
| zone_id | A positive integer value (i.e. 1 and up). | * Required |
Returns:
| Field | Type | ||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| accnt | A valid account number, up to 6 digits in length. | ||||||||||||||||||||||||||||
| assignments | An array of associative arrays containing | ||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||
| id | A positive integer value (i.e. 1 and up). | ||||||||||||||||||||||||||||
| uniq_id | A six-character identifier, containing only capital letters and digits. | ||||||||||||||||||||||||||||
| zone_id | A positive integer value (i.e. 1 and up). | ||||||||||||||||||||||||||||
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
delete
URL:
https://api.liquidweb.com/v1/Network/Pool/delete
Description:
Deletes the given pool, and all the assignments that are only in the pool.
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 |
|---|---|
| deleted | A positive integer value (i.e. 1 and up). |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
details
URL:
https://api.liquidweb.com/v1/Network/Pool/details
Description:
Returns the details of a given IP pool.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| free_only | A boolean value (0 or 1). | |
| id | A positive integer value (i.e. 1 and up). | * Required if:
|
| subaccnt | A positive integer value (i.e. 1 and up). | * Required if:
|
| uniq_id | A six-character identifier, containing only capital letters and digits. | * Required if:
|
Returns:
| Field | Type | ||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| accnt | A valid account number, up to 6 digits in length. | ||||||||||||||||||||||||||||
| assignments | An array of associative arrays containing | ||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||
| id | A positive integer value (i.e. 1 and up). | ||||||||||||||||||||||||||||
| uniq_id | A six-character identifier, containing only capital letters and digits. | ||||||||||||||||||||||||||||
| zone_id | A positive integer value (i.e. 1 and up). | ||||||||||||||||||||||||||||
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
list
URL:
https://api.liquidweb.com/v1/Network/Pool/list
Description:
Gets a list of network assignments for a particular IP Pool.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| alsowith | A single word, consisting of only letters, digits, and underscores. | |
| page_num | A positive integer value (i.e. 1 and up). | * Optional
|
| page_size | A positive integer value (i.e. 1 and up). | * Optional
|
| zone_id | A positive integer value (i.e. 1 and up). |
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/Network/Pool/update
Description:
Update an existing IP Pool
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| add_ips | An array of an IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1) or an IPv6 address w/mask (e.g. 2001:DB8:0BFF:202:B3FF:FE1E:8329:0BFF/64) | |
| id | A positive integer value (i.e. 1 and up). | * Required if:
|
| new_ips | A non-negative integer value (i.e. 0 and up). | |
| remove_ips | An array of an IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1) or an IPv6 address w/mask (e.g. 2001:DB8:0BFF:202:B3FF:FE1E:8329:0BFF/64) | |
| subaccnt | A positive integer value (i.e. 1 and up). | * Required if:
|
| uniq_id | A six-character identifier, containing only capital letters and digits. | * Required if:
|
Returns:
| Field | Type | ||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| accnt | A valid account number, up to 6 digits in length. | ||||||||||||||||||||||||||||
| assignments | An array of associative arrays containing | ||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||
| id | A positive integer value (i.e. 1 and up). | ||||||||||||||||||||||||||||
| uniq_id | A six-character identifier, containing only capital letters and digits. | ||||||||||||||||||||||||||||
| zone_id | A positive integer value (i.e. 1 and up). | ||||||||||||||||||||||||||||
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
