Skip to main content
GET
/
projects
/
{projectName}
/
connections
List project database connections
curl --request GET \
  --url https://{organization}.data.credibledata.com/api/v0/projects/{projectName}/connections \
  --header 'Authorization: Bearer <token>'
[
  {
    "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>",
      "privateKey": "<string>",
      "privateKeyPass": "<string>",
      "warehouse": "<string>",
      "database": "<string>",
      "schema": "<string>",
      "role": "<string>",
      "responseTimeoutMilliseconds": 123
    },
    "trinoConnection": {
      "server": "<string>",
      "port": 123,
      "catalog": "<string>",
      "schema": "<string>",
      "user": "<string>",
      "password": "<string>",
      "peakaKey": "<string>"
    },
    "mysqlConnection": {
      "host": "<string>",
      "port": 123,
      "database": "<string>",
      "user": "<string>",
      "password": "<string>"
    },
    "duckdbConnection": {
      "attachedDatabases": [
        {
          "name": "test_connection, _connection, test_connection_1",
          "type": "bigquery",
          "attributes": {
            "dialectName": "<string>",
            "isPool": true,
            "canPersist": true,
            "canStream": true
          },
          "bigqueryConnection": {
            "defaultProjectId": "<string>",
            "billingProjectId": "<string>",
            "location": "<string>",
            "serviceAccountKeyJson": "<string>",
            "maximumBytesBilled": "<string>",
            "queryTimeoutMilliseconds": "<string>"
          },
          "snowflakeConnection": {
            "account": "<string>",
            "username": "<string>",
            "password": "<string>",
            "privateKey": "<string>",
            "privateKeyPass": "<string>",
            "warehouse": "<string>",
            "database": "<string>",
            "schema": "<string>",
            "role": "<string>",
            "responseTimeoutMilliseconds": 123
          },
          "postgresConnection": {
            "host": "<string>",
            "port": 123,
            "databaseName": "<string>",
            "userName": "<string>",
            "password": "<string>",
            "connectionString": "<string>"
          },
          "gcsConnection": {
            "keyId": "<string>",
            "secret": "<string>"
          },
          "s3Connection": {
            "accessKeyId": "<string>",
            "secretAccessKey": "<string>",
            "region": "us-east-1",
            "endpoint": "<string>",
            "sessionToken": "<string>"
          }
        }
      ]
    },
    "motherduckConnection": {
      "accessToken": "<string>",
      "database": "<string>"
    }
  }
]

Authorizations

Authorization
string
header
required

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

Path Parameters

projectName
string
required

Name of the project Standard identifier pattern for resource names

Pattern: ^[a-zA-Z0-9_-]+$

Response

A list of database connections in the project

resource
string

Resource path to the connection

name
string

Name of the connection

type
enum<string>

Type of database connection

Available options:
postgres,
bigquery,
snowflake,
trino,
mysql,
duckdb,
motherduck
attributes
object

Connection capabilities and configuration attributes

postgresConnection
object

PostgreSQL database connection configuration

bigqueryConnection
object

Google BigQuery database connection configuration

snowflakeConnection
object

Snowflake database connection configuration

trinoConnection
object

Trino database connection configuration

mysqlConnection
object

MySQL database connection configuration

duckdbConnection
object

DuckDB database connection configuration

motherduckConnection
object

MotherDuck database connection configuration