Sign in

v1

latestOpenAPI 3.1.02026-07-24188215268.7 KB
connections

Test a connection

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

post/connections/test

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

Successful operation

cleanupStartedboolean
cleanupSuccessboolean
configureStartedboolean
configureSuccessboolean
connectHoststring
connectStartedboolean
connectSuccessboolean
doneboolean

Is the ping operation 100% complete?

elapsednumber double
errorMessagestring

Failures

internalErrorboolean

Is the cause of a failure likely an internal bug in our code, not something users have control over?

queryStartedboolean
querySuccessboolean
queryTextstring
serverDescriptionstring

Technical string describing the location of the database on the network. This may be a JDBC url.

serverType'ATHENA' | 'AZURESYNAPSE' | 'BIGQUERY' | 'DB2' | 'DENODO' | 'HIVE' | 'DATABRICKS' | 'INFOR_ION' | 'MYSQL' | 'ORACLE' | 'POSTGRESQL' | 'REDSHIFT' | 'SERVICENOW' | 'SNOWFLAKE' | 'SPARK' | 'SQLSERVER' | 'TABLEAU'
sslCertificateChainstring[]

If the ping failed due to an SSL issue

sslCertificateNameProblemboolean

Did the ping fail because the server's name didn't match the name in the certificate?

sslCertificateTrustPathProblemboolean

Did the ping fail because it didn't trust the server's certificate due to a lack of a path to a root CA?

sslNotSupportedboolean

Did the ping fail because it tried to use SSL but the server+port combination doesn't support SSL?

successboolean

Everything successfully done

tunnelHoststring
tunnelStartedboolean
tunnelSuccessboolean