Skip to main content
POST
Create a connector

Authorizations

Authorization
string
header
required

API key passed as a Bearer token in the Authorization header.

Body

application/json
dataPlaneName
string
defaultDatabase
null | string
environmentUUID
null | string<uuid>
label
string
sharedConfig
object | null
sshTunnelUUID
null | string<uuid>
type
string
uuid
string

Response

OK

companyUUID
string<uuid>
required
createdAt
string<date-time>
required
environmentUUID
string<uuid>
required
isValid
boolean
required
label
string
required
type
enum<string>
required
Available options:
api,
bigquery,
clickhouse,
cockroach,
databricks,
documentdb,
delta,
dynamodb,
gcs,
iceberg,
keyspaces,
mongodb,
motherduck,
mssql,
mysql,
oracle,
planetscale,
postgresql,
redis,
redshift,
s3,
snowflake
updatedAt
string<date-time>
required
uuid
string<uuid>
required
connectionLabel
string
dataPlaneName
null | string
defaultDatabase
string
sharedConfig
any
sshTunnelUUID
null | string<uuid>