hello,
Home Page
Overview
Error Handling
Error Handling
Methods
- Account/Auth/
- Account/SSH/Key/
- Account/User/
- 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/LoadBalancer/
DESCRIPTION
Load Balancers will spread server load among a set of servers (aka nodes). This section of the API provides access for creating, adjusting, and removing load balancers from an account.
addNode
URL:
https://api.liquidweb.com/v1/Network/LoadBalancer/addNode
Description:
Adds a single node to an existing loadbalancer.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| node | 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 | Notes | |||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| capabilities | An associative array of arbitrary keys and values. | ||||||||||||||||||||||||||||||||||||||||
| custom_name | A string of text, containing no newlines or other control characters and does not start with a space (Maximum length: 255) | * Optional | |||||||||||||||||||||||||||||||||||||||
| cycle | A single word, consisting of only letters, digits, hyphens, and underscores. | * Optional | |||||||||||||||||||||||||||||||||||||||
| name | A string. | ||||||||||||||||||||||||||||||||||||||||
| nodes | An array of associative arrays containing | ||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||
| project_name | A string permitting tabs, carriage returns and newlines | * Optional | |||||||||||||||||||||||||||||||||||||||
| region_id | A valid id number (a positive integer). | ||||||||||||||||||||||||||||||||||||||||
| services | An array of associative arrays containing | ||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||
| session_persistence | A boolean value (0 or 1). | ||||||||||||||||||||||||||||||||||||||||
| ssl_includes | A boolean value (0 or 1). | ||||||||||||||||||||||||||||||||||||||||
| ssl_termination | A boolean value (0 or 1). | ||||||||||||||||||||||||||||||||||||||||
| strategy | A single word, consisting of only letters and digits. | ||||||||||||||||||||||||||||||||||||||||
| uniq_id | A six-character identifier, containing only capital letters and digits. | ||||||||||||||||||||||||||||||||||||||||
| vip | 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
addService
URL:
https://api.liquidweb.com/v1/Network/LoadBalancer/addService
Description:
Adds a service to an existing loadbalancer.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| dest_port | A valid network port number. | * Required |
| src_port | A valid network port number. | * Required |
| uniq_id | A six-character identifier, containing only capital letters and digits. | * Required |
Returns:
| Field | Type | Notes | |||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| capabilities | An associative array of arbitrary keys and values. | ||||||||||||||||||||||||||||||||||||||||
| custom_name | A string of text, containing no newlines or other control characters and does not start with a space (Maximum length: 255) | * Optional | |||||||||||||||||||||||||||||||||||||||
| cycle | A single word, consisting of only letters, digits, hyphens, and underscores. | * Optional | |||||||||||||||||||||||||||||||||||||||
| name | A string. | ||||||||||||||||||||||||||||||||||||||||
| nodes | An array of associative arrays containing | ||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||
| project_name | A string permitting tabs, carriage returns and newlines | * Optional | |||||||||||||||||||||||||||||||||||||||
| region_id | A valid id number (a positive integer). | ||||||||||||||||||||||||||||||||||||||||
| services | An array of associative arrays containing | ||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||
| session_persistence | A boolean value (0 or 1). | ||||||||||||||||||||||||||||||||||||||||
| ssl_includes | A boolean value (0 or 1). | ||||||||||||||||||||||||||||||||||||||||
| ssl_termination | A boolean value (0 or 1). | ||||||||||||||||||||||||||||||||||||||||
| strategy | A single word, consisting of only letters and digits. | ||||||||||||||||||||||||||||||||||||||||
| uniq_id | A six-character identifier, containing only capital letters and digits. | ||||||||||||||||||||||||||||||||||||||||
| vip | 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
available
URL:
https://api.liquidweb.com/v1/Network/LoadBalancer/available
Description:
Find out if a loadbalancer name is already in use on an account. Allows for preventing DuplicateRecord exceptions when creating new load balancers.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| name | A string permitting tabs, carriage returns and newlines (Maximum length: 60) | * Required |
Returns:
| Field | Type |
|---|---|
| available | A boolean value (0 or 1). |
| name | A string permitting tabs, carriage returns and newlines (Maximum length: 60) |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
create
URL:
https://api.liquidweb.com/v1/Network/LoadBalancer/create
Description:
Create a new loadbalancer. Valid loadbalance strategies can be found using the /Network/LoadBalancer/strategies method.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| name | A string permitting tabs, carriage returns and newlines (Maximum length: 60) | * Required |
| nodes | An array of an IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1) | |
| region | A positive integer value (i.e. 1 and up). | * Optional
|
| services | An array of a valid loadbalancer service definition, being an associative array with keys src_port and dest_port, each being a valid network port number. An optional key health_check is permitted as well. | * Required |
| session_persistence | A boolean value (0 or 1). | |
| ssl_cert | An ssl X509 public certificate, including the BEGIN CERTIFICATE and END CERTIFICATE comments. | * Required if:
|
| ssl_includes | A boolean value (0 or 1). | |
| ssl_int | An ssl X509 public certificate, including the BEGIN CERTIFICATE and END CERTIFICATE comments. | * Required if:
|
| ssl_key | A private key, including the BEGIN PRIVATE KEY and END PRIVATE KEY comments. | * Required if:
|
| ssl_termination | A boolean value (0 or 1). | |
| strategy | A single word, consisting of only letters and digits. | * Required |
Returns:
| Field | Type | Notes | |||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| capabilities | An associative array of arbitrary keys and values. | ||||||||||||||||||||||||||||||||||||||||
| custom_name | A string of text, containing no newlines or other control characters and does not start with a space (Maximum length: 255) | * Optional | |||||||||||||||||||||||||||||||||||||||
| cycle | A single word, consisting of only letters, digits, hyphens, and underscores. | * Optional | |||||||||||||||||||||||||||||||||||||||
| name | A string. | ||||||||||||||||||||||||||||||||||||||||
| nodes | An array of associative arrays containing | ||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||
| project_name | A string permitting tabs, carriage returns and newlines | * Optional | |||||||||||||||||||||||||||||||||||||||
| region_id | A valid id number (a positive integer). | ||||||||||||||||||||||||||||||||||||||||
| services | An array of associative arrays containing | ||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||
| session_persistence | A boolean value (0 or 1). | ||||||||||||||||||||||||||||||||||||||||
| ssl_includes | A boolean value (0 or 1). | ||||||||||||||||||||||||||||||||||||||||
| ssl_termination | A boolean value (0 or 1). | ||||||||||||||||||||||||||||||||||||||||
| strategy | A single word, consisting of only letters and digits. | ||||||||||||||||||||||||||||||||||||||||
| uniq_id | A six-character identifier, containing only capital letters and digits. | ||||||||||||||||||||||||||||||||||||||||
| vip | 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
delete
URL:
https://api.liquidweb.com/v1/Network/LoadBalancer/delete
Description:
Delete a loadbalancer.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| uniq_id | A six-character identifier, containing only capital letters and digits. | * Required |
Returns:
| Field | Type |
|---|---|
| deleted | 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/Network/LoadBalancer/details
Description:
Get information about a specific loadbalancer.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| uniq_id | A six-character identifier, containing only capital letters and digits. | * Required |
Returns:
| Field | Type | Notes | |||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| capabilities | An associative array of arbitrary keys and values. | ||||||||||||||||||||||||||||||||||||||||
| custom_name | A string of text, containing no newlines or other control characters and does not start with a space (Maximum length: 255) | * Optional | |||||||||||||||||||||||||||||||||||||||
| cycle | A single word, consisting of only letters, digits, hyphens, and underscores. | * Optional | |||||||||||||||||||||||||||||||||||||||
| name | A string. | ||||||||||||||||||||||||||||||||||||||||
| nodes | An array of associative arrays containing | ||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||
| project_name | A string permitting tabs, carriage returns and newlines | * Optional | |||||||||||||||||||||||||||||||||||||||
| region_id | A valid id number (a positive integer). | ||||||||||||||||||||||||||||||||||||||||
| services | An array of associative arrays containing | ||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||
| session_persistence | A boolean value (0 or 1). | ||||||||||||||||||||||||||||||||||||||||
| ssl_includes | A boolean value (0 or 1). | ||||||||||||||||||||||||||||||||||||||||
| ssl_termination | A boolean value (0 or 1). | ||||||||||||||||||||||||||||||||||||||||
| strategy | A single word, consisting of only letters and digits. | ||||||||||||||||||||||||||||||||||||||||
| uniq_id | A six-character identifier, containing only capital letters and digits. | ||||||||||||||||||||||||||||||||||||||||
| vip | 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/LoadBalancer/list
Description:
Gets a list of all loadbalancers on an account.
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). |
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
possibleNodes
URL:
https://api.liquidweb.com/v1/Network/LoadBalancer/possibleNodes
Description:
Gets a list of all possible Loadbalancer Nodes on an account, regardless of whether or not they are currently loadbalanced.
Parameters:
| Parameter | Type |
|---|---|
| region | A positive integer value (i.e. 1 and up). |
Returns:
| Field | Type | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| items | An array of associative arrays containing | |||||||||
| ||||||||||
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
removeNode
URL:
https://api.liquidweb.com/v1/Network/LoadBalancer/removeNode
Description:
Removes a single node from an existing loadbalancer.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| node | 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 | Notes | |||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| capabilities | An associative array of arbitrary keys and values. | ||||||||||||||||||||||||||||||||||||||||
| custom_name | A string of text, containing no newlines or other control characters and does not start with a space (Maximum length: 255) | * Optional | |||||||||||||||||||||||||||||||||||||||
| cycle | A single word, consisting of only letters, digits, hyphens, and underscores. | * Optional | |||||||||||||||||||||||||||||||||||||||
| name | A string. | ||||||||||||||||||||||||||||||||||||||||
| nodes | An array of associative arrays containing | ||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||
| project_name | A string permitting tabs, carriage returns and newlines | * Optional | |||||||||||||||||||||||||||||||||||||||
| region_id | A valid id number (a positive integer). | ||||||||||||||||||||||||||||||||||||||||
| services | An array of associative arrays containing | ||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||
| session_persistence | A boolean value (0 or 1). | ||||||||||||||||||||||||||||||||||||||||
| ssl_includes | A boolean value (0 or 1). | ||||||||||||||||||||||||||||||||||||||||
| ssl_termination | A boolean value (0 or 1). | ||||||||||||||||||||||||||||||||||||||||
| strategy | A single word, consisting of only letters and digits. | ||||||||||||||||||||||||||||||||||||||||
| uniq_id | A six-character identifier, containing only capital letters and digits. | ||||||||||||||||||||||||||||||||||||||||
| vip | 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
removeService
URL:
https://api.liquidweb.com/v1/Network/LoadBalancer/removeService
Description:
Removes a single service from an existing loadbalancer.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| src_port | A valid network port number. | * Required |
| uniq_id | A six-character identifier, containing only capital letters and digits. | * Required |
Returns:
| Field | Type | Notes | |||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| capabilities | An associative array of arbitrary keys and values. | ||||||||||||||||||||||||||||||||||||||||
| custom_name | A string of text, containing no newlines or other control characters and does not start with a space (Maximum length: 255) | * Optional | |||||||||||||||||||||||||||||||||||||||
| cycle | A single word, consisting of only letters, digits, hyphens, and underscores. | * Optional | |||||||||||||||||||||||||||||||||||||||
| name | A string. | ||||||||||||||||||||||||||||||||||||||||
| nodes | An array of associative arrays containing | ||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||
| project_name | A string permitting tabs, carriage returns and newlines | * Optional | |||||||||||||||||||||||||||||||||||||||
| region_id | A valid id number (a positive integer). | ||||||||||||||||||||||||||||||||||||||||
| services | An array of associative arrays containing | ||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||
| session_persistence | A boolean value (0 or 1). | ||||||||||||||||||||||||||||||||||||||||
| ssl_includes | A boolean value (0 or 1). | ||||||||||||||||||||||||||||||||||||||||
| ssl_termination | A boolean value (0 or 1). | ||||||||||||||||||||||||||||||||||||||||
| strategy | A single word, consisting of only letters and digits. | ||||||||||||||||||||||||||||||||||||||||
| uniq_id | A six-character identifier, containing only capital letters and digits. | ||||||||||||||||||||||||||||||||||||||||
| vip | 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
strategies
URL:
https://api.liquidweb.com/v1/Network/LoadBalancer/strategies
Description:
Get a list of available strategies, with extra descriptive information.
Parameters:
No Values Defined
Returns:
| Field | Type | |||||||
|---|---|---|---|---|---|---|---|---|
| strategies | An array of associative arrays containing | |||||||
| ||||||||
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
update
URL:
https://api.liquidweb.com/v1/Network/LoadBalancer/update
Description:
Update an existing loadbalancer. Valid loadbalance strategies can be found using the /Network/LoadBalancer/strategies method.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| name | A string permitting tabs, carriage returns and newlines (Maximum length: 60) | |
| nodes | An array of an IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1) | |
| services | An array of a valid loadbalancer service definition, being an associative array with keys src_port and dest_port, each being a valid network port number. An optional key health_check is permitted as well. | |
| session_persistence | A boolean value (0 or 1). | |
| ssl_cert | An ssl X509 public certificate, including the BEGIN CERTIFICATE and END CERTIFICATE comments. | * Required if:
|
| ssl_includes | A boolean value (0 or 1). | |
| ssl_int | An ssl X509 public certificate, including the BEGIN CERTIFICATE and END CERTIFICATE comments. | * Required if:
|
| ssl_key | A private key, including the BEGIN PRIVATE KEY and END PRIVATE KEY comments. | * Required if:
|
| ssl_termination | A boolean value (0 or 1). | |
| strategy | A single word, consisting of only letters and digits. | |
| uniq_id | A six-character identifier, containing only capital letters and digits. | * Required |
Returns:
| Field | Type | Notes | |||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| capabilities | An associative array of arbitrary keys and values. | ||||||||||||||||||||||||||||||||||||||||
| custom_name | A string of text, containing no newlines or other control characters and does not start with a space (Maximum length: 255) | * Optional | |||||||||||||||||||||||||||||||||||||||
| cycle | A single word, consisting of only letters, digits, hyphens, and underscores. | * Optional | |||||||||||||||||||||||||||||||||||||||
| name | A string. | ||||||||||||||||||||||||||||||||||||||||
| nodes | An array of associative arrays containing | ||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||
| project_name | A string permitting tabs, carriage returns and newlines | * Optional | |||||||||||||||||||||||||||||||||||||||
| region_id | A valid id number (a positive integer). | ||||||||||||||||||||||||||||||||||||||||
| services | An array of associative arrays containing | ||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||
| session_persistence | A boolean value (0 or 1). | ||||||||||||||||||||||||||||||||||||||||
| ssl_includes | A boolean value (0 or 1). | ||||||||||||||||||||||||||||||||||||||||
| ssl_termination | A boolean value (0 or 1). | ||||||||||||||||||||||||||||||||||||||||
| strategy | A single word, consisting of only letters and digits. | ||||||||||||||||||||||||||||||||||||||||
| uniq_id | A six-character identifier, containing only capital letters and digits. | ||||||||||||||||||||||||||||||||||||||||
| vip | 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