Overview
Error Handling

Methods

API Documentation (API Version v1)

Network/Private/

DESCRIPTION

Private networking provides the option for several Storm servers to contact each other via a network interface that is a) not publicly routeable and b) not metered for bandwidth. Applications that communicate internally will frequently use this for both security and cost-savings.

This section of the API provides methods for attaching and detaching a server to a private network, and for querying information about an existing private network.

attach

URL:

https://api.stormondemand.com/v1/Network/Private/attach

Description:

Attach a given server to your private network.

Note: This will automatically create the private network, if it is not already created.

Parameters:

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

Returns:

FieldType
attachedA six-character identifier, containing only capital letters and digits.

Possible Errors:

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

detach

URL:

https://api.stormondemand.com/v1/Network/Private/detach

Description:

Detaches a given server to your private network.

Note: if this is the last server on your private network, the private vlan will be destroyed, so you will not be guaranteed the same private vlan id, should you re-enable private networking later.

Parameters:

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

Returns:

FieldType
detachedA six-character identifier, containing only capital letters and digits.

Possible Errors:

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

get

URL:

https://api.stormondemand.com/v1/Network/Private/get

Description:

Gets all of the servers attached to your private network, which zones they are in, and what IPs they are assigned.

Parameters:

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

Returns:

FieldType
zonesAn array of associative arrays containing
 
attachedAn 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.
idA positive integer value (i.e. 1 and up).
nameA string.
regionAn associative array containing the values:
 
idA positive integer value (i.e. 1 and up).
nameA string.
unattachedAn array of associative arrays containing
 
domainA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)
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

getIP

URL:

https://api.stormondemand.com/v1/Network/Private/getIP

Description:

Gets the current private IP for a particular server, if it has one.

Parameters:

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

Returns:

FieldType
ipA valid IP address (v4 or v6)
legacyA boolean value (0 or 1).
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

isAttached

URL:

https://api.stormondemand.com/v1/Network/Private/isAttached

Description:

Determine whether a given server is currently attached to your private network.

Parameters:

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

Returns:

FieldType
is_attachedA boolean value (0 or 1).

Possible Errors:

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