Create database connection string
POST/v1/databases/{databaseId}/connections
Creates a new connection string for the given database.
AuthorizationBearer <token>
OAuth2 authentication
In: header
Scope: workspace:admin, offline_access
databaseId*string
Match^(db_)?([cC][^\s-]{8,}|[a-z0-9]+)$
application/json
TypeScript Definitions
Use the request body type in TypeScript.
application/json
Section titled “application/json”application/json
Section titled “application/json”application/json
Section titled “application/json”curl -X POST "https://example.com/v1/databases/string/connections" \
-H "Content-Type: application/json" \
-d '{
"name": "string"
}'{
"data": {
"id": "string",
"type": "connection",
"url": "http://example.com",
"name": "string",
"createdAt": "2019-08-24T14:15:22Z",
"kind": "postgres",
"endpoints": {
"direct": {
"host": "string",
"port": 0,
"connectionString": "string"
},
"pooled": {
"host": "string",
"port": 0,
"connectionString": "string"
},
"accelerate": {
"host": "string",
"port": 0,
"connectionString": "string"
}
},
"connectionString": "string",
"directConnection": {
"host": "string",
"pass": "string",
"user": "string"
},
"database": {
"id": "string",
"url": "http://example.com",
"name": "string"
},
"host": "string",
"pass": "string",
"user": "string"
}
}