Skip to main content
POST
/
team
/
{team_id}
/
connections
cURL
curl --request POST \
  --url https://api.chartbrew.com/team/{team_id}/connections \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "type": "mongodb",
  "team_id": 123,
  "subType": "timescaledb",
  "host": "<string>",
  "port": "<string>",
  "username": "<string>",
  "password": "<string>",
  "options": {},
  "authentication": {
    "type": "bearer_token",
    "token": "<string>",
    "user": "<string>",
    "pass": "<string>"
  },
  "firebaseServiceAccount": {},
  "ssl": false,
  "sslMode": "require",
  "schema": {}
}
'
{
  "id": 123,
  "team_id": 123,
  "project_ids": [
    "<string>"
  ],
  "oauth_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "type": "mongodb",
  "subType": "timescaledb",
  "active": true,
  "host": "<string>",
  "dbName": "<string>",
  "port": "<string>",
  "username": "<string>",
  "password": "<string>",
  "srv": false,
  "options": {},
  "connectionString": "<string>",
  "authentication": {
    "type": "bearer_token",
    "token": "<string>",
    "user": "<string>",
    "pass": "<string>"
  },
  "firebaseServiceAccount": {},
  "ssl": false,
  "sslMode": "require",
  "sslCa": "<string>",
  "sslCert": "<string>",
  "sslKey": "<string>",
  "schema": {}
}
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
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

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

Created connection

​
id
integer
​
team_id
integer
​
project_ids
string[]
​
oauth_id
string<uuid>
​
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