Skip to main content
POST
Create Connector

Authorizations

Authorization
string
header
required

API key or JWT token

Body

application/json
config
object
required

A connector's type, display name, and type-specific connection metadata.

Set exactly one metadata field matching connector_type (e.g. connector_type: POSTGRES ⇒ set postgres). The common database types are documented below; every supported type follows the same shape — see the proto ConnectorConfig for the full list (Snowflake, BigQuery, Databricks, Tableau, PowerBI, SQL Server, Trino, etc.).

Confidential fields (passwords, keys, tokens) are write-only: they are never returned by read endpoints, and on update they are preserved from the stored connector when sent empty.

access
object

Access configuration applied atomically with creation. Grants are validated before the connector is created, so an invalid grant never leaves a partially configured connector. When omitted, the connector is created org-visible (is_public: true). The creating member always receives an owner grant.

Response

Created connector

id
integer<int32>

Connector ID

name
string

Connector name

type
string

Connector type