Settings API keys reference

This page lists the settings available through the public Azure 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 disable_legacy_features 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.
Partner-powered AI features llm_proxy_partner_powered Determines if partner powered models are enabled or not. This setting is available at both account and workspace level
Enforce partner-powered AI features llm_proxy_partner_powered_enforce Determines if the partner-powered enforce setting is on. When enabled, the account-level partner-powered value overrides any workspace-level override.
Restrict Workspace Admins restrict_workspace_admins 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.

Workspace settings

Settings that apply to a single workspace.

Setting Key name Description
AI/BI Dashboard Embedding Access Policy aibi_dash_embed_ws_acc_policy 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).
AI/BI Dashboard Embedding Approved Domains aibi_dash_embed_ws_apprvd_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 OAuth scopes for apps to selected values allowedAppsUserApiScopes 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 automatic_cluster_update 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.
Allowed collaboration platforms collaboration_platform_connectivity Controls which external collaboration platforms (Slack and/or Microsoft Teams) can connect to this workspace. Defaults to ALLOW_ALL.
Allow public messages in collaboration platforms collaboration_platform_message_visibility 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.
Workspace access for Databricks personnel customerApprovedWSLoginExpirationTime A specific time after which Databricks personnel may no longer log into your workspace. The time is formatted as YYYY-MM-DDTHH:MM:SSZ. You can completely disable access by setting it to a timestamp in the past, such as 1998-01-01T00:00:00.000Z. Enable access indefinitely by using an empty string or the special value indefinite.
Default Namespace default_namespace_ws The default namespace setting API allows users to configure the default namespace for a Databricks workspace.
Disable legacy access disable_legacy_access '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.
Disable DBFS root and mounts disable_legacy_dbfs 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.
Only allow app deployments from Git enforceGitAppDeployments When enabled, apps in this workspace can only be deployed from Git.
Partner-powered AI features llm_proxy_partner_powered Determines if partner powered models are enabled or not. This setting is available at both account and workspace level
Mission Critical mission_critical Delivers the highest levels of operational resilience and security for critical workloads. Includes disaster recovery and enhanced security and compliance.
Restrict Workspace Admins restrict_workspace_admins 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.
Compliance security profile shield_csp_enablement_ws_db 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.
Enhanced security monitoring shield_esm_enablement_ws_db 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 autoCreateSessionOnEditorInteraction Controls whether a session is automatically created when interacting with the editor.
Auto Launch And Attach autoLaunchAndAttach Controls whether notebooks automatically launch and attach to clusters.
Confirm Command Delete confirmCommandDelete Controls whether confirmation is required before deleting a command.
Create new assets in Drafts folder createNewAssetsInDraftsFolder Controls whether new assets are created in the drafts folder.
Databricks Unified Sql Editor Create And Convert Queries On Open Pref 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 defaultPythonIndentUnit Controls the default Python indent unit. Allowed values: 2, 4, or '' (empty string for default).
Editor Custom Dark Theme editorCustomDarkTheme Controls the custom dark theme for the editor. Allowed values: defaultTheme, Atom-One-Dark, Ayu-Dark, Blackboard, Dracula, GitHub-Dark, Monokai, One-Dark-Pro, Winter-is-Coming-Dark.
Editor Custom Light Theme editorCustomLightTheme Controls the custom light theme for the editor. Allowed values: defaultTheme, Active4D, Atom-One-Light, Ayu-Light, GitHub-Light, Tomorrow, Winter-is-Coming-Light.
Editor font size editorFontSize Controls the font size in the editor. Allowed values: integer range from 10 to 30.
Enable Auto Inline Quick Fix enableAutoInlineQuickFix Controls whether inline quick fixes are automatically suggested.
Enable Auto Inline Quick Fix Opt Out enableAutoInlineQuickFixOptOut Opt-out control for automatic inline quick fixes.
Enable Auto Trigger Diagnose enableAutoTriggerDiagnose Controls whether diagnostics are automatically triggered.
Enable Auto Trigger Diagnose Opt Out enableAutoTriggerDiagnoseOptOut Opt-out control for automatic diagnostics.
Enable Centered Layout enableCenteredLayout Controls whether the editor uses a centered layout.
Enable Classic Shortcuts enableClassicShortcuts Controls the keyboard shortcuts mode. Allowed values: default, classic.
Enable Command Numbers enableCommandNumbers Controls whether command numbers are displayed in notebooks.
Enable Completions As You Type enableCompletionsAsYouType Controls whether autocomplete suggestions appear as you type.
Enable Cursor Blink enableCursorBlink Controls whether the cursor blinks in the editor.
Enable Dark Mode enableDarkMode Controls the theme mode. Allowed values: light, dark, system.
Enable Enter Accepts Suggestions enableEnterAcceptsSuggestions Controls whether pressing Enter accepts autocomplete suggestions.
Enable Hover For Editor enableHoverForEditor Controls whether hover tooltips are shown in the editor.
Enable Inline Suggestion As You Type Opt Out enableInlineSuggestionAsYouTypeOptOut Opt-out control for inline suggestions as you type.
Enable Line Numbers enableLineNumbers Controls whether line numbers are displayed in the editor.
Enable Line Numbers V2 enableLineNumbersV2 Controls whether line numbers are displayed in the editor (v2).
Enable Line Wrap enableLineWrap Controls whether text wraps to the next line in the editor.
Enable Monaco Multi Cursor enableMonacoMultiCursor Controls the multi-cursor modifier key. Allowed values: alt, ctrlCmd.
Enable Notebook Debugger Opt Out enableNotebookDebuggerOptOut Opt-out control for the notebook debugger.
Enable Serverless Observability Toggle enableServerlessObservabilityToggle User opt-in for Improved Serverless Observability in Jobs when the workspace preview is enabled.
Enable Show Command Stats In New Cell Ui enableShowCommandStatsInNewCellUi Controls whether command statistics are shown in the new cell UI.
Enable Show Promoted Cell Titles enableShowPromotedCellTitles Controls whether promoted cell titles are displayed.
Enable Smart Quotes enableSmartQuotes Controls whether smart quotes are enabled in the editor.
Enable Soft Tabs For Notebooks And Files enableSoftTabsForNotebooksAndFiles Controls whether tabs are converted to spaces in notebooks and files.
Enable Sql Syntax Error Highlighting enableSqlSyntaxErrorHighlighting Controls whether SQL syntax errors are highlighted.
Enable Switch To Command Mode After Execution enableSwitchToCommandModeAfterExecution Controls whether the editor switches to command mode after cell execution.
Enable Unified File Tree Explorer enableUnifiedFileTreeExplorer Controls whether the unified file tree explorer is enabled.
Focus enableUnifiedSchemaBrowserTreeExplorer Controls whether the unified schema browser tree explorer is enabled.
Enable Vega Lite Renderer enableVegaLiteRenderer Controls whether the Vega-Lite renderer is enabled for visualizations.
Enable Vega Lite Renderer Opt Out enableVegaLiteRendererOptOut Opt-out control for the Vega-Lite renderer.
Enable Vega Lite Renderer Preview Tag enableVegaLiteRendererPreviewTag Controls whether the Vega-Lite renderer preview tag is shown.
Extended bottom panel extendedBottomPanel Controls whether the extended bottom panel is displayed.
Lakeflow New Pipelines Monitoring Ui lakeflowNewPipelinesMonitoringUi Controls whether the new Lakeflow pipelines monitoring UI is enabled.
Notebook Default Export Format notebookDefaultExportFormat Controls the default export format for notebooks. Allowed values: SOURCE, JUPYTER.
Option Arrow Shortcut Mode optionArrowShortcutMode Controls the behavior of Option+Arrow keyboard shortcuts. Allowed values: navigate, move.
Pipelines Multifile Authoring pipelinesMultifileAuthoring Controls whether multifile authoring is enabled for pipelines.
Send Comment Email Notifications sendCommentEmailNotifications Controls whether email notifications are sent for comments.
Show cell execution minimap showCellExecutionMinimap Controls whether the cell execution minimap is displayed.
Show Pip To Environment Panel Prompt showPipToEnvironmentPanelPrompt Controls whether to show pip to environment panel prompt.
Show Spark Advisor showSparkAdvisor Controls whether Spark optimization suggestions are displayed.
Show Spark Error Tips showSparkErrorTips Controls whether helpful tips are shown for Spark errors.
User Activates Python Format Error Highlighting userActivatesPythonFormatErrorHighlighting Controls whether Python formatting errors are highlighted.
User Activates Python Syntax Error Highlighting Opt Out userActivatesPythonSyntaxErrorHighlightingOptOut Opt-out control for Python syntax error highlighting.
User Activates Python Type Checking userActivatesPythonTypeChecking Controls whether Python type checking is enabled.
User Activates Snapshot Restore userActivatesSnapshotRestore Controls whether snapshot restore functionality is enabled.
Default limit 1000 for new queries usqleDefaultQueryAutoLimit Controls the default auto limit for SQL queries in the editor.

Additional resources

  • Last updated on