Workspace Network Option

View as Markdown

Get workspace network optionGET /api/2.0/accounts/{account_id}/workspaces/{workspace_id}/networkUpdate workspace network optionPUT /api/2.0/accounts/{account_id}/workspaces/{workspace_id}/network

WorkspaceNetworkOption object

network_policy_idstring

The network policy ID to apply to the workspace. This controls the network access rules for all serverless compute resources in the workspace. Each workspace can only be linked to one policy at a time. If no policy is explicitly assigned, the workspace will use 'default-policy'.

Example: my-network-policy

workspace_idint64

The workspace ID.

Example: 1234567890

View as Markdown

The WorkspaceNetworkOption object

{
  "network_policy_id": "my-network-policy",
  "workspace_id": 1234567890
}

Get workspace network option GA

GET /api/2.0/accounts/{account_id}/workspaces/{workspace_id}/network

Gets the network option for a workspace. Every workspace has exactly one network policy binding, with 'default-policy' used if no explicit assignment exists.

API scopes: networking

Parameters

account_idstringuuidRequiredpath

Your <Databricks> account ID. You can find your account ID in your <Databricks> accounts console.

Example: 123e4567-e89b-12d3-a456-426614174000

workspace_idint64Requiredpath

The workspace ID.

Example: 1234567890

Response

Returns the WorkspaceNetworkOption object.

View as Markdown

Response

{
  "network_policy_id": "my-network-policy",
  "workspace_id": 1234567890
}

Update workspace network option GA

PUT /api/2.0/accounts/{account_id}/workspaces/{workspace_id}/network

Updates the network option for a workspace. This operation associates the workspace with the specified network policy. To revert to the default policy, specify 'default-policy' as the network_policy_id.

API scopes: networking

Parameters

account_idstringuuidRequiredpath

Your <Databricks> account ID. You can find your account ID in your <Databricks> accounts console.

Example: 123e4567-e89b-12d3-a456-426614174000

workspace_idint64Requiredpath

The workspace ID.

Example: 1234567890

Request body

The network option details for the workspace.

network_policy_idstring

The network policy ID to apply to the workspace. This controls the network access rules for all serverless compute resources in the workspace. Each workspace can only be linked to one policy at a time. If no policy is explicitly assigned, the workspace will use 'default-policy'.

Example: my-network-policy

workspace_idint64

The workspace ID.

Example: 1234567890

Response

Returns the WorkspaceNetworkOption object.

View as Markdown

Request

{
  "network_policy_id": "my-network-policy",
  "workspace_id": 1234567890
}

Response

{
  "network_policy_id": "my-network-policy",
  "workspace_id": 1234567890
}