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)
Cloud/IP/Pool/
DESCRIPTION
IP Pool operations.
list
URL:
https://api.liquidweb.com/v1/Cloud/IP/Pool/list
Description:
Get a list of available IPs from the pool.
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 | A positive integer value (i.e. 1 and up). | |
| zone | 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
