Skip to main content
GET
List database connections

Authorizations

Authorization
string
header
required

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

Path Parameters

organizationName
string
required

The unique identifier of the organization Standard identifier pattern for resource names

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

The unique identifier of the environment Standard identifier pattern for resource names

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

Query Parameters

limit
integer
default:-1

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

Required range: -1 <= x <= 500
offset
integer
default:0

Number of items to skip before starting to return results

Required range: x >= 0

Response

List of connections retrieved successfully

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

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.

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

databricksConnection
object

Databricks SQL warehouse connection configuration

mysqlConnection
object

MySQL database connection configuration

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.

motherduckConnection
object

MotherDuck database connection configuration

ducklakeConnection
object

DuckLake lakehouse connection configuration

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.

includeTables
string[] | null

The list of tables to include, in the format {dataset/schema}.{table}. The first part represents the dataset or schema, and the second part is the table name. The second part can be a literal * to include all tables.

Table name pattern matching {schema}.{table}, {schema}., {catalog}.{schema}.{table}, or {catalog}.{schema}.

Pattern: ^(?:[a-zA-Z0-9_-]+\.)?[a-zA-Z0-9_-]+\.(?:[a-zA-Z0-9_-]+|\*)$
Example:
excludeAllTables
boolean
default:false

Whether to exclude all tables.

excludeTables
string[] | null

The list of tables to exclude, in the format {dataset/schema}.{table}. The first part represents the dataset or schema, and the second part is the table name. The second part can be a literal * to exclude all tables.

Table name pattern matching {schema}.{table}, {schema}., {catalog}.{schema}.{table}, or {catalog}.{schema}.

Pattern: ^(?:[a-zA-Z0-9_-]+\.)?[a-zA-Z0-9_-]+\.(?:[a-zA-Z0-9_-]+|\*)$
Example:
indexingStatus
enum<string> | null

Current indexing status of the connection. UNKNOWN means indexing is queued and starts automatically on creation (no manual action; "Start indexing" is an optional re-trigger). SCHEMA_INDEXING means schema indexing is in progress, MODEL_SUGGESTION_INDEXING means schema indexing finished (schema search is usable) and the model-suggestions pipeline is generating dimensions/measures/joins, INDEXED means both pipelines finished, SKIPPED means the connection is excluded from indexing, FAILED means schema indexing failed, RETRY means the connection was updated while indexing was in progress and will be re-indexed when the current job finishes.

Available options:
UNKNOWN,
SCHEMA_INDEXING,
INDEXED,
SKIPPED,
FAILED,
RETRY,
MODEL_SUGGESTION_INDEXING
indexingStatusLastUpdated
string<date-time> | null

ISO 8601 timestamp of when the indexing status was last updated

indexingProgress
object | null

Aggregate per-pipeline indexing progress for a connection, polled from the entity-indexing service while the connection is being indexed. Populated on the single-connection read while indexing is in progress (SCHEMA_INDEXING / MODEL_SUGGESTION_INDEXING); null once INDEXED or when progress is unavailable.