Skip to main content
GET
/
projects
/
{projectName}
/
connections
/
{connectionName}
{
  "resource": "<string>",
  "name": "<string>",
  "type": "postgres",
  "attributes": {
    "dialectName": "<string>",
    "isPool": true,
    "canPersist": true,
    "canStream": true
  },
  "postgresConnection": {
    "host": "<string>",
    "port": 123,
    "databaseName": "<string>",
    "userName": "<string>",
    "password": "<string>",
    "connectionString": "<string>"
  },
  "bigqueryConnection": {
    "defaultProjectId": "<string>",
    "billingProjectId": "<string>",
    "location": "<string>",
    "serviceAccountKeyJson": "<string>",
    "maximumBytesBilled": "<string>",
    "queryTimeoutMilliseconds": "<string>"
  },
  "snowflakeConnection": {
    "account": "<string>",
    "username": "<string>",
    "password": "<string>",
    "warehouse": "<string>",
    "database": "<string>",
    "schema": "<string>",
    "responseTimeoutMilliseconds": 123
  },
  "trinoConnection": {
    "server": "<string>",
    "port": 123,
    "catalog": "<string>",
    "schema": "<string>",
    "user": "<string>",
    "password": "<string>"
  },
  "mysqlConnection": {
    "host": "<string>",
    "port": 123,
    "database": "<string>",
    "user": "<string>",
    "password": "<string>"
  }
}

Path Parameters

​
projectName
string
required
​
connectionName
string
required

Response

​
resource
string
​
name
string
​
type
enum<string>
Available options:
postgres,
bigquery,
snowflake,
trino,
mysql
​
attributes
object
​
postgresConnection
object
​
bigqueryConnection
object
​
snowflakeConnection
object
​
trinoConnection
object
​
mysqlConnection
object