---
title: "Update a Databricks connection"
method: PUT
path: "/api/v1/databricks/connections/{connection_id}"
tags: ["DATABRICKS", "Databricks", "Databricks Connections"]
---

# Update a Databricks connection

`PUT /api/v1/databricks/connections/{connection_id}`

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.

## Path parameters

- `connection_id` integer, required

## Headers

- `x-tenant` string, required

## Request body

- union
  - DatabricksConnectionUpdatePAT
    - `type` string
    - `server_hostname` string, required — Databricks workspace hostname. Must end in cloud.databricks.com, azuredatabricks.net, or gcp.databricks.com.
    - `http_path` string, required — SQL warehouse HTTP path. Derived from `sql_warehouse_id` when that is supplied; still accepted directly for the pre-consolidation shape.
    - `workspace_url` string, nullable — Workspace URL as the customer sees it, with or without scheme (AWS *.cloud.databricks.com, Azure adb-*.azuredatabricks.net). `server_hostname` is derived from it.
    - `sql_warehouse_id` string, nullable — SQL warehouse id; `http_path` is derived from it.
    - `name` string, required
    - `description` string, nullable
    - `databricks_account_id` string, nullable — Databricks account id. Verified against the account probed from the workspace; stored as instances.account_name.
    - `system_catalog_scope` 'all' | 'specific', nullable — Whether ingestion reads all system schemas or a named subset.
    - `system_catalog_schemas` string, nullable — Comma-separated schemas; required when scope is 'specific'.
    - `workspace_resource_id` string, nullable
    - `azure_region` string, nullable
    - `storage_account_resource_id` string, nullable
    - `storage_account_fqdn` string, nullable
    - `s3_role_arn` string, nullable
    - `s3_external_id` string, nullable
    - `s3_location` string, nullable
    - `log_tenant_id` string, nullable
    - `log_client_id` string, nullable
    - `log_client_secret` string, nullable
    - `storage_account` string, nullable
    - `container` string, nullable
    - `log_path` string, nullable — abfss://… log root
    - `auth_type` 'pat'
    - `access_token` string, nullable
  - DatabricksConnectionUpdateOAuthM2M
    - `type` string
    - `server_hostname` string, required — Databricks workspace hostname. Must end in cloud.databricks.com, azuredatabricks.net, or gcp.databricks.com.
    - `http_path` string, required — SQL warehouse HTTP path. Derived from `sql_warehouse_id` when that is supplied; still accepted directly for the pre-consolidation shape.
    - `workspace_url` string, nullable — Workspace URL as the customer sees it, with or without scheme (AWS *.cloud.databricks.com, Azure adb-*.azuredatabricks.net). `server_hostname` is derived from it.
    - `sql_warehouse_id` string, nullable — SQL warehouse id; `http_path` is derived from it.
    - `name` string, required
    - `description` string, nullable
    - `databricks_account_id` string, nullable — Databricks account id. Verified against the account probed from the workspace; stored as instances.account_name.
    - `system_catalog_scope` 'all' | 'specific', nullable — Whether ingestion reads all system schemas or a named subset.
    - `system_catalog_schemas` string, nullable — Comma-separated schemas; required when scope is 'specific'.
    - `workspace_resource_id` string, nullable
    - `azure_region` string, nullable
    - `storage_account_resource_id` string, nullable
    - `storage_account_fqdn` string, nullable
    - `s3_role_arn` string, nullable
    - `s3_external_id` string, nullable
    - `s3_location` string, nullable
    - `log_tenant_id` string, nullable
    - `log_client_id` string, nullable
    - `log_client_secret` string, nullable
    - `storage_account` string, nullable
    - `container` string, nullable
    - `log_path` string, nullable — abfss://… log root
    - `auth_type` 'oauth_m2m', required
    - `client_id` string, required
    - `client_secret` string, nullable
    - `azure_tenant_id` string, nullable

## Response `200`

Successful Response

- DatabricksConnectionResponse
  - `id` integer, required
  - `name` string, required
  - `description` string, nullable
  - `server_hostname` string, required
  - `http_path` string, 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_id` string, nullable
  - `workspace_id` string, nullable
  - `workspace_name` string, nullable
  - `metastore_id` string, nullable
  - `catalogs` string[], nullable
  - `databricks_account_id` string, nullable
  - `workspace_url` string, nullable
  - `sql_warehouse_id` string, nullable
  - `system_catalog_scope` string, nullable
  - `system_catalog_schemas` string, nullable
  - `workspace_resource_id` string, nullable
  - `azure_region` string, nullable
  - `storage_account_resource_id` string, nullable
  - `storage_account_fqdn` string, nullable
  - `log_tenant_id` string, nullable
  - `log_client_id` string, nullable
  - `storage_account` string, nullable
  - `container` string, nullable
  - `log_path` string, nullable
  - `has_log_client_secret` boolean
  - `s3_role_arn` string, nullable
  - `s3_location` string, nullable
  - `is_valid` boolean, required
  - `last_validated_at` string, date-time, nullable
  - `created_at` string, date-time, required
  - `last_modified_at` string, date-time, required
  - `created_by` integer, nullable
  - `last_modified_by` integer, nullable

## Other responses

- `400` — Connection test failed, or credentials missing for an auth-type switch
- `404` — Connection not found
- `409` — Another connection already has this configuration or name
- `422` — Validation Error

## Changes

- **2026-09-02** `fcb62c79da95` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/myaltimate/apis/fastapi/changes/api/v1/databricks/connections/:connection_id/put.md)

---

[API](https://skmtc.dev/myaltimate/apis/fastapi.md) · [All operations](https://skmtc.dev/myaltimate/apis/fastapi/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/myaltimate/fastapi/revisions/fcb62c79da95/schema)