List database connections

Retrieves all database connections configured for the specified environment, including connection metadata, status, and configuration details.

GET/organizations/{organizationName}/environments/{environmentName}/connections

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

organizationName*string

The unique identifier of the organization

Match^[a-zA-Z0-9_ -]+$

environmentName*string

The unique identifier of the environment

Match^[a-zA-Z0-9_ -]+$

Query Parameters

limit?integer

Maximum number of items to return. Use -1 or omit to return all results. Valid values: -1 (all results) or 1–100.

Range-1 <= value <= 500

Default-1

offset?integer

Number of items to skip before starting to return results

Range0 <= value

Default0

Response Body

`application/json`

curl --request GET \  --url 'https://example.com/organizations/string/environments/string/connections' \  --header 'Authorization: Bearer <token>'

[  {    "resource": "string",    "name": "string",    "type": "postgres",    "fingerprint": "string",    "attributes": {      "dialectName": "string",      "isPool": true,      "canPersist": true,      "canStream": true    },    "proxy": {      "type": "ssh",      "ssh": {        "host": "string",        "port": 22,        "username": "string",        "privateKey": "string",        "privateKeyPass": "string",        "hostKey": "string"      }    },    "postgresConnection": {      "host": "string",      "port": 0,      "databaseName": "string",      "userName": "string",      "password": "string",      "connectionString": "string",      "sslmode": "disable"    },    "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": 0    },    "trinoConnection": {      "server": "string",      "port": 0,      "catalog": "string",      "schema": "string",      "user": "string",      "password": "string",      "peakaKey": "string"    },    "databricksConnection": {      "host": "string",      "path": "string",      "token": "string",      "oauthClientId": "string",      "oauthClientSecret": "string",      "defaultCatalog": "string",      "defaultSchema": "string",      "setupSQL": "string"    },    "mysqlConnection": {      "host": "string",      "port": 0,      "database": "string",      "user": "string",      "password": "string"    },    "duckdbConnection": {      "attachedDatabases": [        {          "name": "string",          "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": 0          },          "postgresConnection": {            "host": "string",            "port": 0,            "databaseName": "string",            "userName": "string",            "password": "string",            "connectionString": "string",            "sslmode": "disable"          },          "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": 0,          "databaseName": "string",          "userName": "string",          "password": "string",          "connectionString": "string",          "sslmode": "disable"        }      }    },    "publisherConnection": {      "connectionUri": "string",      "accessToken": "string"    },    "template": "bq_demo",    "includeTables": [      "string"    ],    "excludeAllTables": false,    "excludeTables": [      "string"    ],    "indexingStatus": "UNKNOWN",    "indexingStatusLastUpdated": "2019-08-24T14:15:22Z",    "indexingProgress": {      "schemaProgress": {        "tablesTotal": 0,        "tablesProcessing": 0,        "tablesCompleted": 0,        "tablesFailed": 0,        "columnsTotal": 0,        "columnsCompleted": 0      },      "modelSuggestionsProgress": {        "tablesTotal": 0,        "tablesProcessing": 0,        "tablesCompleted": 0,        "tablesFailed": 0,        "joinWorkTotal": 0,        "joinWorkCompleted": 0,        "joinsGenerated": 0,        "dimensionsGenerated": 0,        "measuresGenerated": 0      }    }  }]

List database connections

Authorization

Path Parameters

Query Parameters

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`