Skip to main content
GET
Get a Databricks connection

Authorizations

Authorization
string
header
required

Organization API key (sl_…).

Headers

x-tenant-id
string
required

The organization ID the request is scoped to.

Path Parameters

databricks_connection_id
string
required

Response

Successful Response

A connection to one Databricks account.

id
string
required
read-only

The unique identifier of the connection.

etag
string
required
read-only

Opaque strong ETag for this connection's configuration. Matches the ETag response header, and is what If-Match requires on a write. It changes whenever a configurable field on the connection changes.

name
string
required

Display name for the connection, as shown throughout SELECT.

connection_id
string
required
read-only

Identifier of the connection resource this Databricks connection belongs to (see GET /v2/connections/{connection_id}). Distinct from id, which identifies this Databricks connection specifically.

databricks_account_id
string
required

The Databricks account SELECT reads usage and spend for.

primary_workspace_url
string
required

URL of the workspace SELECT connects through to read the account's system tables. One account can have several connections, one per region, each reading through a workspace in its own region.

warehouse_id
string
required

The SQL warehouse in that workspace SELECT runs its queries on.

workspace_ids
string[]
required
read-only

The workspaces SELECT has found activity in for this account and region. Accumulated as they are discovered, so a workspace that has gone quiet stays listed. Empty until the first successful discovery.

sync_enabled
boolean
required

Whether SELECT is currently syncing data for this connection.

query_sanitization_enabled
boolean
required

Whether query text is sanitized before SELECT stores it.

create_time
string
required
read-only

When the connection was added.

update_time
string
required
read-only

When the connection was last changed.

metastore
string | null

The Unity Catalog metastore this connection reads, in cloud:region:id form. Null until the first successful validation resolves it.

added_by_email
string | null

Email address of the person who added the connection. Null when it was not added by a person.

last_successful_sync_time
string | null

When SELECT last completed a sync for this connection. Null before the first one succeeds.