API Reference

Search VPN connections

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

Returns a list of VPN connections.

A VPN connection is a set of configurations that define a secure, encrypted site-to-site connection between a tenant's on-premise SQL Server instances and their managed server instances on Data Bridge.

This operation supports filtering VPN configurations by customerGatewayIp or bgpRouting. Responses can be sorted by vpnConnectionId.

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

Query Params
string

Query string to select response data based on property values.

ParameterTypeComparisionList
awsVpnConnectionIdString=, !=IN, NOT IN
bgpRoutingString=, !=IN, NOT IN
commentsString=, !=, LIKE, NOT LIKEIN, NOT IN
createdAtTimestamp=, !=, <, >, <=, >=
createdByString=, !=, LIKE, NOT LIKEIN, NOT IN
customerBgpAsnNumber=, !=, <, >, <=, >=IN, NOT IN
customerGatewayIpString=, !=IN, NOT IN
enabledAtTimestamp=, !=, <, >, <=, >=
encryptionKeyIdNumber=, !=, <, >, <=, >=IN, NOT IN
encryptionTypeString=, !=IN, NOT IN
idNumber=, !=, <, >, <=, >=IN, NOT IN
irpBgpAsnNumber=, !=, <, >, <=, >=IN, NOT IN
statusString=, !=IN, NOT IN
vpnConnectionNameString=, !=, LIKE, NOT LIKEIN, NOT IN

All properties support the AND logical operator. To learn more, see Response Filtering.

string

Comma-delimited list of properties. Sort order defined by one of ASC (ascending) or DESC (descending).

int32
≤ 1000
Defaults to 100

Number of records returned per page. See Response Pagination.

int32
Defaults to 0

Number of page displaying the returned records.

Responses

Updated 3 months ago

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

Updated 3 months ago