Overview
Error Handling

Methods

API Documentation (API Version bleed)

VPN/

DESCRIPTION

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

addUser

URL:

https://api.liquidweb.com/bleed/VPN/addUser

Description:

Create a new VPN user

Parameters:

ParameterTypeNotes
firstnameThe first, middle, or last name of an individual, up to 50 characters in length.
lastnameThe first, middle, or last name of an individual, up to 50 characters in length.
passwordA password of at least 6 characters and up to 30 characters in length, may contain spaces
usernameA subaccnt username consisting of up to 63 characters (letters, numbers, hyphens, underscores, periods, pluses, or at symbols).* Required

Returns:

FieldType
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 63 characters (letters, numbers, hyphens, underscores, periods, pluses, or at symbols).

Possible Errors:

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

authorized

URL:

https://api.liquidweb.com/bleed/VPN/authorized

Description:

Determine if a particular user is allowed to use the VPN. Returns the details of a single VPN user.

Parameters:

ParameterTypeNotes
usernameA subaccnt username consisting of up to 63 characters (letters, numbers, hyphens, underscores, periods, pluses, or at symbols).* Required

Returns:

FieldType
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

create

URL:

https://api.liquidweb.com/bleed/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.liquidweb.com/bleed/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 fields:
 
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.liquidweb.com/bleed/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 63 characters (letters, numbers, hyphens, underscores, periods, pluses, or at symbols).
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

removeUser

URL:

https://api.liquidweb.com/bleed/VPN/removeUser

Description:

Remove a VPN user

Parameters:

ParameterTypeNotes
usernameA subaccnt username consisting of up to 63 characters (letters, numbers, hyphens, underscores, periods, pluses, or at symbols).* Required

Returns:

FieldType
removedA subaccnt username consisting of up to 63 characters (letters, numbers, hyphens, underscores, periods, pluses, or at symbols).

Possible Errors:

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

update

URL:

https://api.liquidweb.com/bleed/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