API Reference

Create VPN connection

post
https://{host}/platform/tenantdata/v1/vpn-connections
Body Params

CREATE_VPN job settngs.

customerGatewayIps
array of strings
length ≥ 0

List of customer on-premises gateway public IP addresses.

customerGatewayIps
string
length between 0 and 50

Comments for reference.

boolean

If true, VPN uses BGP routing; if false, VPN uses static or policy-based routing as applicable.

string
^$|^[0-9]{1,10}$

Autonomous system number assigned to the customer BGP autonomous system.

customerSubnetIps
array of strings
length ≤ 10

Customer CIDRs advertised or reachable over the VPN. Up to 10.

customerSubnetIps
string

Method of provisioning IPSec keying material, e.g. preSharedKey.

int64

ID of encryption key to use.

enabledApps
array of strings

List of Intelligent Risk Platform applications.

enabledApps
string
enum

Initial status of VPN connection. One of on or off.

Allowed:
string

CIDR block of non-overlapping address space in the private cloud for the tenant. Used to avoid conflict with the tenant's on-premises range.

string

Autonomous system number assigned to the Intelligent Risk Platform BGP autonomous system.

Honored only when supported by the tenant's network configuration. If it does not apply, the value is ignored and the skip is recorded in the job details.

tunnelSettings
array of objects

List of tunnels with the requested inside link addressing.

tunnelSettings
Responses
202

CREATE_VPN job submitted.

Updated about 6 hours ago

Did this page help you?
Language
Credentials
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated about 6 hours ago

Did this page help you?