Sign in
DATABRICKS
Databricks
Databricks Connections

Update a Databricks connection

Edit a connection.

Credentials may be omitted to keep the stored ones; everything else in the body replaces the stored value. Switching auth_type requires fresh credentials, because the stored key format changes with it.

put/api/v1/databricks/connections/{connection_id}

Path parameters

connection_idinteger required

Headers

x-tenantstring required

Request body

OR

Response

Successful Response

idinteger required
namestring required
descriptionstring nullable
server_hostnamestring required
http_pathstring required
auth_type'pat' | 'oauth_m2m'

Stored auth methods for Databricks connections.

Entra-managed service principals are not a separate type — they are oauth_m2m rows whose azure_tenant_id lives in connection_info; its presence routes token minting to Microsoft Entra ID instead of the workspace OIDC endpoint.

azure_tenant_idstring nullable
workspace_idstring nullable
workspace_namestring nullable
metastore_idstring nullable
catalogsstring[] nullable
databricks_account_idstring nullable
workspace_urlstring nullable
sql_warehouse_idstring nullable
system_catalog_scopestring nullable
system_catalog_schemasstring nullable
workspace_resource_idstring nullable
azure_regionstring nullable
storage_account_resource_idstring nullable
storage_account_fqdnstring nullable
log_tenant_idstring nullable
log_client_idstring nullable
storage_accountstring nullable
containerstring nullable
log_pathstring nullable
has_log_client_secretboolean
s3_role_arnstring nullable
s3_locationstring nullable
is_validboolean required
last_validated_atstring date-time nullable
created_atstring date-time required
last_modified_atstring date-time required
created_byinteger nullable
last_modified_byinteger nullable

Changes

Changed in 1 of the 29 revisions of this API.1