Skip to content

Get connection by ID

GET
/connections/{id}
id
required
string

Connection ID

Connection details

object
created_at
required
string format: date-time
created_by
required
string
updated_at
required
string format: date-time
updated_by
required
string
is_soft_deleted
required
boolean
version
required
number
encryption_key_name
required
string
encryption_key_version
number
vault_key_version
number
id
required
string
type
required
string
Allowed values: postgres mysql db2 oracle mssql bigquery google_sheets excel_sharepoint tableau looker
name
required
string
description
string
config
required

Job configuration stored in metadata database

object
workspace_id
required

The OWNING workspace. Controls who may modify the connection and change its sharing. Required.

string
workspace_ids
required

Full set of workspaces this connection is visible in and usable by. Always includes the owning workspace (workspace_id); non-empty.

Array<string>
metadata
required

Business sensitive metadata stored in metadata database

object
last_used_at
string format: date-time
consent_status

Consent status for admin-consent connections (e.g. Excel/SharePoint). Values: active, revoked.

string

Connection not found