Skip to main content
POST
Test a Databricks connection configuration

Authorizations

Authorization
string
header
required

Organization API key (sl_…).

Headers

x-tenant-id
string
required

The organization ID the request is scoped to.

Body

application/json

A Databricks connection to add.

name
string
required

Display name for the connection, as shown throughout SELECT.

databricks_account_id
string
required

The Databricks account to read usage and spend for. Letters, digits and hyphens only.

Pattern: ^[a-zA-Z0-9\-]+$
primary_workspace_url
string
required

URL of the workspace to connect through, including the scheme — for example https://my-workspace.cloud.databricks.com. It must be in the region whose usage this connection should cover.

warehouse_id
string
required

The SQL warehouse in that workspace to run queries on. Letters, digits and hyphens only.

Pattern: ^[a-zA-Z0-9\-]+$
credentials
DatabricksCredentials · object
required

The service principal SELECT authenticates as. Validated against Databricks before the connection is added.

sync_enabled
boolean
default:true

Whether SELECT starts syncing data for this connection.

query_sanitization_enabled
boolean
default:false

Whether query text is sanitized before SELECT stores it.

Response

Successful Response

The result of validating a connection's configuration against Databricks.

success
boolean
required

Whether every applicable check passed.

checks
DatabricksConnectionValidationCheck · object[]
required

The checks that ran, in the order they ran. Read top-down to find where setup stopped working.