Overview
Error Handling

Methods

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.stormondemand.com/v1/Network/LoadBalancer/addNode

Description:

Adds a single node to an existing loadbalancer.

Parameters:

ParameterTypeNotes
nodeAn IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1)* Required
uniq_idA six-character identifier, containing only capital letters and digits.* Required

Returns:

FieldType
capabilitiesAn associative array of arbitrary keys and values.
nameA string.
nodesAn array of associative arrays containing
 
domainA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)
ipAn IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1)
uniq_idA six-character identifier, containing only capital letters and digits.
region_idA valid id number (a positive integer).
servicesAn array of associative arrays containing
 
dest_portA valid network port number.
protocolA single word, consisting of only letters, digits, and underscores.
src_portA valid network port number.
session_persistenceA boolean value (0 or 1).
ssl_includesA boolean value (0 or 1).
ssl_terminationA boolean value (0 or 1).
strategyA single word, consisting of only letters and digits.
uniq_idA six-character identifier, containing only capital letters and digits.
vipAn 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.stormondemand.com/v1/Network/LoadBalancer/addService

Description:

Adds a service to an existing loadbalancer.

Parameters:

ParameterTypeNotes
dest_portA valid network port number.* Required
src_portA valid network port number.* Required
uniq_idA six-character identifier, containing only capital letters and digits.* Required

Returns:

FieldType
capabilitiesAn associative array of arbitrary keys and values.
nameA string.
nodesAn array of associative arrays containing
 
domainA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)
ipAn IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1)
uniq_idA six-character identifier, containing only capital letters and digits.
region_idA valid id number (a positive integer).
servicesAn array of associative arrays containing
 
dest_portA valid network port number.
protocolA single word, consisting of only letters, digits, and underscores.
src_portA valid network port number.
session_persistenceA boolean value (0 or 1).
ssl_includesA boolean value (0 or 1).
ssl_terminationA boolean value (0 or 1).
strategyA single word, consisting of only letters and digits.
uniq_idA six-character identifier, containing only capital letters and digits.
vipAn 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.stormondemand.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:

ParameterTypeNotes
nameA string permitting tabs, carriage returns and newlines (Maximum length: 60)* Required

Returns:

FieldType
availableA boolean value (0 or 1).
nameA 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.stormondemand.com/v1/Network/LoadBalancer/create

Description:

Create a new loadbalancer. Valid loadbalance strategies can be found using the /Network/LoadBalancer/strategies method.

Parameters:

ParameterTypeNotes
nameA string permitting tabs, carriage returns and newlines (Maximum length: 60)* Required
nodesAn array of an IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1)
regionA positive integer value (i.e. 1 and up).* Optional
  • Defaults to: 1
servicesAn 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.* Required
session_persistenceA boolean value (0 or 1).
ssl_certAn ssl X509 public certificate, including the BEGIN CERTIFICATE and END CERTIFICATE comments.* Required if:
  • ssl_termination is set to '1'
ssl_includesA boolean value (0 or 1).
ssl_intAn ssl X509 public certificate, including the BEGIN CERTIFICATE and END CERTIFICATE comments.* Required if:
  • ssl_includes is set to '1'
ssl_keyA private key, including the BEGIN PRIVATE KEY and END PRIVATE KEY comments.* Required if:
  • ssl_termination is set to '1'
ssl_terminationA boolean value (0 or 1).
strategyA single word, consisting of only letters and digits.* Required

Returns:

FieldType
capabilitiesAn associative array of arbitrary keys and values.
nameA string.
nodesAn array of associative arrays containing
 
domainA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)
ipAn IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1)
uniq_idA six-character identifier, containing only capital letters and digits.
region_idA valid id number (a positive integer).
servicesAn array of associative arrays containing
 
dest_portA valid network port number.
protocolA single word, consisting of only letters, digits, and underscores.
src_portA valid network port number.
session_persistenceA boolean value (0 or 1).
ssl_includesA boolean value (0 or 1).
ssl_terminationA boolean value (0 or 1).
strategyA single word, consisting of only letters and digits.
uniq_idA six-character identifier, containing only capital letters and digits.
vipAn 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.stormondemand.com/v1/Network/LoadBalancer/delete

Description:

Delete a loadbalancer.

Parameters:

ParameterTypeNotes
uniq_idA six-character identifier, containing only capital letters and digits.* Required

Returns:

FieldType
deletedA 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.stormondemand.com/v1/Network/LoadBalancer/details

Description:

Get information about a specific loadbalancer.

Parameters:

ParameterTypeNotes
uniq_idA six-character identifier, containing only capital letters and digits.* Required

Returns:

FieldType
capabilitiesAn associative array of arbitrary keys and values.
nameA string.
nodesAn array of associative arrays containing
 
domainA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)
ipAn IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1)
uniq_idA six-character identifier, containing only capital letters and digits.
region_idA valid id number (a positive integer).
servicesAn array of associative arrays containing
 
dest_portA valid network port number.
protocolA single word, consisting of only letters, digits, and underscores.
src_portA valid network port number.
session_persistenceA boolean value (0 or 1).
ssl_includesA boolean value (0 or 1).
ssl_terminationA boolean value (0 or 1).
strategyA single word, consisting of only letters and digits.
uniq_idA six-character identifier, containing only capital letters and digits.
vipAn 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.stormondemand.com/v1/Network/LoadBalancer/list

Description:

Gets a list of all loadbalancers on an account.

Parameters:

ParameterTypeNotes
page_numA positive integer value (i.e. 1 and up).* Optional
  • Defaults to: 1
page_sizeA positive integer value (i.e. 1 and up).* Optional
  • Defaults to: 25
regionA positive integer value (i.e. 1 and up).

Returns:

FieldType
item_countA non-negative integer value (i.e. 0 and up).
item_totalA non-negative integer value (i.e. 0 and up).
itemsAn array of associative arrays containing
 
capabilitiesAn associative array of arbitrary keys and values.
nameA string.
nodesAn array of associative arrays containing
 
domainA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)
ipAn IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1)
uniq_idA six-character identifier, containing only capital letters and digits.
region_idA valid id number (a positive integer).
servicesAn array of associative arrays containing
 
dest_portA valid network port number.
protocolA single word, consisting of only letters, digits, and underscores.
src_portA valid network port number.
session_persistenceA boolean value (0 or 1).
ssl_includesA boolean value (0 or 1).
ssl_terminationA boolean value (0 or 1).
strategyA single word, consisting of only letters and digits.
uniq_idA six-character identifier, containing only capital letters and digits.
vipAn IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1)
page_numA positive integer value (i.e. 1 and up).
page_sizeA positive integer value (i.e. 1 and up).
page_totalA 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.stormondemand.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:

ParameterType
regionA positive integer value (i.e. 1 and up).

Returns:

FieldType
itemsAn array of associative arrays containing
 
domainA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)
ipAn IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1)
region_idA valid id number (a positive integer).
uniq_idA six-character identifier, containing only capital letters and digits.

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

removeNode

URL:

https://api.stormondemand.com/v1/Network/LoadBalancer/removeNode

Description:

Removes a single node from an existing loadbalancer.

Parameters:

ParameterTypeNotes
nodeAn IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1)* Required
uniq_idA six-character identifier, containing only capital letters and digits.* Required

Returns:

FieldType
capabilitiesAn associative array of arbitrary keys and values.
nameA string.
nodesAn array of associative arrays containing
 
domainA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)
ipAn IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1)
uniq_idA six-character identifier, containing only capital letters and digits.
region_idA valid id number (a positive integer).
servicesAn array of associative arrays containing
 
dest_portA valid network port number.
protocolA single word, consisting of only letters, digits, and underscores.
src_portA valid network port number.
session_persistenceA boolean value (0 or 1).
ssl_includesA boolean value (0 or 1).
ssl_terminationA boolean value (0 or 1).
strategyA single word, consisting of only letters and digits.
uniq_idA six-character identifier, containing only capital letters and digits.
vipAn 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.stormondemand.com/v1/Network/LoadBalancer/removeService

Description:

Removes a single service from an existing loadbalancer.

Parameters:

ParameterTypeNotes
src_portA valid network port number.* Required
uniq_idA six-character identifier, containing only capital letters and digits.* Required

Returns:

FieldType
capabilitiesAn associative array of arbitrary keys and values.
nameA string.
nodesAn array of associative arrays containing
 
domainA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)
ipAn IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1)
uniq_idA six-character identifier, containing only capital letters and digits.
region_idA valid id number (a positive integer).
servicesAn array of associative arrays containing
 
dest_portA valid network port number.
protocolA single word, consisting of only letters, digits, and underscores.
src_portA valid network port number.
session_persistenceA boolean value (0 or 1).
ssl_includesA boolean value (0 or 1).
ssl_terminationA boolean value (0 or 1).
strategyA single word, consisting of only letters and digits.
uniq_idA six-character identifier, containing only capital letters and digits.
vipAn 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.stormondemand.com/v1/Network/LoadBalancer/strategies

Description:

Get a list of available strategies, with extra descriptive information.

Parameters:

No Values Defined

Returns:

FieldType
strategiesAn array of associative arrays containing
 
descriptionA string.
nameA string consisting of only letters, digits, hyphens, spaces, and underscores.
strategyA single word, consisting of only letters and digits.

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

update

URL:

https://api.stormondemand.com/v1/Network/LoadBalancer/update

Description:

Update an existing loadbalancer. Valid loadbalance strategies can be found using the /Network/LoadBalancer/strategies method.

Parameters:

ParameterTypeNotes
nameA string permitting tabs, carriage returns and newlines (Maximum length: 60)
nodesAn array of an IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1)
servicesAn 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.
session_persistenceA boolean value (0 or 1).
ssl_certAn ssl X509 public certificate, including the BEGIN CERTIFICATE and END CERTIFICATE comments.* Required if:
  • ssl_termination is set to '1'
ssl_includesA boolean value (0 or 1).
ssl_intAn ssl X509 public certificate, including the BEGIN CERTIFICATE and END CERTIFICATE comments.* Required if:
  • ssl_includes is set to '1'
ssl_keyA private key, including the BEGIN PRIVATE KEY and END PRIVATE KEY comments.* Required if:
  • ssl_termination is set to '1'
ssl_terminationA boolean value (0 or 1).
strategyA single word, consisting of only letters and digits.
uniq_idA six-character identifier, containing only capital letters and digits.* Required

Returns:

FieldType
capabilitiesAn associative array of arbitrary keys and values.
nameA string.
nodesAn array of associative arrays containing
 
domainA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)
ipAn IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1)
uniq_idA six-character identifier, containing only capital letters and digits.
region_idA valid id number (a positive integer).
servicesAn array of associative arrays containing
 
dest_portA valid network port number.
protocolA single word, consisting of only letters, digits, and underscores.
src_portA valid network port number.
session_persistenceA boolean value (0 or 1).
ssl_includesA boolean value (0 or 1).
ssl_terminationA boolean value (0 or 1).
strategyA single word, consisting of only letters and digits.
uniq_idA six-character identifier, containing only capital letters and digits.
vipAn 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