Test database connection configuration

Validates a database connection configuration without adding it to any environment. This endpoint allows you to test connection parameters, credentials, and network connectivity before committing the connection to an environment. Useful for troubleshooting connection issues and validating configurations during setup.

POST/connections/test

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

Database connection configuration and metadata

resource?string

Resource path to the connection

name?string

Name of the connection

type?string

Type of database connection

Value in

"postgres"
"bigquery"
"snowflake"
"trino"
"databricks"
"mysql"
"duckdb"
"motherduck"
"ducklake"
"publisher"

fingerprint?string

Optional, opaque, stable fingerprint of this connection's data identity. It is a hash of the configuration that determines which data the connection reaches (its data-locating settings), and deliberately excludes credentials and other secret values, so it stays constant across credential rotation and changes only when the connection is pointed at different data. When present, it is used as this connection's contribution to content-addressed build identifiers so that builds re-address only when the underlying data identity actually changes; consumers should treat it as an opaque token and use the supplied value verbatim rather than deriving their own. This field is optional — when omitted, a connection identity is derived locally instead.

attributes?

Connection capabilities and configuration attributes

proxy?

Optional network proxy through which the connection is reached. Applies to any connection type whose database is not directly reachable (e.g. behind a bastion). The proxy is established below the driver, so the driver connects to a local endpoint transparently. Modeled as a discriminated union on type so additional proxy mechanisms can be added later.

postgresConnection?

PostgreSQL database connection configuration

bigqueryConnection?

Google BigQuery database connection configuration

snowflakeConnection?

Snowflake database connection configuration

trinoConnection?

Trino database connection configuration

databricksConnection?

Databricks SQL warehouse connection configuration

mysqlConnection?

MySQL database connection configuration

duckdbConnection?

DuckDB database connection configuration. Publisher intentionally exposes only data-source intent here. Database files, working directories, filesystem/network policy, extension loading, setup SQL, temp directories, and resource knobs are owned by Publisher so environment configs cannot widen deployment policy through low-level DuckDB settings.

motherduckConnection?

MotherDuck database connection configuration

ducklakeConnection?

DuckLake lakehouse connection configuration

publisherConnection?

Malloy Publisher proxy connection. Proxies SQL to a remote Publisher dataplane instead of connecting to a warehouse directly. The remote dataplane owns authentication, access control, and read-only enforcement.

Response Body

`application/json`

curl --request POST \  --url 'https://example.com/connections/test' \  --header 'Authorization: Bearer <token>' \  --header 'Content-Type: application/json' \  --data '{}'

{  "status": "ok",  "errorMessage": "string"}

Test database connection configuration

Authorization

Request Body

Response Body

200application/json

400application/json

401application/json

404application/json

500application/json

503application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`