API Reference

Update VPN connection

patch
https://{host}/platform/tenantdata/v1/vpn-connections/
Path Params
int64
required

ID of VPN connection.

Body Params

VPN connection update request

Request body to update a VPN connection (full replacement or UPDATE_VPN job fields).

customerGatewayIps
array of strings
length ≥ 0

List of 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

Status of VPN.

VPN status detrermines status of assigned encryption key.

  • If off, status of encryption key is set to AVAILABLE.
  • If on, status of encryption key is set to IN-USE.
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

The autonomous system number assigned to the BGP autonomous system. Can be set if supported by the tenant's network configuration.

tunnelSettings
array of objects

List of VPN tunnels with the specified inside link addressing.

tunnelSettings
Responses

202

UPDATE_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?