Use the Databricks (REST APIs) connector to process and analyze big data workloads.
Integrating your application with Databricks (REST APIs) lets you use these operations in an automation. It exposes 36 actions, listed below. Add the connector from the Connections area, authenticate, then select its operations in the automation builder. Capabilities: actions.
Authentication
Before you begin, make sure you have the following information:
Connection Name: Choose a meaningful name for your connection. This name helps you identify the connection within your application or integration settings.
Authentication type: Databricks (REST APIs) supports two authentication types:
Credentials: Enter the Client ID and Client secret of your Databricks application.
API Token: Enter a Databricks personal access token in the API Token field. The steps below show how to create one.
Databricks instance: Your workspace hostname without https://. For example, if your workspace URL is https://adb-<workspace-id>.azuredatabricks.net, enter adb-<workspace-id>.azuredatabricks.net.
Request timeout duration: The timeout for each request, in seconds. The default is 1200.
Obtaining Your Personal Access Token
Log in to your Databricks workspace.
Click your username in the top bar and select Settings.
Click Developer in the left-hand menu.
Next to Access tokens, click Manage.
Click Generate new token.
Enter a name for the token, set its lifetime in days, and click Generate.
Copy the generated token and store it securely — Databricks will not show it again.
Actions
Action Name | Description |
|---|---|
Cancel Job Run | Cancels a job run asynchronously in Databricks |
Cancel SQL Statement | Cancels a running SQL statement in Databricks |
Chat Completions | Creates chat completions with Databricks |
Create Genie Message | Sends a follow-up question to an existing Genie conversation in Databricks |
Execute Genie Attachment Query | Re-executes the SQL query of an expired Genie message attachment in Databricks |
Execute SQL Statement | Executes a SQL statement on a SQL warehouse in Databricks |
Foundation model (Generic) | Generates foundation model outputs from Databricks |
Generate embeddings | Generates embeddings from Databricks |
Get Genie Attachment Query Result | Gets the SQL result of a Genie message attachment query in Databricks |
Get Genie Message | Gets a single message of a Genie conversation in Databricks |
Get Genie query result | Gets the SQL query result (columns + rows) for a Genie message's query attachment in Databricks |
Get Job | Retrieves the settings and metadata of a single job in Databricks |
Get Job Run | Retrieves the metadata and task detail of a single job run in Databricks |
Get Job Run Output | Retrieves the output and error detail of a single task run in Databricks |
Get SQL Statement | Gets the status and result of a SQL statement in Databricks |
Get SQL Statement Result Chunk | Gets a single result chunk of a SQL statement in Databricks |
Get SQL Warehouse | Retrieves the configuration, state and connection details of a SQL warehouse by ID in Databricks |
Get trace | Gets a single MLflow trace by its ID in Databricks |
Get Unity Catalog Table | Retrieves a Unity Catalog table by its full three-level name in Databricks |
List genie conversation items | Lists the ordered items (user/assistant messages, reasoning, SQL function calls and their outputs) of a genie agent-mode conversation in Databricks |
List genie conversation messages | Lists messages (Q&A turns) in a genie conversation in Databricks |
List genie conversations | Lists conversations (sessions) in a genie space in Databricks |
List genie spaces (agents) | Lists AI/BI genie spaces (genie agents) the caller can access in Databricks |
List Job Runs | Lists job runs in descending order by end time, falling back to start time for runs that have not finished, in Databricks |
List Jobs | Lists the jobs in a workspace in Databricks |
List serving endpoints | Lists model serving endpoints in Databricks |
List SQL Warehouses | Lists SQL warehouses with their size, state and connection details in Databricks |
List Unity Catalog Catalogs | Lists Unity Catalog catalogs without requiring a running SQL warehouse in Databricks |
List Unity Catalog Schemas | Lists Unity Catalog schemas in a catalog in Databricks |
List Unity Catalog Tables | Lists Unity Catalog tables in a schema in Databricks |
Run Job Now | Triggers a new run of an existing job in Databricks |
Search traces | Searches MLflow traces for a serving endpoint's experiment in Databricks |
Start Genie Conversation | Starts a new Genie conversation by asking a question in Databricks |
Start SQL Warehouse | Starts a stopped SQL warehouse in Databricks |
Stop SQL Warehouse | Stops a running SQL warehouse in Databricks |
Stream Generate Content (Generic) | Stream generate content from Databricks |