Skip to main content

Default Workspace Base Environment

View as Markdown

A singleton resource representing the default workspace base environment configuration. This resource contains the workspace base environments that are used as defaults for serverless notebooks and jobs in the workspace, for both CPU and GPU compute types.

When cpu_workspace_base_environment or gpu_workspace_base_environment is unset, new serverless notebooks for that compute type use the Databricks Standard base environment: the latest stable standard environment version provided by Databricks, with no workspace base environment applied. The workspace settings page shows this as Standard Latest.

DefaultWorkspaceBaseEnvironment object​

A singleton resource representing the default workspace base environment configuration. This resource contains the workspace base environments that are used as defaults for serverless notebooks and jobs in the workspace, for both CPU and GPU compute types.

When cpu_workspace_base_environment or gpu_workspace_base_environment is unset, new serverless notebooks for that compute type use the Databricks Standard base environment: the latest stable standard environment version provided by Databricks, with no workspace base environment applied. The workspace settings page shows this as Standard Latest.

namestringIDImmutable

The resource name of this singleton resource. Format: default-workspace-base-environment

cpu_workspace_base_environmentstring

The default workspace base environment for CPU compute. If unset, CPU compute defaults to the Databricks Standard base environment (Standard Latest). Format: workspace-base-environments/{workspace_base_environment}

gpu_workspace_base_environmentstring

The default workspace base environment for GPU compute. If unset, GPU compute defaults to the Databricks Standard base environment (Standard Latest). Format: workspace-base-environments/{workspace_base_environment}

Get the default workspace base environment configuration GA​

GET /api/environments/v1/{name=default-workspace-base-environment}

Gets the default WorkspaceBaseEnvironment configuration for the workspace. Returns the current default base environment settings for both CPU and GPU compute. An unset CPU or GPU field means that compute type uses the Databricks Standard base environment.

API scopes: environments

Parameters​

namestringRequiredpath

A static resource name of the default workspace base environment. Format: default-workspace-base-environment

Response​

Returns the DefaultWorkspaceBaseEnvironment object.

Update the default workspace base environment configuration GA​

PATCH /api/environments/v1/{name=default-workspace-base-environment}

Updates the default WorkspaceBaseEnvironment configuration for the workspace. Sets the specified base environments as the workspace defaults for CPU and/or GPU compute. Unsetting a default makes that compute type use the Databricks Standard base environment. The Standard base environment has no resource name, so unsetting the field is the only way to select it.

API scopes: environments

Parameters​

namestringRequiredIDImmutablepath

The resource name of this singleton resource. Format: default-workspace-base-environment

update_maskstringRequiredquery

Field mask specifying which fields to update. Use comma as the separator for multiple fields (no space). The special value '*' indicates that all fields should be updated (full replacement). Valid field paths: cpu_workspace_base_environment, gpu_workspace_base_environment

To unset one or both defaults, include the field path(s) in the mask and omit them from the request body. To unset both, you must list both paths explicitly — the wildcard '*' cannot be used to unset fields. Unsetting a default makes that compute type use the Databricks Standard base environment. The Standard base environment has no resource name, so unsetting the field is the only way to select it.

Request body​

Required. The default workspace base environment configuration to update.

cpu_workspace_base_environmentstring

The default workspace base environment for CPU compute. If unset, CPU compute defaults to the Databricks Standard base environment (Standard Latest). Format: workspace-base-environments/{workspace_base_environment}

gpu_workspace_base_environmentstring

The default workspace base environment for GPU compute. If unset, GPU compute defaults to the Databricks Standard base environment (Standard Latest). Format: workspace-base-environments/{workspace_base_environment}

Response​

Returns the DefaultWorkspaceBaseEnvironment object.