Create a new connection

Create a new virtual connection. For increased security, connection endpoints require an Enterprise Admin Token. This token can be found under Advanced Settings.

Path Params
string
required
Query Params
boolean
Defaults to true

Validate connection before save

Body Params
advancedProperties
object

Advanced properties

credentials
object

Database Credentials

string
length between 0 and 256

Database/Schema Logical Name

string

Database Host

string
length between 0 and 1024

Connection name

int32
1 to 65535

Database Port

properties
object

Properties such as auto commit, isolation level etc.

sshTunnel
object

ssh tunnel configuration

boolean

Is ssl required

string
length between 0 and 100000

trusted server certificates

string
enum

Database Type

boolean

Should this connection use a private key?

boolean

Should server certificate be verified

Response

Language
Credentials
Bearer
JWT
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json