API Reference

Create encryption key

post
https://{host}/platform/tenantdata/v1/encryption-keys

Creates a VPN encryption key.

A VPN encryption key defines shared secret between a tenant and the Intelligent Risk Platform. The VPN encryption key enables on-premise SQL Server instances on the tenant's network to connect to the tenant's Data Bridge cluster via a VPN connection.

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

🪰

Entitlements

IC-VPN

Body Params
string
required

Type of encryption key, i.e. vpn.

string
required

Subtype of encryption key, i.e. pre-shared-key.

string
required
length between 3 and 100

Name of encryption key.

string
length between 8 and 256

Value of encryption key.

String consisting of 8-26 characters that defines a pre-shared key that can be used to secure traffic on a VPN connection.

Displayed as masked value in responses: 12 asterisks followed by last four characters of key, e.g., ************abcd

Responses
201

Encryption key created successfully.

Updated 2 months ago

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

Updated 2 months ago