Overview
Error Handling

Methods

API Documentation (API Version v1)

Network/Pool/

DESCRIPTION

Through these api methods, you can manage network IP Pools.

create

URL:

https://api.stormondemand.com/v1/Network/Pool/create

Description:

Create a new IP Pool

Parameters:

ParameterTypeNotes
add_ipsAn array of an IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1)* Required if:
  • new_ips is not given
new_ipsA non-negative integer value (i.e. 0 and up).* Required if:
  • add_ips is not given
zone_idA positive integer value (i.e. 1 and up).* Required

Returns:

FieldType
accntA valid account number, up to 6 digits in length.
assignmentsAn array of associative arrays containing
 
begin_rangeAn IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1)
broadcastAn IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1)
end_rangeAn 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).
netmaskAn IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1)
networkA valid IP address (v4 or v6) with a mask
primaryA boolean value (0 or 1).* Optional
zone_idA positive integer value (i.e. 1 and up).
idA positive integer value (i.e. 1 and up).
uniq_idA six-character identifier, containing only capital letters and digits.
zone_idA positive integer value (i.e. 1 and up).

Possible Errors:

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

delete

URL:

https://api.stormondemand.com/v1/Network/Pool/delete

Description:

Deletes the given pool, and all the assignments that are only in the pool.

Parameters:

ParameterTypeNotes
subaccntA positive integer value (i.e. 1 and up).* Required if:
  • uniq_id is not given
uniq_idA six-character identifier, containing only capital letters and digits.

Returns:

FieldType
deletedA positive integer value (i.e. 1 and up).

Possible Errors:

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

details

URL:

https://api.stormondemand.com/v1/Network/Pool/details

Description:

Returns the details of a given IP pool.

Parameters:

ParameterTypeNotes
free_onlyA boolean value (0 or 1).
idA positive integer value (i.e. 1 and up).* Required if:
  • uniq_id is not given
subaccntA positive integer value (i.e. 1 and up).* Required if:
  • id is not given
  • uniq_id is not given
uniq_idA six-character identifier, containing only capital letters and digits.* Required if:
  • id is not given

Returns:

FieldType
accntA valid account number, up to 6 digits in length.
assignmentsAn array of associative arrays containing
 
begin_rangeAn IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1)
broadcastAn IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1)
end_rangeAn 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).
netmaskAn IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1)
networkA valid IP address (v4 or v6) with a mask
primaryA boolean value (0 or 1).* Optional
zone_idA positive integer value (i.e. 1 and up).
idA positive integer value (i.e. 1 and up).
uniq_idA six-character identifier, containing only capital letters and digits.
zone_idA positive integer value (i.e. 1 and up).

Possible Errors:

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

list

URL:

https://api.stormondemand.com/v1/Network/Pool/list

Description:

Gets a list of network assignments for a particular IP Pool.

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
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
 
idA positive integer value (i.e. 1 and up).
zone_idA positive integer value (i.e. 1 and up).
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

update

URL:

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

Description:

Update an existing IP Pool

Parameters:

ParameterTypeNotes
add_ipsAn array of an IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1)
idA positive integer value (i.e. 1 and up).* Required if:
  • uniq_id is not given
new_ipsA non-negative integer value (i.e. 0 and up).
remove_ipsAn array of an IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1)
subaccntA positive integer value (i.e. 1 and up).* Required if:
  • id is not given
  • uniq_id is not given
uniq_idA six-character identifier, containing only capital letters and digits.* Required if:
  • id is not given

Returns:

FieldType
accntA valid account number, up to 6 digits in length.
assignmentsAn array of associative arrays containing
 
begin_rangeAn IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1)
broadcastAn IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1)
end_rangeAn 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).
netmaskAn IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1)
networkA valid IP address (v4 or v6) with a mask
primaryA boolean value (0 or 1).* Optional
zone_idA positive integer value (i.e. 1 and up).
idA positive integer value (i.e. 1 and up).
uniq_idA six-character identifier, containing only capital letters and digits.
zone_idA positive integer value (i.e. 1 and up).

Possible Errors:

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