Skip to main content
POST
/
v1
/
connectors
/
databricks
Create Databricks Connector
curl --request POST \
  --url https://api.example.com/v1/connectors/databricks \
  --header 'Content-Type: application/json' \
  --data '
{
  "credential_name": "<string>",
  "access_token": "<string>",
  "server_hostname": "<string>",
  "http_path": "<string>",
  "connector_type": "databricks",
  "catalog": "<string>",
  "schema_name": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "credential_name": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>",
  "verified_bucket_uri": "<string>",
  "verified_role_arn": "<string>",
  "verified_bucket_owner_account_id": "<string>",
  "verified_account": "<string>",
  "verified_warehouse": "<string>",
  "verified_database": "<string>",
  "verified_schema_name": "<string>",
  "verified_server_hostname": "<string>",
  "verified_http_path": "<string>",
  "verified_catalog": "<string>"
}

Headers

​
authorization
string | null
​
refresh-token
string | null

Body

application/json

POST /v1/connector -- Databricks credential variant.

The (server_hostname, http_path, catalog, schema_name) tuple is the probe target: the server runs SELECT 1 against it with the request's credentials. The credential row is only inserted if the probe succeeds, and the tuple is stored on the row.

​
credential_name
string
required

Unique-per-user name for this credential entry.

​
access_token
string
required

Databricks personal access token.

​
server_hostname
string
required

Databricks workspace hostname.

​
http_path
string
required

HTTP path of the SQL warehouse or cluster.

​
connector_type
string
default:databricks
Allowed value: "databricks"
​
catalog
string | null

Unity Catalog name; optional.

​
schema_name
string | null

Schema within the catalog; optional.

Response

Successful Response

Returned by POST / GET endpoints.

The verified_* fields surface the probe target the credential was validated against at create time. Exactly one set of fields is populated per response, matching connector_type:

  • s3 → verified_bucket_uri + verified_role_arn + verified_bucket_owner_account_id
  • snowflake → verified_account + verified_warehouse + verified_database + verified_schema_name
  • databricks → verified_server_hostname + verified_http_path
    • verified_catalog + verified_schema_name

id is the stored credential's identifier — the value referenced as connector_credential_id on a connection config and as connector_id in the per-type delete route (DELETE /connectors/{type}/{connector_id}).

​
id
required
​
credential_name
string
required
​
connector_type
enum<string>
required

Supported external data source types for user-owned credentials.

Available options:
s3,
snowflake,
databricks,
file_upload
​
created_at
string
required
​
updated_at
string
required
​
verified_bucket_uri
string | null
​
verified_role_arn
string | null
​
verified_bucket_owner_account_id
string | null
​
verified_account
string | null
​
verified_warehouse
string | null
​
verified_database
string | null
​
verified_schema_name
string | null
​
verified_server_hostname
string | null
​
verified_http_path
string | null
​
verified_catalog
string | null