PUT
/
team
/
{team_id}
/
connections
/
{connection_id}

Authorizations

Authorization
string
header
required

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

Path Parameters

team_id
string
required

ID of the team

connection_id
string
required

ID of the connection

Body

application/json
authentication
object

Used for API connections

firebaseServiceAccount
object

JSON object containing the Firebase service account credentials

host
string
name
string
options
object

Used for MongoDB, Postgres, and MySQL connections

password
string
port
string
project_ids
string[]
schema
object

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

ssl
boolean
default:
false
sslMode
string
default:
require
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
type
enum<string>
Available options:
mongodb,
api,
mysql,
postgres
username
string

Response

200 - application/json
active
boolean
default:
true
authentication
object

Used for API connections

connectionString
string

Used for MongoDB, Postgres, and MySQL connections

dbName
string
firebaseServiceAccount
object

JSON object containing the Firebase service account credentials

host
string
id
integer
name
string
oauth_id
string
options
object
password
string
port
string
project_ids
string[]
schema
object
srv
boolean
default:
false
ssl
boolean
default:
false
sslCa
string
sslCert
string
sslKey
string
sslMode
string
default:
require
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
team_id
integer
type
enum<string>
Available options:
mongodb,
api,
mysql,
postgres,
realtimedb,
firestore,
googleAnalytics,
customerio
username
string