Settings API keys reference
This page lists the settings available through the public Databricks Settings API, grouped by scope. Each setting is identified by a stable setting name (key). For how to discover, read, and update these settings, see Manage settings through the Settings API.
Feature previews are also managed through the Settings API but are not listed here, because they are transient and eventually reach end-of-life. Discover the previews currently available to you through the settings-metadata endpoint.
Available settings
The following settings are available through the public Settings API, grouped by scope. This list is generated periodically; for the authoritative, always-current set of settings and their documentation links, call the settings-metadata endpoint, which returns each setting's name, description, type, and docs_link.
Account settings
Settings that apply across the account.
Setting | Key name | Description |
|---|---|---|
| Disable legacy features for new Databricks workspaces. For newly created workspaces: 1. Disables the use of DBFS root and mounts. 2. Hive Metastore will not be provisioned. 3. Disables the use of 'No-isolation clusters'. 4. Disables Databricks Runtime versions prior to 13.3LTS. | |
| Determines if partner powered models are enabled or not. This setting is available at both account and workspace level | |
| Determines if the partner-powered enforce setting is on. When enabled, the account-level partner-powered value overrides any workspace-level override. | |
| The Restrict Workspace Admins setting lets you control the capabilities of workspace admins. With the setting status set to ALLOW_ALL, workspace admins can create service principal personal access tokens on behalf of any service principal in their workspace. Workspace admins can also change a job owner to any user in their workspace. And they can change the job run_as setting to any user in their workspace or to a service principal on which they have the Service Principal User role. With the setting status set to RESTRICT_TOKENS_AND_JOB_RUN_AS, workspace admins can only create personal access tokens on behalf of service principals they have the Service Principal User role on. They can also only change a job owner to themselves. And they can change the job run_as setting to themselves or to a service principal on which they have the Service Principal User role. | |
| Controls whether the compliance security profile is enabled by default for new workspaces created in the account. The compliance security profile provides a highly secure baseline (additional monitoring, a hardened compute image, enforced instance types, and other controls) that makes it easier to meet and manage applicable compliance standards. When enabled as an account default, enhanced security monitoring and automatic cluster update are also enabled for new workspaces. | |
| Controls whether enhanced security monitoring is enabled by default for new workspaces created in the account. Enhanced security monitoring provides a hardened compute image and additional security monitoring agents that generate reviewable log rows. If the compliance security profile is enabled for new workspaces, this setting is permanently enforced. Account-level enhanced security monitoring is supported on AWS and GCP only. |
Workspace settings
Settings that apply to a single workspace.
Setting | Key name | Description |
|---|---|---|
| Controls whether AI/BI published dashboard embedding is enabled, conditionally enabled, or disabled at the workspace level.By default, this setting is conditionally enabled (ALLOW_APPROVED_DOMAINS). | |
| Controls the list of domains approved to host the embedded AI/BI dashboards.The approved domains list can't be mutated when the current access policy is not set to ALLOW_APPROVED_DOMAINS. | |
| Restrict which OAuth scopes app developers can request when acting on behalf of users. Specify a list of allowed scopes, or use "*" to allow all supported scopes. An empty list effectively disables user authorization for apps. | |
| Automatic cluster update ensures that all the clusters in a workspace are periodically updated to the latest host OS image and security updates. Account admins can schedule the maintenance window frequency, start date, and start time. Applies to classic compute (clusters, pools, classic SQL warehouses, legacy Model Serving); it does not apply to serverless compute. Enabling this feature adds the Enhanced Security and Compliance add-on and requires the Premium pricing tier. | |
| Controls which external collaboration platforms (Slack and/or Microsoft Teams) can connect to this workspace. Defaults to ALLOW_ALL. | |
| When enabled, users can choose whether responses from the Databricks app in Slack are visible to the channel. When disabled, all responses are forced to be private to the requesting user. | |
| A specific time after which Databricks personnel may no longer log into your workspace. The time is formatted as | |
| The default namespace setting API allows users to configure the default namespace for a Databricks workspace. | |
| 'Disabling legacy access' has the following impacts: 1. Disables direct access to Hive Metastores from the workspace (access through Hive Metastore federation is unaffected). 2. Disables fallback mode on external location access from the workspace. 3. Disables Databricks Runtime versions prior to 13.3LTS. Important: this setting cannot be enabled while the workspace default catalog is set to a legacy catalog (hive_metastore or spark_catalog). Change the default catalog to a Unity Catalog catalog first. | |
| Disabling legacy DBFS has the following two implications: 1. Access to DBFS root and DBFS mounts is disallowed (as well as the creation of new mounts). 2. Disables Databricks Runtime versions prior to 13.3LTS. When the setting is off, all DBFS functionality is enabled and no restrictions are imposed on Databricks Runtime versions. This setting can take up to 20 minutes to take effect and requires a manual restart of all-purpose compute clusters and SQL warehouses. | |
| When enabled, apps in this workspace can only be deployed from Git. | |
| Determines if partner powered models are enabled or not. This setting is available at both account and workspace level | |
| Delivers the highest levels of operational resilience and security for critical workloads. Includes disaster recovery and enhanced security and compliance. | |
| Additional recipient for this workspace's operational emails. When set, Databricks delivers these emails to both the workspace admins and this address. Available on AWS and GCP. | |
| The Restrict Workspace Admins setting lets you control the capabilities of workspace admins. With the setting status set to ALLOW_ALL, workspace admins can create service principal personal access tokens on behalf of any service principal in their workspace. Workspace admins can also change a job owner to any user in their workspace. And they can change the job run_as setting to any user in their workspace or to a service principal on which they have the Service Principal User role. With the setting status set to RESTRICT_TOKENS_AND_JOB_RUN_AS, workspace admins can only create personal access tokens on behalf of service principals they have the Service Principal User role on. They can also only change a job owner to themselves. And they can change the job run_as setting to themselves or to a service principal on which they have the Service Principal User role. | |
| Controls whether the compliance security profile is enabled for this workspace. The compliance security profile provides a highly secure baseline (additional monitoring, a hardened compute image, enforced instance types for inter-node encryption, and other controls) that makes it easier to meet and manage applicable compliance standards. Enabling it also permanently enables enhanced security monitoring and automatic cluster update on the workspace, and adds the Enhanced Security and Compliance add-on. | |
| Controls whether enhanced security monitoring is enabled for this workspace. Enhanced security monitoring provides a hardened compute image and additional security monitoring agents (file integrity monitoring, antivirus, and vulnerability scanning) that generate reviewable log rows. It applies to classic compute plane resources only, not serverless. If the compliance security profile is enabled on the workspace, this setting is permanently enforced. |
User preferences
Settings that apply to a user in an account.
Setting | Key name | Description |
|---|---|---|
Automatically create session on editor interaction |
| Controls whether a session is automatically created when interacting with the editor. |
Auto Launch And Attach |
| Controls whether notebooks automatically launch and attach to clusters. |
Confirm Command Delete |
| Controls whether confirmation is required before deleting a command. |
Create new assets in Drafts folder |
| Controls whether new assets are created in the drafts folder. |
Databricks Unified Sql Editor Create And Convert Queries On Open Pref |
| Controls query creation and conversion behavior in the unified SQL editor. |
Default Python Indent Unit |
| Controls the default Python indent unit. Allowed values: |
Editor Custom Dark Theme |
| Controls the custom dark theme for the editor. Allowed values: |
Editor Custom Light Theme |
| Controls the custom light theme for the editor. Allowed values: |
Editor font size |
| Controls the font size in the editor. Allowed values: integer range from 10 to 30. |
Enable Auto Inline Quick Fix |
| Controls whether inline quick fixes are automatically suggested. |
Enable Auto Inline Quick Fix Opt Out |
| Opt-out control for automatic inline quick fixes. |
Enable Auto Trigger Diagnose |
| Controls whether diagnostics are automatically triggered. |
Enable Auto Trigger Diagnose Opt Out |
| Opt-out control for automatic diagnostics. |
Enable Centered Layout |
| Controls whether the editor uses a centered layout. |
Enable Classic Shortcuts |
| Controls the keyboard shortcuts mode. Allowed values: |
Enable Command Numbers |
| Controls whether command numbers are displayed in notebooks. |
Enable Completions As You Type |
| Controls whether autocomplete suggestions appear as you type. |
Enable Cursor Blink |
| Controls whether the cursor blinks in the editor. |
Enable Dark Mode |
| Controls the theme mode. Allowed values: |
Enable Enter Accepts Suggestions |
| Controls whether pressing Enter accepts autocomplete suggestions. |
Enable Hover For Editor |
| Controls whether hover tooltips are shown in the editor. |
Enable Inline Suggestion As You Type Opt Out |
| Opt-out control for inline suggestions as you type. |
Enable Line Numbers |
| Controls whether line numbers are displayed in the editor. |
Enable Line Numbers V2 |
| Controls whether line numbers are displayed in the editor (v2). |
Enable Line Wrap |
| Controls whether text wraps to the next line in the editor. |
Enable Monaco Multi Cursor |
| Controls the multi-cursor modifier key. Allowed values: |
Enable Notebook Debugger Opt Out |
| Opt-out control for the notebook debugger. |
Enable Serverless Observability Toggle |
| User opt-in for Improved Serverless Observability in Jobs when the workspace preview is enabled. |
Enable Show Command Stats In New Cell Ui |
| Controls whether command statistics are shown in the new cell UI. |
Enable Show Promoted Cell Titles |
| Controls whether promoted cell titles are displayed. |
Enable Smart Quotes |
| Controls whether smart quotes are enabled in the editor. |
Enable Soft Tabs For Notebooks And Files |
| Controls whether tabs are converted to spaces in notebooks and files. |
Enable Sql Syntax Error Highlighting |
| Controls whether SQL syntax errors are highlighted. |
Enable Switch To Command Mode After Execution |
| Controls whether the editor switches to command mode after cell execution. |
Enable Unified File Tree Explorer |
| Controls whether the unified file tree explorer is enabled. |
Focus |
| Controls whether the unified schema browser tree explorer is enabled. |
Enable Vega Lite Renderer |
| Controls whether the Vega-Lite renderer is enabled for visualizations. |
Enable Vega Lite Renderer Opt Out |
| Opt-out control for the Vega-Lite renderer. |
Enable Vega Lite Renderer Preview Tag |
| Controls whether the Vega-Lite renderer preview tag is shown. |
Extended bottom panel |
| Controls whether the extended bottom panel is displayed. |
Lakeflow New Pipelines Monitoring Ui |
| Controls whether the new Lakeflow pipelines monitoring UI is enabled. |
Notebook Default Export Format |
| Controls the default export format for notebooks. Allowed values: |
Option Arrow Shortcut Mode |
| Controls the behavior of Option+Arrow keyboard shortcuts. Allowed values: |
Pipelines Multifile Authoring |
| Controls whether multifile authoring is enabled for pipelines. |
Send Comment Email Notifications |
| Controls whether email notifications are sent for comments. |
Show cell execution minimap |
| Controls whether the cell execution minimap is displayed. |
Show Pip To Environment Panel Prompt |
| Controls whether to show pip to environment panel prompt. |
Show Spark Advisor |
| Controls whether Spark optimization suggestions are displayed. |
Show Spark Error Tips |
| Controls whether helpful tips are shown for Spark errors. |
User Activates Python Format Error Highlighting |
| Controls whether Python formatting errors are highlighted. |
User Activates Python Syntax Error Highlighting Opt Out |
| Opt-out control for Python syntax error highlighting. |
User Activates Python Type Checking |
| Controls whether Python type checking is enabled. |
User Activates Snapshot Restore |
| Controls whether snapshot restore functionality is enabled. |
Default limit 1000 for new queries |
| Controls the default auto limit for SQL queries in the editor. |