Skip to main content

Settings

View as Markdown

A setting and its value at the workspace or account scope. Each setting has one value type, so one value field applies to it: a primitive wrapper (boolean_val, string_val or integer_val) or a setting-specific message. The settings metadata endpoint reports the field each setting uses. When updating a setting, set only the value field that matches its type. Responses return that field with the value configured at this scope, if one is set, together with the matching effective_* field, which holds the value in effect after Databricks applies account policies and defaults.

Setting object​

A setting and its value at the workspace or account scope. Each setting has one value type, so one value field applies to it: a primitive wrapper (boolean_val, string_val or integer_val) or a setting-specific message. The settings metadata endpoint reports the field each setting uses. When updating a setting, set only the value field that matches its type. Responses return that field with the value configured at this scope, if one is set, together with the matching effective_* field, which holds the value in effect after Databricks applies account policies and defaults.

namestring

Name of the setting. The settings metadata endpoint lists the names available at each scope.

Example: llm_proxy_partner_powered

boolean_valobject

Setting value for boolean type setting. This is the setting value set by consumers, check effective_boolean_val for final setting value.

Show child attributesHide child attributes
valueboolean
string_valobject

Setting value for string type setting. This is the setting value set by consumers, check effective_string_val for final setting value.

Show child attributesHide child attributes
valuestring

Represents a generic string value.

integer_valobject

Setting value for integer type setting. This is the setting value set by consumers, check effective_integer_val for final setting value.

Show child attributesHide child attributes
valueint32
automatic_cluster_update_workspaceobject

Setting value for automatic_cluster_update_workspace setting. This is the setting value set by consumers, check effective_automatic_cluster_update_workspace for final setting value.

Show child attributesHide child attributes
enabledboolean

Whether automatic cluster update is enabled for the workspace. The effective value is always true while the compliance security profile is enabled on the workspace.

can_toggleboolean

Whether the workspace can change the enabled state. Databricks computes this value: it is false when the compliance security profile forces the feature on or when the workspace lacks the Enhanced Security and Compliance entitlement. A value sent in an update request has no effect.

maintenance_windowobject

When the maintenance window runs. When unset, it defaults to the first Sunday of every month at 01:00 UTC.

Show child attributesHide child attributes
week_day_based_scheduleobject

Schedule anchored to a day of the week, either every week or on given weeks of the month.

Show child attributesHide child attributes
frequencystring

How often the maintenance window occurs: every week, or only on the listed occurrences of the day of the week within each month.

Values:

  • FIRST_OF_MONTH
  • SECOND_OF_MONTH
  • THIRD_OF_MONTH
  • FOURTH_OF_MONTH
  • FIRST_AND_THIRD_OF_MONTH
  • SECOND_AND_FOURTH_OF_MONTH
  • EVERY_WEEK
day_of_weekstring

Day of the week on which the maintenance window starts.

Values:

  • MONDAY
  • TUESDAY
  • WEDNESDAY
  • THURSDAY
  • FRIDAY
  • SATURDAY
  • SUNDAY
window_start_timeobject

Time of day, in UTC, at which the maintenance window starts.

Show child attributesHide child attributes
hoursint32

Hour of the day on a 24-hour clock.

minutesint32

Minute of the hour.

enablement_detailsobject

Why the feature is forced on or unavailable. Databricks sets these details for information only; they do not determine whether the feature is enabled.

Show child attributesHide child attributes
unavailable_for_non_enterprise_tierboolean

The feature is unavailable if the customer doesn't have enterprise tier

unavailable_for_disabled_entitlementboolean

The feature is unavailable because the workspace does not have the Enhanced Security and Compliance entitlement.

forced_for_compliance_modeboolean

The feature is force enabled if compliance mode is active

restart_even_if_no_updates_availableboolean

Whether compute resources restart during every maintenance window even when no update is available. When false, they restart only when an update is available.

aibi_dashboard_embedding_approved_domainsobject

Setting value for aibi_dashboard_embedding_approved_domains setting. This is the setting value set by consumers, check effective_aibi_dashboard_embedding_approved_domains for final setting value.

Show child attributesHide child attributes
approved_domainsarray of string

Domains allowed to host embedded AI/BI dashboards. A leading wildcard allows every subdomain of a domain. The list applies, and can only be changed, while the embedding access policy is ALLOW_APPROVED_DOMAINS.

Example: *.example.com

aibi_dashboard_embedding_access_policyobject

Setting value for aibi_dashboard_embedding_access_policy setting. This is the setting value set by consumers, check effective_aibi_dashboard_embedding_access_policy for final setting value.

Show child attributesHide child attributes
access_policy_typestring

Where AI/BI dashboards can be embedded: in any domain (ALLOW_ALL_DOMAINS), only in the approved domains configured for the workspace (ALLOW_APPROVED_DOMAINS), or nowhere (DENY_ALL_DOMAINS). Defaults to ALLOW_APPROVED_DOMAINS.

Values:

  • ALLOW_ALL_DOMAINS
  • ALLOW_APPROVED_DOMAINS
  • DENY_ALL_DOMAINS
restrict_workspace_adminsobject

Setting value for restrict_workspace_admins setting. This is the setting value set by consumers, check effective_restrict_workspace_admins for final setting value.

Show child attributesHide child attributes
statusstring

Controls what workspace admins can do with service principal tokens and job identities. With ALLOW_ALL, workspace admins can create personal access tokens on behalf of any service principal in the workspace, change a job owner to any workspace user, and set a job's run_as identity to any workspace user or to a service principal they have the Service Principal User role on. With RESTRICT_TOKENS_AND_JOB_RUN_AS, they can only create tokens for service principals they have the Service Principal User role on, change a job owner to themselves, and set run_as to themselves or to a service principal they have that role on.

Values:

  • ALLOW_ALL
  • RESTRICT_TOKENS_AND_JOB_RUN_AS
disable_gov_tag_creationbooleanPublic Preview

When true, workspace admins cannot create governance tags. ALLOW_ALL status does not override this; they are independent.

personal_computeobject

Setting value for personal_compute setting. This is the setting value set by consumers, check effective_personal_compute for final setting value.

Show child attributesHide child attributes
valuestring

ON grants all users in all workspaces of the account access to the Personal Compute default policy. DELEGATE moves control to each workspace, where users or groups must be added to the policy's permissions before they can create compute with it.

Values:

  • ON
  • DELEGATE
workspace_labelobjectBeta

Setting value for workspace_label setting. This is the setting value set by consumers, check effective_workspace_label for final setting value.

Show child attributesHide child attributes
labelstringBeta

Text of the label shown next to the workspace name in the top navigation bar. An empty string means no label is set.

colorstringBeta

Color of the label badge. The supported colors are coral, lemon, lime, turquoise, indigo, purple and pink. It is an empty string when no label is set.

allowed_apps_user_api_scopesobjectBeta

Setting value for allowed_apps_user_api_scopes setting. This is the setting value set by consumers, check effective_allowed_apps_user_api_scopes for final setting value.

Show child attributesHide child attributes
allowed_scopesarray of stringBeta

OAuth scopes that app developers can request when an app acts on behalf of a user. A list with the single entry * allows every supported scope and cannot be combined with other scopes. An empty list disables user authorization for apps.

Example: sql

operational_email_custom_recipientobjectPublic Preview

Setting value for operational_email_custom_recipient setting. This is the setting value set by consumers, check effective_operational_email_custom_recipient for final setting value.

Show child attributesHide child attributes
emailstringPublic Preview

Email address that receives this workspace's operational emails in addition to the workspace admins. Use a distribution list address to reach several people. An empty string clears the additional recipient.

Example: platform-ops@example.com

workspace_dashboard_themeobjectBeta

Setting value for the workspace_dashboard_theme setting. This is the setting value set by consumers. Check effective_workspace_dashboard_theme for the final setting value.

Show child attributesHide child attributes
canvas_background_colorobjectBeta

The background color of the dashboard canvas.

Show child attributesHide child attributes
lightstringBeta

The color used when the dashboard is rendered in light mode (for example, '#FF0000').

darkstringBeta

The color used when the dashboard is rendered in dark mode (for example, '#FF0000').

widget_background_colorobjectBeta

The background color of widgets.

Show child attributesHide child attributes
lightstringBeta

The color used when the dashboard is rendered in light mode (for example, '#FF0000').

darkstringBeta

The color used when the dashboard is rendered in dark mode (for example, '#FF0000').

widget_border_colorobjectBeta

The border color of widgets.

Show child attributesHide child attributes
lightstringBeta

The color used when the dashboard is rendered in light mode (for example, '#FF0000').

darkstringBeta

The color used when the dashboard is rendered in dark mode (for example, '#FF0000').

font_colorobjectBeta

The default font color applied to all text in the dashboard. Superseded by font_settings.base.font_color when font_settings is set. More specific font settings in turn override base.

Show child attributesHide child attributes
lightstringBeta

The color used when the dashboard is rendered in light mode (for example, '#FF0000').

darkstringBeta

The color used when the dashboard is rendered in dark mode (for example, '#FF0000').

selection_colorobjectBeta

The highlight color for selected elements in widgets.

Show child attributesHide child attributes
lightstringBeta

The color used when the dashboard is rendered in light mode (for example, '#FF0000').

darkstringBeta

The color used when the dashboard is rendered in dark mode (for example, '#FF0000').

visualization_color_01stringBeta

Color palette for visualizations. Colors are applied in order (visualization_color_01, visualization_color_02, etc.). Invalid color values are preserved but ignored during rendering.

visualization_color_02stringBeta

The color at position 2 in the visualization color palette.

visualization_color_03stringBeta

The color at position 3 in the visualization color palette.

visualization_color_04stringBeta

The color at position 4 in the visualization color palette.

visualization_color_05stringBeta

The color at position 5 in the visualization color palette.

visualization_color_06stringBeta

The color at position 6 in the visualization color palette.

visualization_color_07stringBeta

The color at position 7 in the visualization color palette.

visualization_color_08stringBeta

The color at position 8 in the visualization color palette.

visualization_color_09stringBeta

The color at position 9 in the visualization color palette.

visualization_color_10stringBeta

The color at position 10 in the visualization color palette.

visualization_color_11stringBeta

The color at position 11 in the visualization color palette.

visualization_color_12stringBeta

The color at position 12 in the visualization color palette.

visualization_color_13stringBeta

The color at position 13 in the visualization color palette.

visualization_color_14stringBeta

The color at position 14 in the visualization color palette.

visualization_color_15stringBeta

The color at position 15 in the visualization color palette.

visualization_color_16stringBeta

The color at position 16 in the visualization color palette.

visualization_color_17stringBeta

The color at position 17 in the visualization color palette.

visualization_color_18stringBeta

The color at position 18 in the visualization color palette.

visualization_color_19stringBeta

The color at position 19 in the visualization color palette.

visualization_color_20stringBeta

The color at position 20 in the visualization color palette.

widget_header_alignmentstringBeta

Alignment setting for all widget titles and descriptions at the dashboard level.

Values:

  • LEFT
  • CENTER
  • RIGHT
font_familystringBeta

Font family to customize all text within the dashboard. Unsupported font names fall back to the default font. Superseded by font_settings.base.font_family when font_settings is set.

text_box_vertical_alignstringBeta

The default vertical alignment for all text box widgets in the dashboard. Individual text box widgets can override this.

Values:

  • VERTICAL_ALIGN_TOP
  • VERTICAL_ALIGN_CENTER
  • VERTICAL_ALIGN_BOTTOM
widget_paddingint32Beta

The content padding inside each widget in pixels.

widget_marginint32Beta

The gap between widgets in pixels.

widget_corner_radiusint32Beta

The widget border radius in pixels.

widget_shadowint32Beta

The shadow intensity level applied to widgets (0 = no shadow, 100 = maximum). The actual CSS box-shadow is computed at render time from this value, factoring in background colors and color mode.

sentiment_colorsobjectBeta

The sentiment color palette for the dashboard.

Show child attributesHide child attributes
negativeobjectBeta

The color applied to negative sentiment values.

Show child attributesHide child attributes
lightstringBeta

The color used when the dashboard is rendered in light mode (for example, '#FF0000').

darkstringBeta

The color used when the dashboard is rendered in dark mode (for example, '#FF0000').

positiveobjectBeta

The color applied to positive sentiment values.

Show child attributesHide child attributes
lightstringBeta

The color used when the dashboard is rendered in light mode (for example, '#FF0000').

darkstringBeta

The color used when the dashboard is rendered in dark mode (for example, '#FF0000').

neutralobjectBeta

The color applied to neutral sentiment values.

Show child attributesHide child attributes
lightstringBeta

The color used when the dashboard is rendered in light mode (for example, '#FF0000').

darkstringBeta

The color used when the dashboard is rendered in dark mode (for example, '#FF0000').

continuous_gradientobjectBeta

The continuous gradient configuration for the dashboard.

Show child attributesHide child attributes
light_modeobjectBeta

Gradient value used when the dashboard is rendered in light mode.

Show child attributesHide child attributes
from_categorical_indexint32Beta

A 0-based index into the visualization color palette, where 0 is visualization_color_01. Valid values are 0 to 19.

colorstringBeta

A static color string (for example, '#FF0000').

color_schemestringBeta

A named color scheme (for example, 'blues', 'viridis', 'spectral').

custom_sequentialobjectBeta

A custom two-stop sequential gradient.

Show child attributesHide child attributes
startobjectBeta

The color at the start of the gradient (lowest value).

Show child attributesHide child attributes
lightstringBeta

The color used when the dashboard is rendered in light mode (for example, '#FF0000').

darkstringBeta

The color used when the dashboard is rendered in dark mode (for example, '#FF0000').

endobjectBeta

The color at the end of the gradient (highest value).

Show child attributesHide child attributes
lightstringBeta

The color used when the dashboard is rendered in light mode (for example, '#FF0000').

darkstringBeta

The color used when the dashboard is rendered in dark mode (for example, '#FF0000').

custom_divergingobjectBeta

A custom three-stop diverging gradient.

Show child attributesHide child attributes
startobjectBeta

The color at the start of the gradient (lowest value).

Show child attributesHide child attributes
lightstringBeta

The color used when the dashboard is rendered in light mode (for example, '#FF0000').

darkstringBeta

The color used when the dashboard is rendered in dark mode (for example, '#FF0000').

midobjectBeta

The color at the midpoint of the gradient.

Show child attributesHide child attributes
lightstringBeta

The color used when the dashboard is rendered in light mode (for example, '#FF0000').

darkstringBeta

The color used when the dashboard is rendered in dark mode (for example, '#FF0000').

endobjectBeta

The color at the end of the gradient (highest value).

Show child attributesHide child attributes
lightstringBeta

The color used when the dashboard is rendered in light mode (for example, '#FF0000').

darkstringBeta

The color used when the dashboard is rendered in dark mode (for example, '#FF0000').

dark_modeobjectBeta

Gradient value used when the dashboard is rendered in dark mode.

Show child attributesHide child attributes
from_categorical_indexint32Beta

A 0-based index into the visualization color palette, where 0 is visualization_color_01. Valid values are 0 to 19.

colorstringBeta

A static color string (for example, '#FF0000').

color_schemestringBeta

A named color scheme (for example, 'blues', 'viridis', 'spectral').

custom_sequentialobjectBeta

A custom two-stop sequential gradient.

Show child attributesHide child attributes
startobjectBeta

The color at the start of the gradient (lowest value).

Show child attributesHide child attributes
lightstringBeta

The color used when the dashboard is rendered in light mode (for example, '#FF0000').

darkstringBeta

The color used when the dashboard is rendered in dark mode (for example, '#FF0000').

endobjectBeta

The color at the end of the gradient (highest value).

Show child attributesHide child attributes
lightstringBeta

The color used when the dashboard is rendered in light mode (for example, '#FF0000').

darkstringBeta

The color used when the dashboard is rendered in dark mode (for example, '#FF0000').

custom_divergingobjectBeta

A custom three-stop diverging gradient.

Show child attributesHide child attributes
startobjectBeta

The color at the start of the gradient (lowest value).

Show child attributesHide child attributes
lightstringBeta

The color used when the dashboard is rendered in light mode (for example, '#FF0000').

darkstringBeta

The color used when the dashboard is rendered in dark mode (for example, '#FF0000').

midobjectBeta

The color at the midpoint of the gradient.

Show child attributesHide child attributes
lightstringBeta

The color used when the dashboard is rendered in light mode (for example, '#FF0000').

darkstringBeta

The color used when the dashboard is rendered in dark mode (for example, '#FF0000').

endobjectBeta

The color at the end of the gradient (highest value).

Show child attributesHide child attributes
lightstringBeta

The color used when the dashboard is rendered in light mode (for example, '#FF0000').

darkstringBeta

The color used when the dashboard is rendered in dark mode (for example, '#FF0000').

font_settingsobjectBeta

The per-category typography overrides for the dashboard.

Show child attributesHide child attributes
baseobjectBeta

The default font config applied to all text unless overridden by a more specific category.

Show child attributesHide child attributes
font_familystringBeta

The font family name used for text in this category.

text_casestringBeta

The text case transformation applied to text in this category.

Values:

  • TEXT_CASE_UPPERCASE
  • TEXT_CASE_CAPITALIZE
  • TEXT_CASE_LOWERCASE
font_colorobjectBeta

The font color applied to text in this category.

Show child attributesHide child attributes
lightstringBeta

The color used when the dashboard is rendered in light mode (for example, '#FF0000').

darkstringBeta

The color used when the dashboard is rendered in dark mode (for example, '#FF0000').

font_sizeint32Beta

The font size in pixels.

font_weightint32Beta

The font weight value (for example, 400 for normal, 700 for bold).

font_stylestringBeta

The font style (slant) applied to text in this category.

Values:

  • FONT_STYLE_NORMAL
  • FONT_STYLE_ITALIC
text_decorationstringBeta

The text decoration applied to text in this category.

Values:

  • TEXT_DECORATION_NONE
  • TEXT_DECORATION_UNDERLINE
widget_titleobjectBeta

The font config applied to widget titles.

Show child attributesHide child attributes
font_familystringBeta

The font family name used for text in this category.

text_casestringBeta

The text case transformation applied to text in this category.

Values:

  • TEXT_CASE_UPPERCASE
  • TEXT_CASE_CAPITALIZE
  • TEXT_CASE_LOWERCASE
font_colorobjectBeta

The font color applied to text in this category.

Show child attributesHide child attributes
lightstringBeta

The color used when the dashboard is rendered in light mode (for example, '#FF0000').

darkstringBeta

The color used when the dashboard is rendered in dark mode (for example, '#FF0000').

font_sizeint32Beta

The font size in pixels.

font_weightint32Beta

The font weight value (for example, 400 for normal, 700 for bold).

font_stylestringBeta

The font style (slant) applied to text in this category.

Values:

  • FONT_STYLE_NORMAL
  • FONT_STYLE_ITALIC
text_decorationstringBeta

The text decoration applied to text in this category.

Values:

  • TEXT_DECORATION_NONE
  • TEXT_DECORATION_UNDERLINE
widget_descriptionobjectBeta

The font config applied to widget descriptions.

Show child attributesHide child attributes
font_familystringBeta

The font family name used for text in this category.

text_casestringBeta

The text case transformation applied to text in this category.

Values:

  • TEXT_CASE_UPPERCASE
  • TEXT_CASE_CAPITALIZE
  • TEXT_CASE_LOWERCASE
font_colorobjectBeta

The font color applied to text in this category.

Show child attributesHide child attributes
lightstringBeta

The color used when the dashboard is rendered in light mode (for example, '#FF0000').

darkstringBeta

The color used when the dashboard is rendered in dark mode (for example, '#FF0000').

font_sizeint32Beta

The font size in pixels.

font_weightint32Beta

The font weight value (for example, 400 for normal, 700 for bold).

font_stylestringBeta

The font style (slant) applied to text in this category.

Values:

  • FONT_STYLE_NORMAL
  • FONT_STYLE_ITALIC
text_decorationstringBeta

The text decoration applied to text in this category.

Values:

  • TEXT_DECORATION_NONE
  • TEXT_DECORATION_UNDERLINE
field_titleobjectBeta

The font config applied to field titles (for example, axis titles, table heading titles).

Show child attributesHide child attributes
font_familystringBeta

The font family name used for text in this category.

text_casestringBeta

The text case transformation applied to text in this category.

Values:

  • TEXT_CASE_UPPERCASE
  • TEXT_CASE_CAPITALIZE
  • TEXT_CASE_LOWERCASE
font_colorobjectBeta

The font color applied to text in this category.

Show child attributesHide child attributes
lightstringBeta

The color used when the dashboard is rendered in light mode (for example, '#FF0000').

darkstringBeta

The color used when the dashboard is rendered in dark mode (for example, '#FF0000').

font_sizeint32Beta

The font size in pixels.

font_weightint32Beta

The font weight value (for example, 400 for normal, 700 for bold).

font_stylestringBeta

The font style (slant) applied to text in this category.

Values:

  • FONT_STYLE_NORMAL
  • FONT_STYLE_ITALIC
text_decorationstringBeta

The text decoration applied to text in this category.

Values:

  • TEXT_DECORATION_NONE
  • TEXT_DECORATION_UNDERLINE
field_valueobjectBeta

The font config applied to field values (for example, axis tick labels, table cell values, tooltip values).

Show child attributesHide child attributes
font_familystringBeta

The font family name used for text in this category.

text_casestringBeta

The text case transformation applied to text in this category.

Values:

  • TEXT_CASE_UPPERCASE
  • TEXT_CASE_CAPITALIZE
  • TEXT_CASE_LOWERCASE
font_colorobjectBeta

The font color applied to text in this category.

Show child attributesHide child attributes
lightstringBeta

The color used when the dashboard is rendered in light mode (for example, '#FF0000').

darkstringBeta

The color used when the dashboard is rendered in dark mode (for example, '#FF0000').

font_sizeint32Beta

The font size in pixels.

font_weightint32Beta

The font weight value (for example, 400 for normal, 700 for bold).

font_stylestringBeta

The font style (slant) applied to text in this category.

Values:

  • FONT_STYLE_NORMAL
  • FONT_STYLE_ITALIC
text_decorationstringBeta

The text decoration applied to text in this category.

Values:

  • TEXT_DECORATION_NONE
  • TEXT_DECORATION_UNDERLINE
mark_corner_radiusint32Beta

The corner radius in pixels for rectangular marks in visualizations (bars, columns, histogram bins, etc.).

grid_line_colorobjectBeta

Color of chart grid lines in visualizations (horizontal and vertical guide lines).

Show child attributesHide child attributes
lightstringBeta

The color used when the dashboard is rendered in light mode (for example, '#FF0000').

darkstringBeta

The color used when the dashboard is rendered in dark mode (for example, '#FF0000').

axis_line_colorobjectBeta

Color of the zero-value grid line, making it visually distinct from other grid lines.

Show child attributesHide child attributes
lightstringBeta

The color used when the dashboard is rendered in light mode (for example, '#FF0000').

darkstringBeta

The color used when the dashboard is rendered in dark mode (for example, '#FF0000').

effective_boolean_valobjectOutput only

Effective setting value for boolean type setting. This is the final effective value of setting. To set a value use boolean_val.

Show child attributesHide child attributes
valueboolean
effective_string_valobjectOutput only

Effective setting value for string type setting. This is the final effective value of setting. To set a value use string_val.

Show child attributesHide child attributes
valuestring

Represents a generic string value.

effective_integer_valobjectOutput only

Effective setting value for integer type setting. This is the final effective value of setting. To set a value use integer_val.

Show child attributesHide child attributes
valueint32
effective_automatic_cluster_update_workspaceobject

Effective setting value for automatic_cluster_update_workspace setting. This is the final effective value of setting. To set a value use automatic_cluster_update_workspace.

Show child attributesHide child attributes
enabledboolean

Whether automatic cluster update is enabled for the workspace. The effective value is always true while the compliance security profile is enabled on the workspace.

can_toggleboolean

Whether the workspace can change the enabled state. Databricks computes this value: it is false when the compliance security profile forces the feature on or when the workspace lacks the Enhanced Security and Compliance entitlement. A value sent in an update request has no effect.

maintenance_windowobject

When the maintenance window runs. When unset, it defaults to the first Sunday of every month at 01:00 UTC.

Show child attributesHide child attributes
week_day_based_scheduleobject

Schedule anchored to a day of the week, either every week or on given weeks of the month.

Show child attributesHide child attributes
frequencystring

How often the maintenance window occurs: every week, or only on the listed occurrences of the day of the week within each month.

Values:

  • FIRST_OF_MONTH
  • SECOND_OF_MONTH
  • THIRD_OF_MONTH
  • FOURTH_OF_MONTH
  • FIRST_AND_THIRD_OF_MONTH
  • SECOND_AND_FOURTH_OF_MONTH
  • EVERY_WEEK
day_of_weekstring

Day of the week on which the maintenance window starts.

Values:

  • MONDAY
  • TUESDAY
  • WEDNESDAY
  • THURSDAY
  • FRIDAY
  • SATURDAY
  • SUNDAY
window_start_timeobject

Time of day, in UTC, at which the maintenance window starts.

Show child attributesHide child attributes
hoursint32

Hour of the day on a 24-hour clock.

minutesint32

Minute of the hour.

enablement_detailsobject

Why the feature is forced on or unavailable. Databricks sets these details for information only; they do not determine whether the feature is enabled.

Show child attributesHide child attributes
unavailable_for_non_enterprise_tierboolean

The feature is unavailable if the customer doesn't have enterprise tier

unavailable_for_disabled_entitlementboolean

The feature is unavailable because the workspace does not have the Enhanced Security and Compliance entitlement.

forced_for_compliance_modeboolean

The feature is force enabled if compliance mode is active

restart_even_if_no_updates_availableboolean

Whether compute resources restart during every maintenance window even when no update is available. When false, they restart only when an update is available.

effective_aibi_dashboard_embedding_approved_domainsobject

Effective setting value for aibi_dashboard_embedding_approved_domains setting. This is the final effective value of setting. To set a value use aibi_dashboard_embedding_approved_domains.

Show child attributesHide child attributes
approved_domainsarray of string

Domains allowed to host embedded AI/BI dashboards. A leading wildcard allows every subdomain of a domain. The list applies, and can only be changed, while the embedding access policy is ALLOW_APPROVED_DOMAINS.

Example: *.example.com

effective_aibi_dashboard_embedding_access_policyobject

Effective setting value for aibi_dashboard_embedding_access_policy setting. This is the final effective value of setting. To set a value use aibi_dashboard_embedding_access_policy.

Show child attributesHide child attributes
access_policy_typestring

Where AI/BI dashboards can be embedded: in any domain (ALLOW_ALL_DOMAINS), only in the approved domains configured for the workspace (ALLOW_APPROVED_DOMAINS), or nowhere (DENY_ALL_DOMAINS). Defaults to ALLOW_APPROVED_DOMAINS.

Values:

  • ALLOW_ALL_DOMAINS
  • ALLOW_APPROVED_DOMAINS
  • DENY_ALL_DOMAINS
effective_restrict_workspace_adminsobject

Effective setting value for restrict_workspace_admins setting. This is the final effective value of setting. To set a value use restrict_workspace_admins.

Show child attributesHide child attributes
statusstring

Controls what workspace admins can do with service principal tokens and job identities. With ALLOW_ALL, workspace admins can create personal access tokens on behalf of any service principal in the workspace, change a job owner to any workspace user, and set a job's run_as identity to any workspace user or to a service principal they have the Service Principal User role on. With RESTRICT_TOKENS_AND_JOB_RUN_AS, they can only create tokens for service principals they have the Service Principal User role on, change a job owner to themselves, and set run_as to themselves or to a service principal they have that role on.

Values:

  • ALLOW_ALL
  • RESTRICT_TOKENS_AND_JOB_RUN_AS
disable_gov_tag_creationbooleanPublic Preview

When true, workspace admins cannot create governance tags. ALLOW_ALL status does not override this; they are independent.

effective_personal_computeobject

Effective setting value for personal_compute setting. This is the final effective value of setting. To set a value use personal_compute.

Show child attributesHide child attributes
valuestring

ON grants all users in all workspaces of the account access to the Personal Compute default policy. DELEGATE moves control to each workspace, where users or groups must be added to the policy's permissions before they can create compute with it.

Values:

  • ON
  • DELEGATE
effective_workspace_labelobjectBeta

Effective setting value for workspace_label setting. This is the final effective value of setting. To set a value use workspace_label.

Show child attributesHide child attributes
labelstringBeta

Text of the label shown next to the workspace name in the top navigation bar. An empty string means no label is set.

colorstringBeta

Color of the label badge. The supported colors are coral, lemon, lime, turquoise, indigo, purple and pink. It is an empty string when no label is set.

effective_allowed_apps_user_api_scopesobjectBetaOutput only

Effective setting value for allowed_apps_user_api_scopes setting. This is the final effective value of setting. To set a value use allowed_apps_user_api_scopes.

Show child attributesHide child attributes
allowed_scopesarray of stringBeta

OAuth scopes that app developers can request when an app acts on behalf of a user. A list with the single entry * allows every supported scope and cannot be combined with other scopes. An empty list disables user authorization for apps.

Example: sql

effective_operational_email_custom_recipientobjectPublic PreviewOutput only

Effective setting value for operational_email_custom_recipient setting. This is the final effective value of setting. To set a value use operational_email_custom_recipient.

Show child attributesHide child attributes
emailstringPublic Preview

Email address that receives this workspace's operational emails in addition to the workspace admins. Use a distribution list address to reach several people. An empty string clears the additional recipient.

Example: platform-ops@example.com

effective_workspace_dashboard_themeobjectBetaOutput only

Effective setting value for the workspace_dashboard_theme setting. This is the final effective value of the setting. To set a value, use workspace_dashboard_theme.

Show child attributesHide child attributes
canvas_background_colorobjectBeta

The background color of the dashboard canvas.

Show child attributesHide child attributes
lightstringBeta

The color used when the dashboard is rendered in light mode (for example, '#FF0000').

darkstringBeta

The color used when the dashboard is rendered in dark mode (for example, '#FF0000').

widget_background_colorobjectBeta

The background color of widgets.

Show child attributesHide child attributes
lightstringBeta

The color used when the dashboard is rendered in light mode (for example, '#FF0000').

darkstringBeta

The color used when the dashboard is rendered in dark mode (for example, '#FF0000').

widget_border_colorobjectBeta

The border color of widgets.

Show child attributesHide child attributes
lightstringBeta

The color used when the dashboard is rendered in light mode (for example, '#FF0000').

darkstringBeta

The color used when the dashboard is rendered in dark mode (for example, '#FF0000').

font_colorobjectBeta

The default font color applied to all text in the dashboard. Superseded by font_settings.base.font_color when font_settings is set. More specific font settings in turn override base.

Show child attributesHide child attributes
lightstringBeta

The color used when the dashboard is rendered in light mode (for example, '#FF0000').

darkstringBeta

The color used when the dashboard is rendered in dark mode (for example, '#FF0000').

selection_colorobjectBeta

The highlight color for selected elements in widgets.

Show child attributesHide child attributes
lightstringBeta

The color used when the dashboard is rendered in light mode (for example, '#FF0000').

darkstringBeta

The color used when the dashboard is rendered in dark mode (for example, '#FF0000').

visualization_color_01stringBeta

Color palette for visualizations. Colors are applied in order (visualization_color_01, visualization_color_02, etc.). Invalid color values are preserved but ignored during rendering.

visualization_color_02stringBeta

The color at position 2 in the visualization color palette.

visualization_color_03stringBeta

The color at position 3 in the visualization color palette.

visualization_color_04stringBeta

The color at position 4 in the visualization color palette.

visualization_color_05stringBeta

The color at position 5 in the visualization color palette.

visualization_color_06stringBeta

The color at position 6 in the visualization color palette.

visualization_color_07stringBeta

The color at position 7 in the visualization color palette.

visualization_color_08stringBeta

The color at position 8 in the visualization color palette.

visualization_color_09stringBeta

The color at position 9 in the visualization color palette.

visualization_color_10stringBeta

The color at position 10 in the visualization color palette.

visualization_color_11stringBeta

The color at position 11 in the visualization color palette.

visualization_color_12stringBeta

The color at position 12 in the visualization color palette.

visualization_color_13stringBeta

The color at position 13 in the visualization color palette.

visualization_color_14stringBeta

The color at position 14 in the visualization color palette.

visualization_color_15stringBeta

The color at position 15 in the visualization color palette.

visualization_color_16stringBeta

The color at position 16 in the visualization color palette.

visualization_color_17stringBeta

The color at position 17 in the visualization color palette.

visualization_color_18stringBeta

The color at position 18 in the visualization color palette.

visualization_color_19stringBeta

The color at position 19 in the visualization color palette.

visualization_color_20stringBeta

The color at position 20 in the visualization color palette.

widget_header_alignmentstringBeta

Alignment setting for all widget titles and descriptions at the dashboard level.

Values:

  • LEFT
  • CENTER
  • RIGHT
font_familystringBeta

Font family to customize all text within the dashboard. Unsupported font names fall back to the default font. Superseded by font_settings.base.font_family when font_settings is set.

text_box_vertical_alignstringBeta

The default vertical alignment for all text box widgets in the dashboard. Individual text box widgets can override this.

Values:

  • VERTICAL_ALIGN_TOP
  • VERTICAL_ALIGN_CENTER
  • VERTICAL_ALIGN_BOTTOM
widget_paddingint32Beta

The content padding inside each widget in pixels.

widget_marginint32Beta

The gap between widgets in pixels.

widget_corner_radiusint32Beta

The widget border radius in pixels.

widget_shadowint32Beta

The shadow intensity level applied to widgets (0 = no shadow, 100 = maximum). The actual CSS box-shadow is computed at render time from this value, factoring in background colors and color mode.

sentiment_colorsobjectBeta

The sentiment color palette for the dashboard.

Show child attributesHide child attributes
negativeobjectBeta

The color applied to negative sentiment values.

Show child attributesHide child attributes
lightstringBeta

The color used when the dashboard is rendered in light mode (for example, '#FF0000').

darkstringBeta

The color used when the dashboard is rendered in dark mode (for example, '#FF0000').

positiveobjectBeta

The color applied to positive sentiment values.

Show child attributesHide child attributes
lightstringBeta

The color used when the dashboard is rendered in light mode (for example, '#FF0000').

darkstringBeta

The color used when the dashboard is rendered in dark mode (for example, '#FF0000').

neutralobjectBeta

The color applied to neutral sentiment values.

Show child attributesHide child attributes
lightstringBeta

The color used when the dashboard is rendered in light mode (for example, '#FF0000').

darkstringBeta

The color used when the dashboard is rendered in dark mode (for example, '#FF0000').

continuous_gradientobjectBeta

The continuous gradient configuration for the dashboard.

Show child attributesHide child attributes
light_modeobjectBeta

Gradient value used when the dashboard is rendered in light mode.

Show child attributesHide child attributes
from_categorical_indexint32Beta

A 0-based index into the visualization color palette, where 0 is visualization_color_01. Valid values are 0 to 19.

colorstringBeta

A static color string (for example, '#FF0000').

color_schemestringBeta

A named color scheme (for example, 'blues', 'viridis', 'spectral').

custom_sequentialobjectBeta

A custom two-stop sequential gradient.

Show child attributesHide child attributes
startobjectBeta

The color at the start of the gradient (lowest value).

Show child attributesHide child attributes
lightstringBeta

The color used when the dashboard is rendered in light mode (for example, '#FF0000').

darkstringBeta

The color used when the dashboard is rendered in dark mode (for example, '#FF0000').

endobjectBeta

The color at the end of the gradient (highest value).

Show child attributesHide child attributes
lightstringBeta

The color used when the dashboard is rendered in light mode (for example, '#FF0000').

darkstringBeta

The color used when the dashboard is rendered in dark mode (for example, '#FF0000').

custom_divergingobjectBeta

A custom three-stop diverging gradient.

Show child attributesHide child attributes
startobjectBeta

The color at the start of the gradient (lowest value).

Show child attributesHide child attributes
lightstringBeta

The color used when the dashboard is rendered in light mode (for example, '#FF0000').

darkstringBeta

The color used when the dashboard is rendered in dark mode (for example, '#FF0000').

midobjectBeta

The color at the midpoint of the gradient.

Show child attributesHide child attributes
lightstringBeta

The color used when the dashboard is rendered in light mode (for example, '#FF0000').

darkstringBeta

The color used when the dashboard is rendered in dark mode (for example, '#FF0000').

endobjectBeta

The color at the end of the gradient (highest value).

Show child attributesHide child attributes
lightstringBeta

The color used when the dashboard is rendered in light mode (for example, '#FF0000').

darkstringBeta

The color used when the dashboard is rendered in dark mode (for example, '#FF0000').

dark_modeobjectBeta

Gradient value used when the dashboard is rendered in dark mode.

Show child attributesHide child attributes
from_categorical_indexint32Beta

A 0-based index into the visualization color palette, where 0 is visualization_color_01. Valid values are 0 to 19.

colorstringBeta

A static color string (for example, '#FF0000').

color_schemestringBeta

A named color scheme (for example, 'blues', 'viridis', 'spectral').

custom_sequentialobjectBeta

A custom two-stop sequential gradient.

Show child attributesHide child attributes
startobjectBeta

The color at the start of the gradient (lowest value).

Show child attributesHide child attributes
lightstringBeta

The color used when the dashboard is rendered in light mode (for example, '#FF0000').

darkstringBeta

The color used when the dashboard is rendered in dark mode (for example, '#FF0000').

endobjectBeta

The color at the end of the gradient (highest value).

Show child attributesHide child attributes
lightstringBeta

The color used when the dashboard is rendered in light mode (for example, '#FF0000').

darkstringBeta

The color used when the dashboard is rendered in dark mode (for example, '#FF0000').

custom_divergingobjectBeta

A custom three-stop diverging gradient.

Show child attributesHide child attributes
startobjectBeta

The color at the start of the gradient (lowest value).

Show child attributesHide child attributes
lightstringBeta

The color used when the dashboard is rendered in light mode (for example, '#FF0000').

darkstringBeta

The color used when the dashboard is rendered in dark mode (for example, '#FF0000').

midobjectBeta

The color at the midpoint of the gradient.

Show child attributesHide child attributes
lightstringBeta

The color used when the dashboard is rendered in light mode (for example, '#FF0000').

darkstringBeta

The color used when the dashboard is rendered in dark mode (for example, '#FF0000').

endobjectBeta

The color at the end of the gradient (highest value).

Show child attributesHide child attributes
lightstringBeta

The color used when the dashboard is rendered in light mode (for example, '#FF0000').

darkstringBeta

The color used when the dashboard is rendered in dark mode (for example, '#FF0000').

font_settingsobjectBeta

The per-category typography overrides for the dashboard.

Show child attributesHide child attributes
baseobjectBeta

The default font config applied to all text unless overridden by a more specific category.

Show child attributesHide child attributes
font_familystringBeta

The font family name used for text in this category.

text_casestringBeta

The text case transformation applied to text in this category.

Values:

  • TEXT_CASE_UPPERCASE
  • TEXT_CASE_CAPITALIZE
  • TEXT_CASE_LOWERCASE
font_colorobjectBeta

The font color applied to text in this category.

Show child attributesHide child attributes
lightstringBeta

The color used when the dashboard is rendered in light mode (for example, '#FF0000').

darkstringBeta

The color used when the dashboard is rendered in dark mode (for example, '#FF0000').

font_sizeint32Beta

The font size in pixels.

font_weightint32Beta

The font weight value (for example, 400 for normal, 700 for bold).

font_stylestringBeta

The font style (slant) applied to text in this category.

Values:

  • FONT_STYLE_NORMAL
  • FONT_STYLE_ITALIC
text_decorationstringBeta

The text decoration applied to text in this category.

Values:

  • TEXT_DECORATION_NONE
  • TEXT_DECORATION_UNDERLINE
widget_titleobjectBeta

The font config applied to widget titles.

Show child attributesHide child attributes
font_familystringBeta

The font family name used for text in this category.

text_casestringBeta

The text case transformation applied to text in this category.

Values:

  • TEXT_CASE_UPPERCASE
  • TEXT_CASE_CAPITALIZE
  • TEXT_CASE_LOWERCASE
font_colorobjectBeta

The font color applied to text in this category.

Show child attributesHide child attributes
lightstringBeta

The color used when the dashboard is rendered in light mode (for example, '#FF0000').

darkstringBeta

The color used when the dashboard is rendered in dark mode (for example, '#FF0000').

font_sizeint32Beta

The font size in pixels.

font_weightint32Beta

The font weight value (for example, 400 for normal, 700 for bold).

font_stylestringBeta

The font style (slant) applied to text in this category.

Values:

  • FONT_STYLE_NORMAL
  • FONT_STYLE_ITALIC
text_decorationstringBeta

The text decoration applied to text in this category.

Values:

  • TEXT_DECORATION_NONE
  • TEXT_DECORATION_UNDERLINE
widget_descriptionobjectBeta

The font config applied to widget descriptions.

Show child attributesHide child attributes
font_familystringBeta

The font family name used for text in this category.

text_casestringBeta

The text case transformation applied to text in this category.

Values:

  • TEXT_CASE_UPPERCASE
  • TEXT_CASE_CAPITALIZE
  • TEXT_CASE_LOWERCASE
font_colorobjectBeta

The font color applied to text in this category.

Show child attributesHide child attributes
lightstringBeta

The color used when the dashboard is rendered in light mode (for example, '#FF0000').

darkstringBeta

The color used when the dashboard is rendered in dark mode (for example, '#FF0000').

font_sizeint32Beta

The font size in pixels.

font_weightint32Beta

The font weight value (for example, 400 for normal, 700 for bold).

font_stylestringBeta

The font style (slant) applied to text in this category.

Values:

  • FONT_STYLE_NORMAL
  • FONT_STYLE_ITALIC
text_decorationstringBeta

The text decoration applied to text in this category.

Values:

  • TEXT_DECORATION_NONE
  • TEXT_DECORATION_UNDERLINE
field_titleobjectBeta

The font config applied to field titles (for example, axis titles, table heading titles).

Show child attributesHide child attributes
font_familystringBeta

The font family name used for text in this category.

text_casestringBeta

The text case transformation applied to text in this category.

Values:

  • TEXT_CASE_UPPERCASE
  • TEXT_CASE_CAPITALIZE
  • TEXT_CASE_LOWERCASE
font_colorobjectBeta

The font color applied to text in this category.

Show child attributesHide child attributes
lightstringBeta

The color used when the dashboard is rendered in light mode (for example, '#FF0000').

darkstringBeta

The color used when the dashboard is rendered in dark mode (for example, '#FF0000').

font_sizeint32Beta

The font size in pixels.

font_weightint32Beta

The font weight value (for example, 400 for normal, 700 for bold).

font_stylestringBeta

The font style (slant) applied to text in this category.

Values:

  • FONT_STYLE_NORMAL
  • FONT_STYLE_ITALIC
text_decorationstringBeta

The text decoration applied to text in this category.

Values:

  • TEXT_DECORATION_NONE
  • TEXT_DECORATION_UNDERLINE
field_valueobjectBeta

The font config applied to field values (for example, axis tick labels, table cell values, tooltip values).

Show child attributesHide child attributes
font_familystringBeta

The font family name used for text in this category.

text_casestringBeta

The text case transformation applied to text in this category.

Values:

  • TEXT_CASE_UPPERCASE
  • TEXT_CASE_CAPITALIZE
  • TEXT_CASE_LOWERCASE
font_colorobjectBeta

The font color applied to text in this category.

Show child attributesHide child attributes
lightstringBeta

The color used when the dashboard is rendered in light mode (for example, '#FF0000').

darkstringBeta

The color used when the dashboard is rendered in dark mode (for example, '#FF0000').

font_sizeint32Beta

The font size in pixels.

font_weightint32Beta

The font weight value (for example, 400 for normal, 700 for bold).

font_stylestringBeta

The font style (slant) applied to text in this category.

Values:

  • FONT_STYLE_NORMAL
  • FONT_STYLE_ITALIC
text_decorationstringBeta

The text decoration applied to text in this category.

Values:

  • TEXT_DECORATION_NONE
  • TEXT_DECORATION_UNDERLINE
mark_corner_radiusint32Beta

The corner radius in pixels for rectangular marks in visualizations (bars, columns, histogram bins, etc.).

grid_line_colorobjectBeta

Color of chart grid lines in visualizations (horizontal and vertical guide lines).

Show child attributesHide child attributes
lightstringBeta

The color used when the dashboard is rendered in light mode (for example, '#FF0000').

darkstringBeta

The color used when the dashboard is rendered in dark mode (for example, '#FF0000').

axis_line_colorobjectBeta

Color of the zero-value grid line, making it visually distinct from other grid lines.

Show child attributesHide child attributes
lightstringBeta

The color used when the dashboard is rendered in light mode (for example, '#FF0000').

darkstringBeta

The color used when the dashboard is rendered in dark mode (for example, '#FF0000').

Get an account setting GA​

GET /api/2.1/accounts/{account_id}/settings/{name}

Get a setting value at account level. See settingsv2/listaccountsettingsmetadata for list of setting available via public APIs at account level.

API scopes: settings

Parameters​

account_idstringuuidRequiredpath
namestringRequiredpath

Response​

Returns the Setting object.

Update an account setting GA​

PATCH /api/2.1/accounts/{account_id}/settings/{name}

Patch a setting value at account level. See settingsv2/listaccountsettingsmetadata for list of setting available via public APIs at account level. To determine the correct field to include in a patch request, refer to the type field of the setting returned in the settingsv2/listaccountsettingsmetadata response.

Note: Page refresh is required for changes to take effect in UI.

API scopes: settings

Parameters​

account_idstringuuidRequiredpath

<Databricks> account ID of the account being managed.

namestringRequiredpath

Request body​

namestring

Name of the setting. The settings metadata endpoint lists the names available at each scope.

Example: llm_proxy_partner_powered

boolean_valobject

Setting value for boolean type setting. This is the setting value set by consumers, check effective_boolean_val for final setting value.

Show child attributesHide child attributes
valueboolean
string_valobject

Setting value for string type setting. This is the setting value set by consumers, check effective_string_val for final setting value.

Show child attributesHide child attributes
valuestring

Represents a generic string value.

integer_valobject

Setting value for integer type setting. This is the setting value set by consumers, check effective_integer_val for final setting value.

Show child attributesHide child attributes
valueint32
automatic_cluster_update_workspaceobject

Setting value for automatic_cluster_update_workspace setting. This is the setting value set by consumers, check effective_automatic_cluster_update_workspace for final setting value.

Show child attributesHide child attributes
enabledboolean

Whether automatic cluster update is enabled for the workspace. The effective value is always true while the compliance security profile is enabled on the workspace.

can_toggleboolean

Whether the workspace can change the enabled state. Databricks computes this value: it is false when the compliance security profile forces the feature on or when the workspace lacks the Enhanced Security and Compliance entitlement. A value sent in an update request has no effect.

maintenance_windowobject

When the maintenance window runs. When unset, it defaults to the first Sunday of every month at 01:00 UTC.

Show child attributesHide child attributes
week_day_based_scheduleobject

Schedule anchored to a day of the week, either every week or on given weeks of the month.

Show child attributesHide child attributes
frequencystring

How often the maintenance window occurs: every week, or only on the listed occurrences of the day of the week within each month.

Values:

  • FIRST_OF_MONTH
  • SECOND_OF_MONTH
  • THIRD_OF_MONTH
  • FOURTH_OF_MONTH
  • FIRST_AND_THIRD_OF_MONTH
  • SECOND_AND_FOURTH_OF_MONTH
  • EVERY_WEEK
day_of_weekstring

Day of the week on which the maintenance window starts.

Values:

  • MONDAY
  • TUESDAY
  • WEDNESDAY
  • THURSDAY
  • FRIDAY
  • SATURDAY
  • SUNDAY
window_start_timeobject

Time of day, in UTC, at which the maintenance window starts.

Show child attributesHide child attributes
hoursint32

Hour of the day on a 24-hour clock.

minutesint32

Minute of the hour.

enablement_detailsobject

Why the feature is forced on or unavailable. Databricks sets these details for information only; they do not determine whether the feature is enabled.

Show child attributesHide child attributes
unavailable_for_non_enterprise_tierboolean

The feature is unavailable if the customer doesn't have enterprise tier

unavailable_for_disabled_entitlementboolean

The feature is unavailable because the workspace does not have the Enhanced Security and Compliance entitlement.

forced_for_compliance_modeboolean

The feature is force enabled if compliance mode is active

restart_even_if_no_updates_availableboolean

Whether compute resources restart during every maintenance window even when no update is available. When false, they restart only when an update is available.

aibi_dashboard_embedding_approved_domainsobject

Setting value for aibi_dashboard_embedding_approved_domains setting. This is the setting value set by consumers, check effective_aibi_dashboard_embedding_approved_domains for final setting value.

Show child attributesHide child attributes
approved_domainsarray of string

Domains allowed to host embedded AI/BI dashboards. A leading wildcard allows every subdomain of a domain. The list applies, and can only be changed, while the embedding access policy is ALLOW_APPROVED_DOMAINS.

Example: *.example.com

aibi_dashboard_embedding_access_policyobject

Setting value for aibi_dashboard_embedding_access_policy setting. This is the setting value set by consumers, check effective_aibi_dashboard_embedding_access_policy for final setting value.

Show child attributesHide child attributes
access_policy_typestringRequired

Where AI/BI dashboards can be embedded: in any domain (ALLOW_ALL_DOMAINS), only in the approved domains configured for the workspace (ALLOW_APPROVED_DOMAINS), or nowhere (DENY_ALL_DOMAINS). Defaults to ALLOW_APPROVED_DOMAINS.

Values:

  • ALLOW_ALL_DOMAINS
  • ALLOW_APPROVED_DOMAINS
  • DENY_ALL_DOMAINS
restrict_workspace_adminsobject

Setting value for restrict_workspace_admins setting. This is the setting value set by consumers, check effective_restrict_workspace_admins for final setting value.

Show child attributesHide child attributes
statusstringRequired

Controls what workspace admins can do with service principal tokens and job identities. With ALLOW_ALL, workspace admins can create personal access tokens on behalf of any service principal in the workspace, change a job owner to any workspace user, and set a job's run_as identity to any workspace user or to a service principal they have the Service Principal User role on. With RESTRICT_TOKENS_AND_JOB_RUN_AS, they can only create tokens for service principals they have the Service Principal User role on, change a job owner to themselves, and set run_as to themselves or to a service principal they have that role on.

Values:

  • ALLOW_ALL
  • RESTRICT_TOKENS_AND_JOB_RUN_AS
disable_gov_tag_creationbooleanPublic Preview

When true, workspace admins cannot create governance tags. ALLOW_ALL status does not override this; they are independent.

personal_computeobject

Setting value for personal_compute setting. This is the setting value set by consumers, check effective_personal_compute for final setting value.

Show child attributesHide child attributes
valuestring

ON grants all users in all workspaces of the account access to the Personal Compute default policy. DELEGATE moves control to each workspace, where users or groups must be added to the policy's permissions before they can create compute with it.

Values:

  • ON
  • DELEGATE
workspace_labelobjectBeta

Setting value for workspace_label setting. This is the setting value set by consumers, check effective_workspace_label for final setting value.

Show child attributesHide child attributes
labelstringBeta

Text of the label shown next to the workspace name in the top navigation bar. An empty string means no label is set.

colorstringBeta

Color of the label badge. The supported colors are coral, lemon, lime, turquoise, indigo, purple and pink. It is an empty string when no label is set.

allowed_apps_user_api_scopesobjectBeta

Setting value for allowed_apps_user_api_scopes setting. This is the setting value set by consumers, check effective_allowed_apps_user_api_scopes for final setting value.

Show child attributesHide child attributes
allowed_scopesarray of stringBeta

OAuth scopes that app developers can request when an app acts on behalf of a user. A list with the single entry * allows every supported scope and cannot be combined with other scopes. An empty list disables user authorization for apps.

Example: sql

operational_email_custom_recipientobjectPublic Preview

Setting value for operational_email_custom_recipient setting. This is the setting value set by consumers, check effective_operational_email_custom_recipient for final setting value.

Show child attributesHide child attributes
emailstringPublic Preview

Email address that receives this workspace's operational emails in addition to the workspace admins. Use a distribution list address to reach several people. An empty string clears the additional recipient.

Example: platform-ops@example.com

workspace_dashboard_themeobjectBeta

Setting value for the workspace_dashboard_theme setting. This is the setting value set by consumers. Check effective_workspace_dashboard_theme for the final setting value.

Show child attributesHide child attributes
canvas_background_colorobjectBeta

The background color of the dashboard canvas.

Show child attributesHide child attributes
lightstringBeta

The color used when the dashboard is rendered in light mode (for example, '#FF0000').

darkstringBeta

The color used when the dashboard is rendered in dark mode (for example, '#FF0000').

widget_background_colorobjectBeta

The background color of widgets.

Show child attributesHide child attributes
lightstringBeta

The color used when the dashboard is rendered in light mode (for example, '#FF0000').

darkstringBeta

The color used when the dashboard is rendered in dark mode (for example, '#FF0000').

widget_border_colorobjectBeta

The border color of widgets.

Show child attributesHide child attributes
lightstringBeta

The color used when the dashboard is rendered in light mode (for example, '#FF0000').

darkstringBeta

The color used when the dashboard is rendered in dark mode (for example, '#FF0000').

font_colorobjectBeta

The default font color applied to all text in the dashboard. Superseded by font_settings.base.font_color when font_settings is set. More specific font settings in turn override base.

Show child attributesHide child attributes
lightstringBeta

The color used when the dashboard is rendered in light mode (for example, '#FF0000').

darkstringBeta

The color used when the dashboard is rendered in dark mode (for example, '#FF0000').

selection_colorobjectBeta

The highlight color for selected elements in widgets.

Show child attributesHide child attributes
lightstringBeta

The color used when the dashboard is rendered in light mode (for example, '#FF0000').

darkstringBeta

The color used when the dashboard is rendered in dark mode (for example, '#FF0000').

visualization_color_01stringBeta

Color palette for visualizations. Colors are applied in order (visualization_color_01, visualization_color_02, etc.). Invalid color values are preserved but ignored during rendering.

visualization_color_02stringBeta

The color at position 2 in the visualization color palette.

visualization_color_03stringBeta

The color at position 3 in the visualization color palette.

visualization_color_04stringBeta

The color at position 4 in the visualization color palette.

visualization_color_05stringBeta

The color at position 5 in the visualization color palette.

visualization_color_06stringBeta

The color at position 6 in the visualization color palette.

visualization_color_07stringBeta

The color at position 7 in the visualization color palette.

visualization_color_08stringBeta

The color at position 8 in the visualization color palette.

visualization_color_09stringBeta

The color at position 9 in the visualization color palette.

visualization_color_10stringBeta

The color at position 10 in the visualization color palette.

visualization_color_11stringBeta

The color at position 11 in the visualization color palette.

visualization_color_12stringBeta

The color at position 12 in the visualization color palette.

visualization_color_13stringBeta

The color at position 13 in the visualization color palette.

visualization_color_14stringBeta

The color at position 14 in the visualization color palette.

visualization_color_15stringBeta

The color at position 15 in the visualization color palette.

visualization_color_16stringBeta

The color at position 16 in the visualization color palette.

visualization_color_17stringBeta

The color at position 17 in the visualization color palette.

visualization_color_18stringBeta

The color at position 18 in the visualization color palette.

visualization_color_19stringBeta

The color at position 19 in the visualization color palette.

visualization_color_20stringBeta

The color at position 20 in the visualization color palette.

widget_header_alignmentstringBeta

Alignment setting for all widget titles and descriptions at the dashboard level.

Values:

  • LEFT
  • CENTER
  • RIGHT
font_familystringBeta

Font family to customize all text within the dashboard. Unsupported font names fall back to the default font. Superseded by font_settings.base.font_family when font_settings is set.

text_box_vertical_alignstringBeta

The default vertical alignment for all text box widgets in the dashboard. Individual text box widgets can override this.

Values:

  • VERTICAL_ALIGN_TOP
  • VERTICAL_ALIGN_CENTER
  • VERTICAL_ALIGN_BOTTOM
widget_paddingint32Beta

The content padding inside each widget in pixels.

widget_marginint32Beta

The gap between widgets in pixels.

widget_corner_radiusint32Beta

The widget border radius in pixels.

widget_shadowint32Beta

The shadow intensity level applied to widgets (0 = no shadow, 100 = maximum). The actual CSS box-shadow is computed at render time from this value, factoring in background colors and color mode.

sentiment_colorsobjectBeta

The sentiment color palette for the dashboard.

Show child attributesHide child attributes
negativeobjectBeta

The color applied to negative sentiment values.

Show child attributesHide child attributes
lightstringBeta

The color used when the dashboard is rendered in light mode (for example, '#FF0000').

darkstringBeta

The color used when the dashboard is rendered in dark mode (for example, '#FF0000').

positiveobjectBeta

The color applied to positive sentiment values.

Show child attributesHide child attributes
lightstringBeta

The color used when the dashboard is rendered in light mode (for example, '#FF0000').

darkstringBeta

The color used when the dashboard is rendered in dark mode (for example, '#FF0000').

neutralobjectBeta

The color applied to neutral sentiment values.

Show child attributesHide child attributes
lightstringBeta

The color used when the dashboard is rendered in light mode (for example, '#FF0000').

darkstringBeta

The color used when the dashboard is rendered in dark mode (for example, '#FF0000').

continuous_gradientobjectBeta

The continuous gradient configuration for the dashboard.

Show child attributesHide child attributes
light_modeobjectBeta

Gradient value used when the dashboard is rendered in light mode.

Show child attributesHide child attributes
from_categorical_indexint32Beta

A 0-based index into the visualization color palette, where 0 is visualization_color_01. Valid values are 0 to 19.

colorstringBeta

A static color string (for example, '#FF0000').

color_schemestringBeta

A named color scheme (for example, 'blues', 'viridis', 'spectral').

custom_sequentialobjectBeta

A custom two-stop sequential gradient.

Show child attributesHide child attributes
startobjectBeta

The color at the start of the gradient (lowest value).

Show child attributesHide child attributes
lightstringBeta

The color used when the dashboard is rendered in light mode (for example, '#FF0000').

darkstringBeta

The color used when the dashboard is rendered in dark mode (for example, '#FF0000').

endobjectBeta

The color at the end of the gradient (highest value).

Show child attributesHide child attributes
lightstringBeta

The color used when the dashboard is rendered in light mode (for example, '#FF0000').

darkstringBeta

The color used when the dashboard is rendered in dark mode (for example, '#FF0000').

custom_divergingobjectBeta

A custom three-stop diverging gradient.

Show child attributesHide child attributes
startobjectBeta

The color at the start of the gradient (lowest value).

Show child attributesHide child attributes
lightstringBeta

The color used when the dashboard is rendered in light mode (for example, '#FF0000').

darkstringBeta

The color used when the dashboard is rendered in dark mode (for example, '#FF0000').

midobjectBeta

The color at the midpoint of the gradient.

Show child attributesHide child attributes
lightstringBeta

The color used when the dashboard is rendered in light mode (for example, '#FF0000').

darkstringBeta

The color used when the dashboard is rendered in dark mode (for example, '#FF0000').

endobjectBeta

The color at the end of the gradient (highest value).

Show child attributesHide child attributes
lightstringBeta

The color used when the dashboard is rendered in light mode (for example, '#FF0000').

darkstringBeta

The color used when the dashboard is rendered in dark mode (for example, '#FF0000').

dark_modeobjectBeta

Gradient value used when the dashboard is rendered in dark mode.

Show child attributesHide child attributes
from_categorical_indexint32Beta

A 0-based index into the visualization color palette, where 0 is visualization_color_01. Valid values are 0 to 19.

colorstringBeta

A static color string (for example, '#FF0000').

color_schemestringBeta

A named color scheme (for example, 'blues', 'viridis', 'spectral').

custom_sequentialobjectBeta

A custom two-stop sequential gradient.

Show child attributesHide child attributes
startobjectBeta

The color at the start of the gradient (lowest value).

Show child attributesHide child attributes
lightstringBeta

The color used when the dashboard is rendered in light mode (for example, '#FF0000').

darkstringBeta

The color used when the dashboard is rendered in dark mode (for example, '#FF0000').

endobjectBeta

The color at the end of the gradient (highest value).

Show child attributesHide child attributes
lightstringBeta

The color used when the dashboard is rendered in light mode (for example, '#FF0000').

darkstringBeta

The color used when the dashboard is rendered in dark mode (for example, '#FF0000').

custom_divergingobjectBeta

A custom three-stop diverging gradient.

Show child attributesHide child attributes
startobjectBeta

The color at the start of the gradient (lowest value).

Show child attributesHide child attributes
lightstringBeta

The color used when the dashboard is rendered in light mode (for example, '#FF0000').

darkstringBeta

The color used when the dashboard is rendered in dark mode (for example, '#FF0000').

midobjectBeta

The color at the midpoint of the gradient.

Show child attributesHide child attributes
lightstringBeta

The color used when the dashboard is rendered in light mode (for example, '#FF0000').

darkstringBeta

The color used when the dashboard is rendered in dark mode (for example, '#FF0000').

endobjectBeta

The color at the end of the gradient (highest value).

Show child attributesHide child attributes
lightstringBeta

The color used when the dashboard is rendered in light mode (for example, '#FF0000').

darkstringBeta

The color used when the dashboard is rendered in dark mode (for example, '#FF0000').

font_settingsobjectBeta

The per-category typography overrides for the dashboard.

Show child attributesHide child attributes
baseobjectBeta

The default font config applied to all text unless overridden by a more specific category.

Show child attributesHide child attributes
font_familystringBeta

The font family name used for text in this category.

text_casestringBeta

The text case transformation applied to text in this category.

Values:

  • TEXT_CASE_UPPERCASE
  • TEXT_CASE_CAPITALIZE
  • TEXT_CASE_LOWERCASE
font_colorobjectBeta

The font color applied to text in this category.

Show child attributesHide child attributes
lightstringBeta

The color used when the dashboard is rendered in light mode (for example, '#FF0000').

darkstringBeta

The color used when the dashboard is rendered in dark mode (for example, '#FF0000').

font_sizeint32Beta

The font size in pixels.

font_weightint32Beta

The font weight value (for example, 400 for normal, 700 for bold).

font_stylestringBeta

The font style (slant) applied to text in this category.

Values:

  • FONT_STYLE_NORMAL
  • FONT_STYLE_ITALIC
text_decorationstringBeta

The text decoration applied to text in this category.

Values:

  • TEXT_DECORATION_NONE
  • TEXT_DECORATION_UNDERLINE
widget_titleobjectBeta

The font config applied to widget titles.

Show child attributesHide child attributes
font_familystringBeta

The font family name used for text in this category.

text_casestringBeta

The text case transformation applied to text in this category.

Values:

  • TEXT_CASE_UPPERCASE
  • TEXT_CASE_CAPITALIZE
  • TEXT_CASE_LOWERCASE
font_colorobjectBeta

The font color applied to text in this category.

Show child attributesHide child attributes
lightstringBeta

The color used when the dashboard is rendered in light mode (for example, '#FF0000').

darkstringBeta

The color used when the dashboard is rendered in dark mode (for example, '#FF0000').

font_sizeint32Beta

The font size in pixels.

font_weightint32Beta

The font weight value (for example, 400 for normal, 700 for bold).

font_stylestringBeta

The font style (slant) applied to text in this category.

Values:

  • FONT_STYLE_NORMAL
  • FONT_STYLE_ITALIC
text_decorationstringBeta

The text decoration applied to text in this category.

Values:

  • TEXT_DECORATION_NONE
  • TEXT_DECORATION_UNDERLINE
widget_descriptionobjectBeta

The font config applied to widget descriptions.

Show child attributesHide child attributes
font_familystringBeta

The font family name used for text in this category.

text_casestringBeta

The text case transformation applied to text in this category.

Values:

  • TEXT_CASE_UPPERCASE
  • TEXT_CASE_CAPITALIZE
  • TEXT_CASE_LOWERCASE
font_colorobjectBeta

The font color applied to text in this category.

Show child attributesHide child attributes
lightstringBeta

The color used when the dashboard is rendered in light mode (for example, '#FF0000').

darkstringBeta

The color used when the dashboard is rendered in dark mode (for example, '#FF0000').

font_sizeint32Beta

The font size in pixels.

font_weightint32Beta

The font weight value (for example, 400 for normal, 700 for bold).

font_stylestringBeta

The font style (slant) applied to text in this category.

Values:

  • FONT_STYLE_NORMAL
  • FONT_STYLE_ITALIC
text_decorationstringBeta

The text decoration applied to text in this category.

Values:

  • TEXT_DECORATION_NONE
  • TEXT_DECORATION_UNDERLINE
field_titleobjectBeta

The font config applied to field titles (for example, axis titles, table heading titles).

Show child attributesHide child attributes
font_familystringBeta

The font family name used for text in this category.

text_casestringBeta

The text case transformation applied to text in this category.

Values:

  • TEXT_CASE_UPPERCASE
  • TEXT_CASE_CAPITALIZE
  • TEXT_CASE_LOWERCASE
font_colorobjectBeta

The font color applied to text in this category.

Show child attributesHide child attributes
lightstringBeta

The color used when the dashboard is rendered in light mode (for example, '#FF0000').

darkstringBeta

The color used when the dashboard is rendered in dark mode (for example, '#FF0000').

font_sizeint32Beta

The font size in pixels.

font_weightint32Beta

The font weight value (for example, 400 for normal, 700 for bold).

font_stylestringBeta

The font style (slant) applied to text in this category.

Values:

  • FONT_STYLE_NORMAL
  • FONT_STYLE_ITALIC
text_decorationstringBeta

The text decoration applied to text in this category.

Values:

  • TEXT_DECORATION_NONE
  • TEXT_DECORATION_UNDERLINE
field_valueobjectBeta

The font config applied to field values (for example, axis tick labels, table cell values, tooltip values).

Show child attributesHide child attributes
font_familystringBeta

The font family name used for text in this category.

text_casestringBeta

The text case transformation applied to text in this category.

Values:

  • TEXT_CASE_UPPERCASE
  • TEXT_CASE_CAPITALIZE
  • TEXT_CASE_LOWERCASE
font_colorobjectBeta

The font color applied to text in this category.

Show child attributesHide child attributes
lightstringBeta

The color used when the dashboard is rendered in light mode (for example, '#FF0000').

darkstringBeta

The color used when the dashboard is rendered in dark mode (for example, '#FF0000').

font_sizeint32Beta

The font size in pixels.

font_weightint32Beta

The font weight value (for example, 400 for normal, 700 for bold).

font_stylestringBeta

The font style (slant) applied to text in this category.

Values:

  • FONT_STYLE_NORMAL
  • FONT_STYLE_ITALIC
text_decorationstringBeta

The text decoration applied to text in this category.

Values:

  • TEXT_DECORATION_NONE
  • TEXT_DECORATION_UNDERLINE
mark_corner_radiusint32Beta

The corner radius in pixels for rectangular marks in visualizations (bars, columns, histogram bins, etc.).

grid_line_colorobjectBeta

Color of chart grid lines in visualizations (horizontal and vertical guide lines).

Show child attributesHide child attributes
lightstringBeta

The color used when the dashboard is rendered in light mode (for example, '#FF0000').

darkstringBeta

The color used when the dashboard is rendered in dark mode (for example, '#FF0000').

axis_line_colorobjectBeta

Color of the zero-value grid line, making it visually distinct from other grid lines.

Show child attributesHide child attributes
lightstringBeta

The color used when the dashboard is rendered in light mode (for example, '#FF0000').

darkstringBeta

The color used when the dashboard is rendered in dark mode (for example, '#FF0000').

effective_automatic_cluster_update_workspaceobject

Effective setting value for automatic_cluster_update_workspace setting. This is the final effective value of setting. To set a value use automatic_cluster_update_workspace.

Show child attributesHide child attributes
enabledboolean

Whether automatic cluster update is enabled for the workspace. The effective value is always true while the compliance security profile is enabled on the workspace.

can_toggleboolean

Whether the workspace can change the enabled state. Databricks computes this value: it is false when the compliance security profile forces the feature on or when the workspace lacks the Enhanced Security and Compliance entitlement. A value sent in an update request has no effect.

maintenance_windowobject

When the maintenance window runs. When unset, it defaults to the first Sunday of every month at 01:00 UTC.

Show child attributesHide child attributes
week_day_based_scheduleobject

Schedule anchored to a day of the week, either every week or on given weeks of the month.

Show child attributesHide child attributes
frequencystring

How often the maintenance window occurs: every week, or only on the listed occurrences of the day of the week within each month.

Values:

  • FIRST_OF_MONTH
  • SECOND_OF_MONTH
  • THIRD_OF_MONTH
  • FOURTH_OF_MONTH
  • FIRST_AND_THIRD_OF_MONTH
  • SECOND_AND_FOURTH_OF_MONTH
  • EVERY_WEEK
day_of_weekstring

Day of the week on which the maintenance window starts.

Values:

  • MONDAY
  • TUESDAY
  • WEDNESDAY
  • THURSDAY
  • FRIDAY
  • SATURDAY
  • SUNDAY
window_start_timeobject

Time of day, in UTC, at which the maintenance window starts.

Show child attributesHide child attributes
hoursint32

Hour of the day on a 24-hour clock.

minutesint32

Minute of the hour.

enablement_detailsobject

Why the feature is forced on or unavailable. Databricks sets these details for information only; they do not determine whether the feature is enabled.

Show child attributesHide child attributes
unavailable_for_non_enterprise_tierboolean

The feature is unavailable if the customer doesn't have enterprise tier

unavailable_for_disabled_entitlementboolean

The feature is unavailable because the workspace does not have the Enhanced Security and Compliance entitlement.

forced_for_compliance_modeboolean

The feature is force enabled if compliance mode is active

restart_even_if_no_updates_availableboolean

Whether compute resources restart during every maintenance window even when no update is available. When false, they restart only when an update is available.

effective_aibi_dashboard_embedding_approved_domainsobject

Effective setting value for aibi_dashboard_embedding_approved_domains setting. This is the final effective value of setting. To set a value use aibi_dashboard_embedding_approved_domains.

Show child attributesHide child attributes
approved_domainsarray of string

Domains allowed to host embedded AI/BI dashboards. A leading wildcard allows every subdomain of a domain. The list applies, and can only be changed, while the embedding access policy is ALLOW_APPROVED_DOMAINS.

Example: *.example.com

effective_aibi_dashboard_embedding_access_policyobject

Effective setting value for aibi_dashboard_embedding_access_policy setting. This is the final effective value of setting. To set a value use aibi_dashboard_embedding_access_policy.

Show child attributesHide child attributes
access_policy_typestringRequired

Where AI/BI dashboards can be embedded: in any domain (ALLOW_ALL_DOMAINS), only in the approved domains configured for the workspace (ALLOW_APPROVED_DOMAINS), or nowhere (DENY_ALL_DOMAINS). Defaults to ALLOW_APPROVED_DOMAINS.

Values:

  • ALLOW_ALL_DOMAINS
  • ALLOW_APPROVED_DOMAINS
  • DENY_ALL_DOMAINS
effective_restrict_workspace_adminsobject

Effective setting value for restrict_workspace_admins setting. This is the final effective value of setting. To set a value use restrict_workspace_admins.

Show child attributesHide child attributes
statusstringRequired

Controls what workspace admins can do with service principal tokens and job identities. With ALLOW_ALL, workspace admins can create personal access tokens on behalf of any service principal in the workspace, change a job owner to any workspace user, and set a job's run_as identity to any workspace user or to a service principal they have the Service Principal User role on. With RESTRICT_TOKENS_AND_JOB_RUN_AS, they can only create tokens for service principals they have the Service Principal User role on, change a job owner to themselves, and set run_as to themselves or to a service principal they have that role on.

Values:

  • ALLOW_ALL
  • RESTRICT_TOKENS_AND_JOB_RUN_AS
disable_gov_tag_creationbooleanPublic Preview

When true, workspace admins cannot create governance tags. ALLOW_ALL status does not override this; they are independent.

effective_personal_computeobject

Effective setting value for personal_compute setting. This is the final effective value of setting. To set a value use personal_compute.

Show child attributesHide child attributes
valuestring

ON grants all users in all workspaces of the account access to the Personal Compute default policy. DELEGATE moves control to each workspace, where users or groups must be added to the policy's permissions before they can create compute with it.

Values:

  • ON
  • DELEGATE
effective_workspace_labelobjectBeta

Effective setting value for workspace_label setting. This is the final effective value of setting. To set a value use workspace_label.

Show child attributesHide child attributes
labelstringBeta

Text of the label shown next to the workspace name in the top navigation bar. An empty string means no label is set.

colorstringBeta

Color of the label badge. The supported colors are coral, lemon, lime, turquoise, indigo, purple and pink. It is an empty string when no label is set.

Response​

Returns the Setting object.