List project database connections

Retrieves a list of all database connections configured for the specified project. Each connection includes its configuration, type, and status information. This endpoint is useful for discovering available data sources within a project.

GET /projects/{projectName}/connections

List project database connections

cURL

curl --request GET \
  --url https://{organization}.data.credibledata.com/api/v0/projects/{projectName}/connections \
  --header 'Authorization: Bearer <token>'

200

[
  {
    "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>"
          },
          "azureConnection": {
            "authType": "service_principal",
            "sasUrl": "<string>",
            "tenantId": "<string>",
            "clientId": "<string>",
            "clientSecret": "<string>",
            "accountName": "<string>",
            "fileUrl": "<string>"
          }
        }
      ]
    },
    "motherduckConnection": {
      "accessToken": "<string>",
      "database": "<string>"
    },
    "ducklakeConnection": {
      "storage": {
        "bucketUrl": "<string>",
        "s3Connection": {
          "accessKeyId": "<string>",
          "secretAccessKey": "<string>",
          "region": "us-east-1",
          "endpoint": "<string>",
          "sessionToken": "<string>"
        },
        "gcsConnection": {
          "keyId": "<string>",
          "secret": "<string>"
        }
      },
      "catalog": {
        "postgresConnection": {
          "host": "<string>",
          "port": 123,
          "databaseName": "<string>",
          "userName": "<string>",
          "password": "<string>",
          "connectionString": "<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

200

application/json

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, ducklake

attributes · object

Connection capabilities and configuration attributes

Show child attributes

postgresConnection · object

PostgreSQL database connection configuration

Show child attributes

bigqueryConnection · object

Google BigQuery database connection configuration

Show child attributes

snowflakeConnection · object

Snowflake database connection configuration

Show child attributes

trinoConnection · object

Trino database connection configuration

Show child attributes

mysqlConnection · object

MySQL database connection configuration

Show child attributes

duckdbConnection · object

DuckDB database connection configuration

Show child attributes

motherduckConnection · object

MotherDuck database connection configuration

Show child attributes

ducklakeConnection · object

DuckLake lakehouse connection configuration

Show child attributes