> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Databricks Workspace

> How to set up the Databricks Workspace connector, plus the actions and events that are available.

![Databricks Workspace](https://stackone-logos.com/api/databricks/filled/svg)

v1.3.0[See changelog](https://docs.stackone.com/connectors/databricksworkspace/changelog.md)

[51 actions](#actions) · [6 events](#events) · 1 auth method

Analytics

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [OAuth 2.0 (M2M - Machine to Machine) · Connector Profile](https://docs.stackone.com/connectors/databricksworkspace/guides/connector-profile/oauth-2-0-m2m-machine-to-machine.md)
>
> Use OAuth 2.0 with a Databricks service principal for machine-to-machine authentication against workspace APIs. Best for...

Optionally, configure receiving Events for Databricks Workspace into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/databricksworkspace/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [OAuth 2.0 (M2M - Machine to Machine) · Link Account](https://docs.stackone.com/connectors/databricksworkspace/guides/link-account/oauth-2-0-m2m-machine-to-machine.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Scopes

Select all
|
Clear

clusters

jobs

sql

unity-catalog

workspace

No scopes found

51 actions

ActionDescriptionRequired scopes

List Catalogs`databricksworkspace_list_catalogs`

List catalogs in the Unity Catalog metastore

`unity-catalog`

Get Catalog`databricksworkspace_get_catalog`

Get a Unity Catalog catalog by name

`unity-catalog`

Create Catalog`databricksworkspace_create_catalog`

Create a new Unity Catalog catalog

`unity-catalog`

Update Catalog`databricksworkspace_update_catalog`

Update a Unity Catalog catalog

`unity-catalog`

Delete Catalog`databricksworkspace_delete_catalog`

Delete a Unity Catalog catalog

`unity-catalog`

List Clusters`databricksworkspace_list_clusters`

List all pinned, active, and recently terminated clusters in the workspace

`clusters`

Get Cluster`databricksworkspace_get_cluster`

Retrieve the configuration and state of a specific cluster by ID

`clusters`

Create Cluster`databricksworkspace_create_cluster`

Create a new Databricks compute cluster with the supplied configuration

`clusters`

Edit Cluster`databricksworkspace_edit_cluster`

Update the configuration of an existing cluster to match the supplied attributes

`clusters`

Start Cluster`databricksworkspace_start_cluster`

Start a terminated Spark cluster using its existing configuration

`clusters`

Restart Cluster`databricksworkspace_restart_cluster`

Restart a Spark cluster that is currently running

`clusters`

Terminate Cluster`databricksworkspace_terminate_cluster`

Terminate a running cluster while preserving its configuration

`clusters`

Permanently Delete Cluster`databricksworkspace_permanent_delete_cluster`

Permanently delete a cluster, removing its configuration entirely

`clusters`

List Spark Versions`databricksworkspace_list_spark_versions`

List the Spark versions available for use when creating a new cluster

`clusters`

List Node Types`databricksworkspace_list_node_types`

List the supported node types available for cluster worker and driver nodes

`clusters`

List Jobs`databricksworkspace_list_jobs`

List all jobs in the workspace

`jobs`

Get Job`databricksworkspace_get_job`

Get details of a specific job

`jobs`

Create Job`databricksworkspace_create_job`

Create a new job in the workspace

`jobs`

Update Job`databricksworkspace_update_job`

Partially update a job's settings

`jobs`

Delete Job`databricksworkspace_delete_job`

Delete a job from the workspace

`jobs`

Run Job`databricksworkspace_run_job`

Trigger a job run immediately

`jobs`

List Job Runs`databricksworkspace_list_job_runs`

List runs for a specific job or all runs in the workspace

`jobs`

Get Job Run`databricksworkspace_get_job_run`

Get details of a specific job run

`jobs`

Cancel Job Run`databricksworkspace_cancel_job_run`

Cancel an active job run

`jobs`

Get Job Run Output`databricksworkspace_get_job_run_output`

Get the output of a completed job run task

`jobs`

List Schemas`databricksworkspace_list_schemas`

List schemas in a Unity Catalog catalog

`unity-catalog`

Get Schema`databricksworkspace_get_schema`

Get a Unity Catalog schema by full name

`unity-catalog`

Create Schema`databricksworkspace_create_schema`

Create a new Unity Catalog schema

`unity-catalog`

Update Schema`databricksworkspace_update_schema`

Update a Unity Catalog schema

`unity-catalog`

Delete Schema`databricksworkspace_delete_schema`

Delete a Unity Catalog schema

`unity-catalog`

Execute SQL Statement`databricksworkspace_execute_sql_statement`

Execute a SQL statement on a warehouse

`sql`

Get SQL Statement`databricksworkspace_get_sql_statement`

Get the status and results of a SQL statement execution

`sql`

Cancel SQL Statement`databricksworkspace_cancel_sql_statement`

Cancel a running SQL statement execution

`sql`

List SQL Warehouses`databricksworkspace_list_sql_warehouses`

List all SQL warehouses in the workspace

`sql`

Get SQL Warehouse`databricksworkspace_get_sql_warehouse`

Get details of a specific SQL warehouse

`sql`

Create SQL Warehouse`databricksworkspace_create_sql_warehouse`

Create a new SQL warehouse

`sql`

Edit SQL Warehouse`databricksworkspace_edit_sql_warehouse`

Update configuration of an existing SQL warehouse

`sql`

Start SQL Warehouse`databricksworkspace_start_sql_warehouse`

Start a stopped SQL warehouse

`sql`

Stop SQL Warehouse`databricksworkspace_stop_sql_warehouse`

Stop a running SQL warehouse

`sql`

Delete SQL Warehouse`databricksworkspace_delete_sql_warehouse`

Delete a SQL warehouse

`sql`

List Tables`databricksworkspace_list_tables`

List tables in a Unity Catalog schema

`unity-catalog`

List Table Summaries`databricksworkspace_list_table_summaries`

List lightweight table summaries across a catalog

`unity-catalog`

Get Table`databricksworkspace_get_table`

Get a Unity Catalog table by full name

`unity-catalog`

Check Table Exists`databricksworkspace_get_table_exists`

Check whether a Unity Catalog table exists

`unity-catalog`

Delete Table`databricksworkspace_delete_table`

Delete a Unity Catalog table

`unity-catalog`

List Workspace Objects`databricksworkspace_list_workspace_objects`

List objects in a workspace directory

`workspace`

Get Workspace Object Status`databricksworkspace_get_workspace_object_status`

Get metadata for a workspace object

`workspace`

Create Workspace Directory`databricksworkspace_create_workspace_directory`

Create a directory in the workspace

`workspace`

Import Workspace Object`databricksworkspace_import_workspace_object`

Import a notebook or file into the workspace

`workspace`

Export Workspace Object`databricksworkspace_export_workspace_object`

Export a notebook or file from the workspace

`workspace`

Delete Workspace Object`databricksworkspace_delete_workspace_object`

Delete a workspace object

`workspace`

## Events

Tags

Select all
|
Clear

Jobs

Notifications

Webhooks

No tags found

6 events

EventDescriptionTags

Notification Acknowledgement`databricksworkspace_webhook_ping`

Acknowledges deliveries without an event\_type, such as the destination's Test notification, without emitting an event.

NotificationsWebhooks

Job Start`databricksworkspace_webhook_jobs_on_start`

Fired when a run of a job (or task) that notifies the StackOne destination on start begins.

JobsWebhooks

Job Success`databricksworkspace_webhook_jobs_on_success`

Fired when a run of a job (or task) that notifies the StackOne destination on success completes successfully.

JobsWebhooks

Job Failure`databricksworkspace_webhook_jobs_on_failure`

Fired when a run of a job (or task) that notifies the StackOne destination on failure fails.

JobsWebhooks

Job Duration Warning`databricksworkspace_webhook_jobs_on_duration_warning_threshold_exceeded`

Fired when a run of a job (or task) that notifies the StackOne destination exceeds its expected-duration warning thresho...

JobsWebhooks

Other Job Notification`databricksworkspace_webhook_jobs_other`

Fired for any other job notification sent to the StackOne destination, such as streaming backlog or continuous-job maint...

JobsWebhooks


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.