Skip to main content
POST
Create a connection

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
type
enum<string>
required

Discriminator. Must be connections_dataset.

Available options:
connections_dataset
dataset_id
integer<int64>
required

The dataset whose data is routed to the connector.

profile_id
string<uuid>
required
quick_settings
object | null

Settings for the connector. Their shape belongs to the connector app. For dataset connections the connector checks them when the connection is created. Omitting the field and sending null both mean no settings.

Response

Created

A connection from a dataset or a model to a connector app. type says which, and only the matching id field (dataset_id or model_id) is sent.

type
enum<string>
required
Available options:
connections_dataset
id
string<uuid>
required
app
object
required

The connector app the data is sent to.

created_at
string<date-time>
required
dataset_id
integer<int64>
required

The dataset whose data is sent to the connector.

installation_id
integer<int64>
required

The app installation the profile belongs to.

profile_id
string<uuid>
required

The same value as profile.id. Prefer profile.id; this field is kept for older clients.

profile
object
required

The app profile the connection was created against.

status
enum<string>
required

Archived connections are never returned by these endpoints, so a response always says active.

Available options:
active,
archived
quick_settings
object | null

The settings the connection was created with, returned as sent. Their shape belongs to the connector app, so it differs from one connector to the next. null when the connection was created without settings.