Sign in
latestOpenAPI 3.1.0Proprietary2026-08-175035117.5 KB

019f79ecdd6c

Resources

Create a connection

Creates a connection to a data warehouse.

The config object depends on provider_id and on the authentication method — see the examples below. Secrets you send here are stored encrypted and never returned by any endpoint.

post/v3/connections

Request body

namestring required
provider_id'bigquery' | 'snowflake' | 'redshift' | 'postgres' | 'databricksRest' | 'databricksWarehouse' | 'oracle' required
configobject required

Provider-specific configuration. type selects the authentication method and credentials holds the secrets — see the examples.

privacy'private' | 'shared'
groupIdsstring[]

Required when privacy is shared.

Response

The connection was created.

idstring uuid
namestring
provider_idstring
user_idstring
account_idstring
privacy'private' | 'shared'
configobject
created_atstring date-time
updated_atstring date-time