API Reference

Create VPN connection

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

Creates a VPN connection.

A VPN connection is a set of configurations that defines an encrypted connection between the tenant's network and their Data Bridge cluster. The tenant can use this connection to send a receive data between on-premise SQL Server instances and managed server instances on Data Bridge.

The VPN connection can only be used if an encryption key (encryptionKeyResourceId) is assigned and vpnStatus is on.

📷

Note

Licensed Data Bridge tenants can enable access to Data Bridge cluster using either VPN connection or a Data Bridge access control list (ACL).

If the tenant's VPN connection is off, the address listed in the Data Bridge ACL can access Data Bridge. Once the VPN connection is on, the Data Bridge ACL is ignored. To learn more, see Administer Data Bridge ACLs.

To perform this operation, the client must belong to a group that has been assigned the Admin or Data Bride Admin role.

🪰

entitlements

ic-vpn

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

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.

Responses
202

CREATE_VPN job submitted.

Updated 20 days ago

Language
Credentials
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated 20 days ago