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/IP/
DESCRIPTION
This section provides methods for listing and manipulating the IPs assigned to a server.
add
URL:
https://api.liquidweb.com/v1/Network/IP/add
Description:
Add a number of IPs to an existing server. If the 'configure_ips' flag is passed in, the new IP address(es) will be configured within the servers operating system.
Each account has a per-server IP limit defined. By default, that limit is 8 IPv4 addresses and 1 IPv6 /64 per server. Any requests above that limit will fail. A customer can call in to have that limit adjusted if they have a valid use for them.
Bleed version supports Openstack servers of which are limited to a total of 5 IP addresses and can only add 1 IP address at a time. pool_ips, reboot, configure_ips, ip6_count, and pool6_ips args are not used. If passed in, they will be ignored.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| configure_ips | A boolean value (0 or 1). | |
| ip_count | A positive integer value (i.e. 1 and up). | * Required |
| reboot | A boolean value (0 or 1). | |
| uniq_id | A six-character identifier, containing only capital letters and digits. | * Required |
Returns:
| Field | Type |
|---|---|
| adding | A string consisting of only letters, digits, hyphens, spaces, and underscores. |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
details
URL:
https://api.liquidweb.com/v1/Network/IP/details
Description:
Gets information about a particular IP.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| ip | An IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1) | * Required |
| uniq_id | A six-character identifier, containing only capital letters and digits. | * Required |
Returns:
| Field | Type |
|---|---|
| broadcast | An IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1) |
| gateway | An IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1) |
| id | A positive integer value (i.e. 1 and up). |
| ip | An IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1) |
| netmask | An IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1) |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
list
URL:
https://api.liquidweb.com/v1/Network/IP/list
Description:
Gets a paginated list of all IP assignments for a particular server. More details about the returned data can be found under network/ip/details
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
|
| uniq_id | A six-character identifier, containing only capital letters and digits. | * Required |
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
listAccntPublic
URL:
https://api.liquidweb.com/v1/Network/IP/listAccntPublic
Description:
Gets a list of public network assignments for all provisioned subaccounts for a particular account, optionally for a specific zone only. With the include_pools flag, also includes IPs assigned to IP pools.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| include_pools | A boolean value (0 or 1). | |
| 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
listPublic
URL:
https://api.liquidweb.com/v1/Network/IP/listPublic
Description:
Gets a paginated list of all public IPs for a particular server. More details about the returned data can be found under network/ip/details
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
|
| uniq_id | A six-character identifier, containing only capital letters and digits. | * Required |
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
remove
URL:
https://api.liquidweb.com/v1/Network/IP/remove
Description:
Remove a specific IP from a server. If the 'configure_ips' flag is passed in, the IP address will be de-configured within the servers operating system.
Note: At this time, it is impossible to remove the server's primary IP using the API
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| ip | An IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1) | * Required |
| reboot | A boolean value (0 or 1). | |
| uniq_id | A six-character identifier, containing only capital letters and digits. | * Required |
Returns:
| Field | Type |
|---|---|
| removing | An IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1) |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
request
URL:
https://api.liquidweb.com/v1/Network/IP/request
Description:
Request additional IPs for a server. Many server types (traditional dedicated for example) require manual intervention to add IPs. This method creates a ticket, requesting that the given number of IPs be added.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| ip_count | A positive integer value (i.e. 1 and up). | * Required |
| uniq_id | A six-character identifier, containing only capital letters and digits. | * Required |
| usage_justification | A string permitting tabs, carriage returns and newlines |
Returns:
| Field | Type |
|---|---|
| adding | A string consisting of only letters, digits, hyphens, spaces, and underscores. |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
