Skip to main content
POST
/
connections
/
test
{
  "status": "ok",
  "errorMessage": "<string>"
}

Body

application/json

Database connection configuration and metadata

​
resource
string

Resource path to the connection

​
name
string

Name of the connection

​
type
enum<string>

Type of database connection

Available options:
postgres,
bigquery,
snowflake,
trino,
mysql
​
attributes
object

Connection capabilities and configuration attributes

​
postgresConnection
object

PostgreSQL database connection configuration

​
bigqueryConnection
object

Google BigQuery database connection configuration

​
snowflakeConnection
object

Snowflake database connection configuration

​
trinoConnection
object

Trino database connection configuration

​
mysqlConnection
object

MySQL database connection configuration

Response

Connection test result

Result of testing a database connection

​
status
enum<string>

Connection test result status

Available options:
ok,
failed
​
errorMessage
string

Error message if the connection test failed, null if successful

⌘I