List environment database connections

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

import requests

url = "https://{organization}.data.credibledata.com/api/v0/environments/{environmentName}/connections"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{organization}.data.credibledata.com/api/v0/environments/{environmentName}/connections', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{organization}.data.credibledata.com/api/v0/environments/{environmentName}/connections",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{organization}.data.credibledata.com/api/v0/environments/{environmentName}/connections"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://{organization}.data.credibledata.com/api/v0/environments/{environmentName}/connections")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{organization}.data.credibledata.com/api/v0/environments/{environmentName}/connections")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

[
  {
    "resource": "<string>",
    "name": "<string>",
    "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>"
    },
    "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",
          "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": {
            "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>"
        }
      }
    },
    "publisherConnection": {
      "connectionUri": "<string>",
      "accessToken": "<string>"
    }
  }
]

{
  "message": "<string>",
  "details": "<string>"
}

{
  "message": "<string>",
  "details": "<string>"
}

{
  "message": "<string>",
  "details": "<string>"
}

GET

environments

{environmentName}

connections

List environment database connections

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

import requests

url = "https://{organization}.data.credibledata.com/api/v0/environments/{environmentName}/connections"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{organization}.data.credibledata.com/api/v0/environments/{environmentName}/connections', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{organization}.data.credibledata.com/api/v0/environments/{environmentName}/connections",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{organization}.data.credibledata.com/api/v0/environments/{environmentName}/connections"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://{organization}.data.credibledata.com/api/v0/environments/{environmentName}/connections")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{organization}.data.credibledata.com/api/v0/environments/{environmentName}/connections")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

[
  {
    "resource": "<string>",
    "name": "<string>",
    "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>"
    },
    "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",
          "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": {
            "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>"
        }
      }
    },
    "publisherConnection": {
      "connectionUri": "<string>",
      "accessToken": "<string>"
    }
  }
]

{
  "message": "<string>",
  "details": "<string>"
}

{
  "message": "<string>",
  "details": "<string>"
}

{
  "message": "<string>",
  "details": "<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_-]+$

Response

A list of database connections in the environment

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

Update environment configuration Get connection details

Overview

publisher

environments

connections

packages

models

notebooks

databases

pages

watch-mode

connectionsTest

materializations

List environment database connections

Authorizations

Path Parameters

Response