Overview
Error Handling

Methods

API Documentation (API Version bleed)

Asset/Network/Private/VPN/

Description

Methods for working with a VPN sub-account's in Global Private (network) Fabric(s)

configurations

URL:

https://api.liquidweb.com/bleed/Asset/Network/Private/VPN/configurations

Description:

Configurations for a VPN service in a Global Private (network) Fabric

Parameters:

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

Returns:

FieldTypeNotes
configurationsAn array of associative arrays containing * Optional
 
display_nameA string of text, containing no newlines or other control characters.
idA positive integer value (i.e. 1 and up).

Possible Errors:

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

create

URL:

https://api.liquidweb.com/bleed/Asset/Network/Private/VPN/create

Description:

Create of a VPN service in a Global Private (network) Fabric

Parameters:

ParameterTypeNotes
alsowithA single word, consisting of only letters, digits, and underscores.
nameA string of text, containing no newlines or other control characters.
network_private_idA valid id number (a positive integer).* Required
optionsAn associative array of arbitrary keys and values.* Optional
  • Defaults to: HASH(0x64d73d8)
rate_limitA positive integer value (i.e. 1 and up).* Required
region_idA valid id number (a positive integer).* Required
remote_ipAn IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1)* Required
remote_network_onlyA boolean value (0 or 1).* Required
remote_networksAn 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)
vpn_typeA product option value.* Required

Returns:

FieldTypeNotes
idA valid id number (a positive integer).
network_private_idA valid id number (a positive integer).
remote_idA valid UUID (Universally Unique IDentifier).
remote_ipAn IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1)
remote_network_onlyA boolean value (0 or 1).
remote_networksAn 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)* Optional
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/Asset/Network/Private/VPN/details

Description:

Details of a VPN service in a Global Private (network) Fabric

Parameters:

ParameterTypeNotes
alsowithA single word, consisting of only letters, digits, and underscores.
uniq_idA six-character identifier, containing only capital letters and digits.* Required

Returns:

FieldTypeNotes
idA valid id number (a positive integer).
network_private_idA valid id number (a positive integer).
remote_idA valid UUID (Universally Unique IDentifier).
remote_ipAn IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1)
remote_network_onlyA boolean value (0 or 1).
remote_networksAn 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)* Optional
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

guide

URL:

https://api.liquidweb.com/bleed/Asset/Network/Private/VPN/guide

Description:

Configurations for a VPN service in a Global Private (network) Fabric

Parameters:

ParameterTypeNotes
configuration_idA positive integer value (i.e. 1 and up).* Required
typeOne of: 'html', 'md'* Optional
  • Defaults to: md
uniq_idA six-character identifier, containing only capital letters and digits.* Required

Returns:

FieldType
configurationA string permitting tabs, carriage returns and newlines

Possible Errors:

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

list

URL:

https://api.liquidweb.com/bleed/Asset/Network/Private/VPN/list

Description:

Returns a list of Global Private (network) Fabric VPNs

Parameters:

ParameterTypeNotes
alsowithA single word, consisting of only letters, digits, and underscores.
network_private_idA valid id number (a positive integer).
order_byAn associative array containing the fields:
 
fieldOne of: 'id', 'network_private_id', 'remote_id', 'remote_networks_only', 'uniq_id'* Required
sortOne of: 'asc', 'desc'* Optional
  • Defaults to: desc
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
 
idA valid id number (a positive integer).
network_private_idA valid id number (a positive integer).
remote_ipAn IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1)
remote_network_onlyA boolean value (0 or 1).
remote_networksAn 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)* Optional
uniq_idA six-character identifier, containing only capital letters and digits.
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.liquidweb.com/bleed/Asset/Network/Private/VPN/update

Description:

Update a VPN service in a Global Private (network) Fabric

Parameters:

ParameterTypeNotes
alsowithA single word, consisting of only letters, digits, and underscores.
nameA string of text, containing no newlines or other control characters.
optionsAn associative array of arbitrary keys and values.
rate_limitA positive integer value (i.e. 1 and up).
remote_ipAn IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1)
remote_networksAn 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)
uniq_idA six-character identifier, containing only capital letters and digits.* Required

Returns:

FieldTypeNotes
idA valid id number (a positive integer).
network_private_idA valid id number (a positive integer).
remote_idA valid UUID (Universally Unique IDentifier).
remote_ipAn IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1)
remote_network_onlyA boolean value (0 or 1).
remote_networksAn 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)* Optional
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

validateRemoteIp

URL:

https://api.liquidweb.com/bleed/Asset/Network/Private/VPN/validateRemoteIp

Description:

Validate remote (gateway) IP can be used to create a VPN

Parameters:

ParameterTypeNotes
network_private_idA valid id number (a positive integer).* Required
region_idA valid id number (a positive integer).* Required
remote_ipAn IPv4 IP address, in quad-dotted decimal notation (i.e. 127.0.0.1)* Required
vpn_typeA product option value.* Required

Returns:

FieldType
successA boolean value (0 or 1).

Possible Errors:

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

validateRemoteNetworks

URL:

https://api.liquidweb.com/bleed/Asset/Network/Private/VPN/validateRemoteNetworks

Description:

Validate remote networks can be used to create a VPN

Parameters:

ParameterTypeNotes
network_private_idA valid id number (a positive integer).* Required
remote_networksAn 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)

Returns:

FieldType
successA boolean value (0 or 1).

Possible Errors:

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