Skip to main content
Databricks Workspace
Databricks Workspace
51 actions · 1 auth method
PreviewDataAutomationStorage

​
Authentication

OAuth 2.0 (M2M - Machine to Machine)

Use OAuth 2.0 with a Databricks service principal for machine-to-machine authentication against workspace APIs. Best for…Guides: Connector Profile, Link Account
Actions
|
51 actions
Action
Description
Required scopes
List Catalogs
List catalogs in the Unity Catalog metastore
Get Catalog
Get a Unity Catalog catalog by name
Create Catalog
Create a new Unity Catalog catalog
Update Catalog
Update a Unity Catalog catalog
Delete Catalog
Delete a Unity Catalog catalog
List Clusters
List all pinned, active, and recently terminated clusters in the workspace
Get Cluster
Retrieve the configuration and state of a specific cluster by ID
Create Cluster
Create a new Databricks compute cluster with the supplied configuration
Edit Cluster
Update the configuration of an existing cluster to match the supplied attributes
Start Cluster
Start a terminated Spark cluster using its existing configuration
Restart Cluster
Restart a Spark cluster that is currently running
Terminate Cluster
Terminate a running cluster while preserving its configuration
Permanently Delete Cluster
Permanently delete a cluster, removing its configuration entirely
List Spark Versions
List the Spark versions available for use when creating a new cluster
List Node Types
List the supported node types available for cluster worker and driver nodes
List Jobs
List all jobs in the workspace
Get Job
Get details of a specific job
Create Job
Create a new job in the workspace
Update Job
Partially update a job’s settings
Delete Job
Delete a job from the workspace
Run Job
Trigger a job run immediately
List Job Runs
List runs for a specific job or all runs in the workspace
Get Job Run
Get details of a specific job run
Cancel Job Run
Cancel an active job run
Get Job Run Output
Get the output of a completed job run task
List Schemas
List schemas in a Unity Catalog catalog
Get Schema
Get a Unity Catalog schema by full name
Create Schema
Create a new Unity Catalog schema
Update Schema
Update a Unity Catalog schema
Delete Schema
Delete a Unity Catalog schema
Execute SQL Statement
Execute a SQL statement on a warehouse
Get SQL Statement
Get the status and results of a SQL statement execution
Cancel SQL Statement
Cancel a running SQL statement execution
List SQL Warehouses
List all SQL warehouses in the workspace
Get SQL Warehouse
Get details of a specific SQL warehouse
Create SQL Warehouse
Create a new SQL warehouse
Edit SQL Warehouse
Update configuration of an existing SQL warehouse
Start SQL Warehouse
Start a stopped SQL warehouse
Stop SQL Warehouse
Stop a running SQL warehouse
Delete SQL Warehouse
Delete a SQL warehouse
List Tables
List tables in a Unity Catalog schema
List Table Summaries
List lightweight table summaries across a catalog
Get Table
Get a Unity Catalog table by full name
Check Table Exists
Check whether a Unity Catalog table exists
Delete Table
Delete a Unity Catalog table
List Workspace Objects
List objects in a workspace directory
Get Workspace Object Status
Get metadata for a workspace object
Create Workspace Directory
Create a directory in the workspace
Import Workspace Object
Import a notebook or file into the workspace
Export Workspace Object
Export a notebook or file from the workspace
Delete Workspace Object
Delete a workspace object

​
Getting Started

1

Create or Select a Project

Set up a new project or select an existing one. See the Projects Guide.
2

Configure the Connector

Enable the connector and set up a connector profile in your project. See Managing Connectors.
https://stackone-logos.com/api/databricks/filled/png

Connector Profile

Databricks Workspace - OAuth 2.0 (M2M - Machine to Machine)
3

Link an Account

Connect an account using StackOne Hub or Auth Link.
https://stackone-logos.com/api/databricks/filled/png

Link Account

Databricks Workspace - OAuth 2.0 (M2M - Machine to Machine)
4

Use Actions

Invoke actions using one of the methods below: