Sign in

v1

latestOpenAPI 3.1.02026-07-24188215268.7 KB
connections

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.

post/connections/{owner}

Path parameters

ownerstring required

Query parameters

validateboolean

Validate connection before save

Request body

advancedPropertiesobject

Advanced properties

databasestring

Database/Schema Logical Name

hoststring

Database Host

namestring

Connection name

portinteger

Database Port

propertiesobject

Properties such as auto commit, isolation level etc.

sslRequiredboolean

Is ssl required

trustedServerCertificatesstring

trusted server certificates

type'ATHENA' | 'AZURESYNAPSE' | 'BIGQUERY' | 'DB2' | 'DENODO' | 'HIVE' | 'DATABRICKS' | 'INFOR_ION' | 'MYSQL' | 'ORACLE' | 'POSTGRESQL' | 'REDSHIFT' | 'SERVICENOW' | 'SNOWFLAKE' | 'SPARK' | 'SQLSERVER' | 'TABLEAU'

Database Type

usePrivateKeyboolean

Should this connection use a private key?

verifyServerCertificateboolean

Should server certificate be verified

Example request

{
  "credentials": {
    "password": "!AdHJfGgd@3#",
    "user": "johnsmith"
  },
  "database": "schemadw",
  "host": "dwserver.thinktank.com",
  "name": "Humanitarian_Aid",
  "port": 5432,
  "sshTunnel": {
    "host": "passthru.tunnel.ca",
    "port": 3454,
    "user": "johnsmith",
    "userKeyPair": true
  },
  "sslRequired": true,
  "type": "ATHENA",
  "verifyServerCertificate": true
}

Response

Connection created successfully.

messagestring
uristring uri required