Overview
Error Handling

Methods

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.stormondemand.com/v1/Network/IP/add

Description:

Add a number of IPs to an existing server. If the 'reboot' flag is passed in, the server will be stopped, have the new IP addresses configured, and then be rebooted.

Note: each account has a per-server IP limit defined. By default, that limit is 8 IP addresses 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.

Parameters:

ParameterTypeNotes
ip_countA positive integer value (i.e. 1 and up).* Required
rebootA boolean value (0 or 1).
uniq_idA six-character identifier, containing only capital letters and digits.* Required

Returns:

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

Description:

Gets information about a particular IP.

Parameters:

ParameterTypeNotes
ipAn 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
broadcastAn IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1)
gatewayAn IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1)
idA positive integer value (i.e. 1 and up).
ipAn IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1)
netmaskAn 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/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:

ParameterTypeNotes
alsowithA single word, consisting of only letters, digits, and underscores.
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
uniq_idA six-character identifier, containing only capital letters and digits.* Required

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
 
broadcastAn IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1)
gatewayAn IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1)
idA positive integer value (i.e. 1 and up).
ipAn IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1)
netmaskAn IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1)
reverse_dnsA hostname or fully-qualified domain name (i.e. localhost, liquidweb.com, www.liquidweb.com, etc)* Optional
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

listAccntPublic

URL:

https://api.stormondemand.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:

ParameterTypeNotes
include_poolsA boolean value (0 or 1).
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
zone_idA 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
 
domainA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)
ipA valid IP address (v4 or v6)
primaryA boolean value (0 or 1).
uniq_idA six-character identifier, containing only capital letters and digits.
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

listPublic

URL:

https://api.stormondemand.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:

ParameterTypeNotes
alsowithA single word, consisting of only letters, digits, and underscores.
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
uniq_idA six-character identifier, containing only capital letters and digits.* Required

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
 
broadcastAn IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1)
gatewayAn IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1)
idA positive integer value (i.e. 1 and up).
ipAn IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1)
netmaskAn IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1)
reverse_dnsA hostname or fully-qualified domain name (i.e. localhost, liquidweb.com, www.liquidweb.com, etc)* Optional
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

remove

URL:

https://api.stormondemand.com/v1/Network/IP/remove

Description:

Remove a specific IP from a server. If the 'reboot' flag is passed in, the server will be stopped, have the old IP addresses removed, and then be rebooted.

Note: At this time, it is impossible to remove the server's primary IP using the API

Parameters:

ParameterTypeNotes
ipAn IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1)* Required
rebootA boolean value (0 or 1).
uniq_idA six-character identifier, containing only capital letters and digits.* Required

Returns:

FieldType
removingAn 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.stormondemand.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:

ParameterTypeNotes
ip_countA positive integer value (i.e. 1 and up).* Required
uniq_idA six-character identifier, containing only capital letters and digits.* Required
usage_justificationA string permitting tabs, carriage returns and newlines

Returns:

FieldType
addingA string consisting of only letters, digits, hyphens, spaces, and underscores.

Possible Errors:

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