List database connections
Retrieves all database connections configured for the specified environment, including connection metadata, status, and configuration details.
Authorization: Requires environment admin or modeler permissions.
Response: Returns array of connection objects with configuration details.
Pagination: Supports offset-based pagination with limit and offset parameters.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The unique identifier of the organization Standard identifier pattern for resource names
^[a-zA-Z0-9_ -]+$The unique identifier of the environment Standard identifier pattern for resource names
^[a-zA-Z0-9_ -]+$Query Parameters
Maximum number of items to return. Use -1 or omit to return all results. Valid values: -1 (all results) or 1–100.
-1 <= x <= 500Number of items to skip before starting to return results
x >= 0Response
List of connections retrieved successfully
Resource path to the connection
Name of the connection
Type of database connection
postgres, bigquery, snowflake, trino, databricks, mysql, duckdb, motherduck, ducklake, publisher 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.
Connection capabilities and configuration attributes
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.
PostgreSQL database connection configuration
Google BigQuery database connection configuration
Snowflake database connection configuration
Trino database connection configuration
Databricks SQL warehouse connection configuration
MySQL database connection configuration
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.
MotherDuck database connection configuration
DuckLake lakehouse connection configuration
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.
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}.
^(?:[a-zA-Z0-9_-]+\.)?[a-zA-Z0-9_-]+\.(?:[a-zA-Z0-9_-]+|\*)$Whether to exclude all tables.
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}.
^(?:[a-zA-Z0-9_-]+\.)?[a-zA-Z0-9_-]+\.(?:[a-zA-Z0-9_-]+|\*)$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.
UNKNOWN, SCHEMA_INDEXING, INDEXED, SKIPPED, FAILED, RETRY, MODEL_SUGGESTION_INDEXING ISO 8601 timestamp of when the indexing status was last updated
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.