Connections
Create a connection
Connections
Create a connection
Create a new connection inside a team
POST
/
team
/
{team_id}
/
connections
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",
"subType": "timescaledb",
"team_id": 123,
"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
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
ID of the team
Body
application/json
Response
200
application/json
Created connection
The response is of type object
.
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",
"subType": "timescaledb",
"team_id": 123,
"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": {}
}