Overview
Error Handling

Methods

API Documentation (API Version bleed)

VPN/User/

DESCRIPTION

This section contains methods to manage VPN users on particular accounts.

create

URL:

https://api.liquidweb.com/bleed/VPN/User/create

Description:

Create a new VPN user for a particular account.

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)
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

delete

URL:

https://api.liquidweb.com/bleed/VPN/User/delete

Description:

Remove a VPN user from this account. The user will still exist in the permissions system, but not have VPN access.

Parameters:

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

Returns:

FieldType
deletedA 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

details

URL:

https://api.liquidweb.com/bleed/VPN/User/details

Description:

Get information about a specific VPN user on this account.

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)
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

list

URL:

https://api.liquidweb.com/bleed/VPN/User/list

Description:

Get a list of the current users for this account.

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