POST
/
team
/
{team_id}
/
connections

If your connection requires SSL certificates, you’ll need to upload them using the update connection files endpoint after creating the connection.

Authorizations

Authorization
string
headerrequired

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

Path Parameters

team_id
string
required

ID of the team

Body

application/json
name
string
required
type
enum<string>
required
Available options:
mongodb,
api,
mysql,
postgres,
realtimedb,
firestore,
googleAnalytics,
customerio
team_id
integer
required
subType
enum<string>

Used for connections based on main types

Available options:
timescaledb,
supabasedb,
rdsPostgres,
rdsMysql,
api,
mongodb,
api,
mysql,
postgres,
realtimedb,
firestore,
googleAnalytics,
customerio
host
string
port
string
username
string
password
string
options
object

Used for MongoDB, Postgres, and MySQL connections

authentication
object

Used for API connections

firebaseServiceAccount
object

JSON object containing the Firebase service account credentials

ssl
boolean
default: false
sslMode
string
default: require
schema
object

Used for Postgres and MySQL. This gets populated automatically whenever the connection is used in a chart.

Response

200 - application/json
id
integer
team_id
integer
project_ids
string[]
oauth_id
string
name
string
type
enum<string>
Available options:
mongodb,
api,
mysql,
postgres,
realtimedb,
firestore,
googleAnalytics,
customerio
subType
enum<string>

Used for connections based on main types

Available options:
timescaledb,
supabasedb,
rdsPostgres,
rdsMysql,
api,
mongodb,
api,
mysql,
postgres,
realtimedb,
firestore,
googleAnalytics,
customerio
active
boolean
default: true
host
string
dbName
string
port
string
username
string
password
string
srv
boolean
default: false
options
object
connectionString
string

Used for MongoDB, Postgres, and MySQL connections

authentication
object

Used for API connections

firebaseServiceAccount
object

JSON object containing the Firebase service account credentials

ssl
boolean
default: false
sslMode
string
default: require
sslCa
string
sslCert
string
sslKey
string
schema
object