Get connection details

Retrieves detailed information about a specific database connection within an environment. This includes connection configuration, credentials (if accessible), and metadata. Useful for inspecting connection settings and troubleshooting connectivity issues.

GET /environments/{environmentName}/connections/{connectionName}

Get connection details

cURL

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

200

{
  "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": 123,
    "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": 123
  },
  "trinoConnection": {
    "server": "<string>",
    "port": 123,
    "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": 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>",
          "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": 123,
        "databaseName": "<string>",
        "userName": "<string>",
        "password": "<string>",
        "connectionString": "<string>",
        "sslmode": "disable"
      }
    }
  },
  "publisherConnection": {
    "connectionUri": "<string>",
    "accessToken": "<string>"
  }
}

Authorizations

Authorization · string · header · required

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

Path Parameters

environmentName · string · required

Name of the environment Standard identifier pattern for resource names

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

connectionName · string · required

Name of the connection Standard identifier pattern for resource names

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

Response

200

application/json

Connection details and configuration

Database connection configuration and metadata

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, databricks, mysql, duckdb, motherduck, ducklake, publisher

fingerprint · string

Optional, opaque, stable fingerprint of this connection's data identity. It is a hash of the configuration that determines which data the connection reaches (its data-locating settings), and deliberately excludes credentials and other secret values, so it stays constant across credential rotation and changes only when the connection is pointed at different data. When present, it is used as this connection's contribution to content-addressed build identifiers so that builds re-address only when the underlying data identity actually changes; consumers should treat it as an opaque token and use the supplied value verbatim rather than deriving their own. This field is optional — when omitted, a connection identity is derived locally instead.

attributes · object

Connection capabilities and configuration attributes

Show child attributes

proxy · object

Optional network proxy through which the connection is reached. Applies to any connection type whose database is not directly reachable (e.g. behind a bastion). The proxy is established below the driver, so the driver connects to a local endpoint transparently. Modeled as a discriminated union on type so additional proxy mechanisms can be added later.

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

databricksConnection · object

Databricks SQL warehouse connection configuration

Show child attributes

mysqlConnection · object

MySQL database connection configuration

Show child attributes

duckdbConnection · object

DuckDB database connection configuration. Publisher intentionally exposes only data-source intent here. Database files, working directories, filesystem/network policy, extension loading, setup SQL, temp directories, and resource knobs are owned by Publisher so environment configs cannot widen deployment policy through low-level DuckDB settings.

Show child attributes

motherduckConnection · object

MotherDuck database connection configuration

Show child attributes

ducklakeConnection · object

DuckLake lakehouse connection configuration

Show child attributes

publisherConnection · object

Malloy Publisher proxy connection. Proxies SQL to a remote Publisher dataplane instead of connecting to a warehouse directly. The remote dataplane owns authentication, access control, and read-only enforcement.

Show child attributes