Overview
Error Handling

Methods

API Documentation (API Version v1)

VPN/

DESCRIPTION

This section contains methods to manage the VPN service of a particular account.

create

URL:

https://api.stormondemand.com/v1/VPN/create

Description:

create a new VPN service.

Parameters:

ParameterTypeNotes
domainA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)* Required
featuresAn associative array of arbitrary keys and values.* Required
region_idAn integer value.* Required

Returns:

FieldType
activeA boolean value (0 or 1).
activeStatusA single word, consisting of only letters and digits.
current_usersA non-negative integer value (i.e. 0 and up).
domainA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)
max_usersA positive integer value (i.e. 1 and up).
network_rangeAn array of an IPv4 IP address, in quad-dotted decimal notation, with a cidr mask (i.e. 127.0.0.1/32, 192.168.1.0/24)
region_idA positive integer value (i.e. 1 and up).
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

details

URL:

https://api.stormondemand.com/v1/VPN/details

Description:

Get information about VPN access for this account.

Parameters:

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

Returns:

FieldType
activeA boolean value (0 or 1).
activeStatusA single word, consisting of only letters and digits.
current_usersA non-negative integer value (i.e. 0 and up).
domainA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)
max_usersA positive integer value (i.e. 1 and up).
network_rangeAn array of an IPv4 IP address, in quad-dotted decimal notation, with a cidr mask (i.e. 127.0.0.1/32, 192.168.1.0/24)
region_idA positive integer value (i.e. 1 and up).
uniq_idA six-character identifier, containing only capital letters and digits.
vpnAn associative array containing the values:
 
current_usersA non-negative integer value (i.e. 0 and up).
max_usersA positive integer value (i.e. 1 and up).
network_rangeAn array of an IPv4 IP address, in quad-dotted decimal notation, with a cidr mask (i.e. 127.0.0.1/32, 192.168.1.0/24)

Possible Errors:

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

list

URL:

https://api.stormondemand.com/v1/VPN/list

Description:

Lists the authorized VPN users for a given accnt.

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
uniq_idA six-character identifier, containing only capital letters and digits.

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
 
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)
user_idA non-negative integer value (i.e. 0 and up).
usernameA subaccnt username consisting of up to 20 characters (letters, numbers, hyphens, periods and underscores).
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/VPN/update

Description:

Update the features of a VPN service.

Parameters:

ParameterTypeNotes
domainA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)
featuresAn associative array of arbitrary keys and values.
uniq_idA six-character identifier, containing only capital letters and digits.* Required

Returns:

FieldType
activeA boolean value (0 or 1).
activeStatusA single word, consisting of only letters and digits.
current_usersA non-negative integer value (i.e. 0 and up).
domainA fully-qualified domain name (i.e. liquidweb.com, www.liquidweb.com, etc)
max_usersA positive integer value (i.e. 1 and up).
network_rangeAn array of an IPv4 IP address, in quad-dotted decimal notation, with a cidr mask (i.e. 127.0.0.1/32, 192.168.1.0/24)
region_idA positive integer value (i.e. 1 and up).
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