Get a connection
GET/v1/connections/:connection_key
Fetch metadata about a connection. The service account must have at least a viewer role for this connection.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| connection_keyrequired | path | string | The unique identifier for the connection |
Responses
Successful response
success * boolean
request_id * string
result * object — A data connection, usually a SQL database
key * string — The unique identifier for the connection
name * string — The display name for the connection
created_at * string (date-time) — An ISO 8601 date-time string.
description * string — A description of the connection.
modified_at * string (date-time) | null — An ISO 8601 date-time string, or null.
projects * string[] — Projects where this connection is available.
type * "athena" | "bigquery" | "databricks" | "mssql" | "mysql" | "postgresql" | "redshift" | "snowflake" | "synapse" | "googlesheets" — The type of connection
color string — The default color for this connection
last_schema_refresh_at string (date-time) — An ISO 8601 date-time string.
schema_refresh_frequency string (date-time) — An ISO 8601 date-time string.