post

/connections/{owner}

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

Authorization

oauth2 - authorizationCode

Request Parameters

1 Path Parameter

Request Body

Schema
object
name
string

Connection name

4 validations
type
string

Database Type

1 validation + required
host
string

Database Host

1 validation + required
port
integer

Database Port

4 validations
database
string

Database/Schema Logical Name

4 validations
credentials
object
sshTunnel
object
sslRequired
boolean

Is ssl required

2 validations
verifyServerCertificate
boolean

Should server certificate be verified

2 validations
trustedServerCertificates
string

trusted server certificates

2 validations
properties
object

Properties such as auto commit, isolation level etc.

advancedProperties
object

Advanced properties

Responses

Connection created successfully.

Schema
object
message
string
uri
string

URI of newly created resource.

required

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
Path Params
1 path param not set
owner
$$.env
1 variable not set
oauth_access_token