You can wire the Databricks node into an AI agent as a tool provider: the agent calls the operations you allow. See Agent tools.
Credentials
Connect Databricks under Credentials in the node settings. See Connecting credentials for the general flow. Enter the values manually when creating the credential. Generate a personal access token under User Settings -> Developer -> Access tokens in your Databricks workspace, then paste your workspace URL and the token here. Get your credentials here.Operations
Access control
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Create IP Access List | create_ip_access_list | Create an IP access list. | |
| Create On-Behalf-Of Token | create_obo_token | Create an on-behalf-of token for a service principal. | |
| Create Permission Assignment | create_permission_assignment | Create or update a workspace permission assignment for a principal. | |
| Create Token | create_token | Create a personal access token. | |
| Delete IP Access List | delete_ip_access_list | Delete an IP access list by ID. | |
| Delete Managed Token | delete_token_management | Delete a managed token by ID (admin token management). | |
| Delete Permission Assignment | delete_permission_assignment | Delete a workspace permission assignment for a principal. | |
| Delete Token | delete_token | Revoke a personal access token. | |
| Get IP Access List | get_ip_access_list | Get a single IP access list by ID. | |
| Get Managed Token | get_token_management | Get details of a managed token by ID. | |
| Get Object Permissions | get_object_permissions | Get the permissions set on an object. | |
| Get Permission Levels | get_permission_levels | Get the permission levels a user can have on an object. | |
| Get Workspace Configuration | get_workspace_conf | Get workspace configuration values for the given keys. | |
| List IP Access Lists | list_ip_access_lists | List all IP access lists for the workspace. | |
| List Managed Tokens | list_token_management | List all tokens in the workspace (admin token management). | |
| List Permission Assignments | list_permission_assignments | List workspace permission assignments for all principals. | |
| List Tokens | list_tokens | List personal access tokens for the calling user. | |
| Set Object Permissions | set_object_permissions | Set (overwrite) the permissions on an object. | |
| Set Workspace Configuration | set_workspace_conf | Set (patch) workspace configuration values. | |
| Update IP Access List | update_ip_access_list | Replace (update) an existing IP access list. | |
| Update Object Permissions | update_object_permissions | Update (merge) the permissions on an object. |
Alerts
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Create Alert | create_alert | Create an alert. | |
| Create Query Visualization | create_query_visualization | Create a query visualization. | |
| Delete Alert | delete_alert | Delete an alert. | |
| Delete Query Visualization | delete_query_visualization | Delete a query visualization. | |
| Get Alert | get_alert | Get an alert. | |
| List Alerts | list_alerts | List alerts. | |
| Update Alert | update_alert | Update an alert. | |
| Update Query Visualization | update_query_visualization | Update a query visualization. |
Apps
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Create App | create_app | Create a new Databricks App. | |
| Delete App | delete_app | Delete a Databricks App by name. | |
| Deploy App | deploy_app | Create a new deployment for a Databricks App. | |
| Get App | get_app | Get details of a Databricks App by name. | |
| Get App Deployment | get_app_deployment | Get a specific deployment of a Databricks App. | |
| List App Deployments | list_app_deployments | List deployments for a Databricks App. | |
| List Apps | list_apps | List all Databricks Apps in the workspace. | |
| Start App | start_app | Start a Databricks App. | |
| Stop App | stop_app | Stop a Databricks App. | |
| Update App | update_app | Update a Databricks App. |
Cluster policies
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Create Cluster Policy | create_cluster_policy | Create a new cluster policy from a policy definition. | |
| Delete Cluster Policy | delete_cluster_policy | Delete a cluster policy by its ID. | |
| Edit Cluster Policy | edit_cluster_policy | Update an existing cluster policy’s name and definition. | |
| Enforce Cluster Compliance | enforce_cluster_policy_compliance | Update a cluster to bring it into compliance with its assigned policy. | |
| Get Cluster Compliance | get_cluster_policy_compliance | Get the compliance status of a single cluster against its policy. | |
| Get Cluster Policy | get_cluster_policy | Get a single cluster policy by its ID. | |
| Get Policy Family | get_policy_family | Get a single cluster policy family by its ID. | |
| List Cluster Policies | list_cluster_policies | List all cluster policies in the workspace. | |
| List Policy Compliance | list_cluster_policy_compliance | List the compliance status of all clusters governed by a policy. | |
| List Policy Families | list_policy_families | List all available cluster policy families. |
Clusters
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Change Cluster Owner | change_cluster_owner | Change the owner of a cluster. | |
| Create Cluster | create_cluster | Create and start a new compute cluster. | |
| Edit Cluster | edit_cluster | Update the configuration of an existing all-purpose cluster. | |
| Get Cluster | get_cluster | Get info/state for one cluster. | |
| Get Cluster Events | get_cluster_events | Retrieve the event log for a cluster. | |
| List Availability Zones | list_availability_zones | List the availability zones where clusters can be created. | |
| List Clusters | list_clusters | List all clusters in the workspace. | |
| List Node Types | list_node_types | List supported Spark node (instance) types. | |
| List Spark Versions | list_spark_versions | List the Spark/Databricks Runtime versions available for clusters. | |
| Permanently Delete Cluster | permanent_delete_cluster | Permanently delete a cluster, removing it from the cluster list. | |
| Pin Cluster | pin_cluster | Pin a cluster so it stays in the cluster list after termination. | |
| Resize Cluster | resize_cluster | Resize a cluster to a target number of workers or autoscale range. | |
| Restart Cluster | restart_cluster | Restart a running cluster. | |
| Start Cluster | start_cluster | Start a terminated cluster. | |
| Terminate Cluster | terminate_cluster | Terminate (stop) a cluster. | |
| Unpin Cluster | unpin_cluster | Unpin a cluster so it can be removed from the list after termination. | |
| Update Cluster | update_cluster | Partially update a cluster’s configuration using a field mask. |
Command execution
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Cancel Command | cancel_command | Cancel a running command in an execution context. | |
| Create Execution Context | create_execution_context | Create an execution context on a cluster for running commands. | |
| Destroy Execution Context | destroy_execution_context | Destroy an existing execution context on a cluster. | |
| Execute Command | execute_command | Run a command within an execution context on a cluster. | |
| Get Command Status | get_command_status | Get the status and result of a command execution. | |
| Get Execution Context Status | get_execution_context_status | Get the status of an existing execution context. |
Dashboards
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Create Lakeview Dashboard | create_lakeview_dashboard | Create a new Lakeview (AI/BI) dashboard. | |
| Create Lakeview Schedule | create_lakeview_schedule | Create a schedule for a Lakeview (AI/BI) dashboard. | |
| Delete Lakeview Schedule | delete_lakeview_schedule | Delete a schedule for a Lakeview (AI/BI) dashboard. | |
| Get Lakeview Dashboard | get_lakeview_dashboard | Get a Lakeview (AI/BI) dashboard by ID. | |
| Get Lakeview Schedule | get_lakeview_schedule | Get a schedule for a Lakeview (AI/BI) dashboard. | |
| Get Published Lakeview Dashboard | get_published_lakeview_dashboard | Get the published version of a Lakeview (AI/BI) dashboard. | |
| List Lakeview Dashboards | list_lakeview_dashboards | List Lakeview (AI/BI) dashboards in the workspace. | |
| List Lakeview Schedules | list_lakeview_schedules | List schedules for a Lakeview (AI/BI) dashboard. | |
| Publish Lakeview Dashboard | publish_lakeview_dashboard | Publish the current draft of a Lakeview (AI/BI) dashboard. | |
| Trash Lakeview Dashboard | trash_lakeview_dashboard | Move a Lakeview (AI/BI) dashboard to the trash. | |
| Unpublish Lakeview Dashboard | unpublish_lakeview_dashboard | Unpublish a Lakeview (AI/BI) dashboard. | |
| Update Lakeview Dashboard | update_lakeview_dashboard | Update a Lakeview (AI/BI) dashboard. | |
| Update Lakeview Schedule | update_lakeview_schedule | Update a schedule for a Lakeview (AI/BI) dashboard. |
Feature store
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Create Feature | create_feature | Create a new feature. | |
| Create Online Store | create_online_store | Create a new online store. | |
| Delete Feature | delete_feature | Delete a feature by its full name. | |
| Delete Online Store | delete_online_store | Delete an online store by name. | |
| Get Feature | get_feature | Get a feature by its full name. | |
| Get Online Store | get_online_store | Get an online store by name. | |
| List Features | list_features | List all features in the feature engineering registry. | |
| List Online Stores | list_online_stores | List all online stores in the workspace. | |
| Update Feature | update_feature | Update an existing feature. | |
| Update Online Store | update_online_store | Update an existing online store. |
Files
| Operation | ID | Description | Trigger |
|---|---|---|---|
| DBFS: Add Block | dbfs_add_block | Append a block of base64-encoded data to an open DBFS upload stream. | |
| DBFS: Close Upload Handle | dbfs_close | Close an open DBFS upload stream, committing the written blocks. | |
| DBFS: Create Upload Handle | dbfs_create | Open a stream to write a file to DBFS, returning an upload handle. | |
| DBFS: Delete | dbfs_delete | Delete a file or directory from DBFS. | |
| DBFS: Get Status | dbfs_get_status | Get the file information (status) of a DBFS file or directory. | |
| DBFS: List Directory | dbfs_list | List the contents of a DBFS directory. | |
| DBFS: Make Directories | dbfs_mkdirs | Create the given directory (and necessary parents) in DBFS. | |
| DBFS: Move | dbfs_move | Move a file or directory from one DBFS location to another. | |
| DBFS: Put File | dbfs_put | Upload a small file (<= 1 MB) to DBFS in a single request. | |
| DBFS: Read File | dbfs_read | Read the contents of a DBFS file, returned base64-encoded. | |
| Files: Create Directory | create_directory | Create a directory (and necessary parents) in a Unity Catalog volume. | |
| Files: Delete Directory | delete_directory | Delete an (empty) directory from a Unity Catalog volume. | |
| Files: Delete File | delete_file | Delete a file from a Unity Catalog volume via the Files API. | |
| Files: Download File | download_file | Download a file from a Unity Catalog volume via the Files API. | |
| Files: Get File Metadata | get_file_metadata | Get metadata (existence, size, content type) of a Files API file. | |
| Files: List Directory Contents | list_directory_contents | List the contents of a directory in a Unity Catalog volume. | |
| Files: Upload File | upload_file | Upload a file to a Unity Catalog volume via the Files API (raw content). |
Genie
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Create Genie Message | create_genie_message | Add a follow-up message to an existing Genie conversation. | |
| Execute Genie Message Query | execute_genie_message_query | Execute the SQL query generated for a Genie message. | |
| Get Genie Message | get_genie_message | Get a message (and its status/attachments) from a Genie conversation. | |
| Get Genie Message Attachment Query Result | get_genie_message_attachment_query_result | Get the query result for a specific attachment on a Genie message. | |
| Get Genie Message Query Result | get_genie_message_query_result | Get the SQL query result for a Genie message. | |
| Get Genie Space | get_genie_space | Get metadata for a single Genie space. | |
| List Genie Conversations | list_genie_conversations | List conversations in a Genie space. | |
| List Genie Spaces | list_genie_spaces | List Genie spaces the caller can access. | |
| Start Genie Conversation | start_genie_conversation | Start a new Genie conversation with an initial message. |
Identity
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Create Group | create_group | Create a new group via SCIM. | |
| Create Service Principal | create_service_principal | Create a new service principal via SCIM. | |
| Create User | create_user | Create a new user via SCIM. | |
| Delete Group | delete_group | Delete a group by SCIM id. | |
| Delete Service Principal | delete_service_principal | Delete a service principal by SCIM id. | |
| Delete User | delete_user | Delete a user by SCIM id. | |
| Get Current User | get_current_user | Get the SCIM details of the currently authenticated user. | |
| Get Group | get_group | Get a group by SCIM id. | |
| Get Service Principal | get_service_principal | Get a service principal by SCIM id. | |
| Get User | get_user | Get a user by SCIM id. | |
| List Groups | list_groups | List groups in the workspace via SCIM. | |
| List Service Principals | list_service_principals | List service principals in the workspace via SCIM. | |
| List Users | list_users | List users in the workspace via SCIM. | |
| Patch Group | patch_group | Partially update a group via SCIM PatchOp. | |
| Patch Service Principal | patch_service_principal | Partially update a service principal via SCIM PatchOp. | |
| Patch User | patch_user | Partially update a user via SCIM PatchOp. | |
| Update Group | update_group | Replace a group via SCIM (PUT). | |
| Update Service Principal | update_service_principal | Replace a service principal via SCIM (PUT). | |
| Update User | update_user | Replace a user via SCIM (PUT). |
Instance pools
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Add Instance Profile | add_instance_profile | Register an instance profile so it can be used to launch clusters. | |
| Create Instance Pool | create_instance_pool | Create a new instance pool. | |
| Delete Instance Pool | delete_instance_pool | Delete an instance pool, terminating its idle instances asynchronously. | |
| Edit Instance Pool | edit_instance_pool | Edit an existing instance pool. All required fields must be supplied. | |
| Edit Instance Profile | edit_instance_profile | Edit the IAM role association of a registered instance profile. | |
| Get Instance Pool | get_instance_pool | Retrieve the configuration of a single instance pool. | |
| List Instance Pools | list_instance_pools | List all instance pools in the workspace. | |
| List Instance Profiles | list_instance_profiles | List the instance profiles that the calling user can use to launch clusters. | |
| Remove Instance Profile | remove_instance_profile | Remove a registered instance profile from the workspace. |
Jobs
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Cancel All Runs | cancel_all_runs | Cancel all active runs of a job. | |
| Cancel Job Run | cancel_run | Cancel an active run. | |
| Create Job | create_job | Create a new job from a JSON definition. | |
| Delete Job | delete_job | Delete a job. | |
| Delete Run | delete_run | Delete a non-active run. Returns an error if the run is active. | |
| Enforce Job Compliance | enforce_job_compliance | Update a job so its cluster requirements conform to the current policy. | |
| Export Run | export_run | Export and retrieve the job run task rendered notebook output. | |
| Get Job | get_job | Get a single job’s definition. | |
| Get Job Compliance | get_job_compliance | Get the compliance status of a job, including whether it is in violation of its policy. | |
| Get Job Run | get_run | Get details/state of a single run. | |
| Get Run Output | get_run_output | Retrieve the output of a completed task run. | |
| List Job Compliance | list_job_compliance | List the compliance status of all jobs using a given policy. | |
| List Job Runs | list_runs | List job runs, filterable by job. | |
| List Jobs | list_jobs | List jobs in the workspace. | |
| Repair Run | repair_run | Re-run one or more tasks of a failed job run. | |
| Reset Job | reset_job | Overwrite all settings for a given job with the provided settings. | |
| Run Job Now | run_now | Trigger an immediate run of an existing job. | |
| Submit One-Time Run | submit_run | Submit a one-time run without creating a persistent job. | |
| Update Job | update_job | Add, update, or remove specific settings of an existing job. |
Libraries
| Operation | ID | Description | Trigger |
|---|---|---|---|
| All Cluster Library Statuses | all_cluster_library_statuses | Get the status of all libraries on all clusters. | |
| Cluster Library Status | cluster_library_status | Get the status of libraries on a single cluster. | |
| Create Global Init Script | create_global_init_script | Create a new global init script. | |
| Delete Global Init Script | delete_global_init_script | Delete a global init script. | |
| Get Global Init Script | get_global_init_script | Get the details and content of a global init script. | |
| Install Libraries | install_libraries | Install libraries on a cluster. | |
| List Global Init Scripts | list_global_init_scripts | List all global init scripts in the workspace. | |
| Uninstall Libraries | uninstall_libraries | Uninstall libraries from a cluster. | |
| Update Global Init Script | update_global_init_script | Update an existing global init script. |
MLflow experiments
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Create Experiment | mlflow_create_experiment | Create a new MLflow experiment. | |
| Create Run | mlflow_create_run | Create a new MLflow run within an experiment. | |
| Delete Experiment | mlflow_delete_experiment | Mark an MLflow experiment as deleted. | |
| Delete Run | mlflow_delete_run | Mark an MLflow run as deleted. | |
| Delete Run Tag | mlflow_delete_run_tag | Delete a tag from an MLflow run. | |
| Get Experiment | mlflow_get_experiment | Get metadata for an MLflow experiment by ID. | |
| Get Experiment By Name | mlflow_get_experiment_by_name | Get metadata for an MLflow experiment by name. | |
| Get Metric History | mlflow_get_metric_history | Get the full logged history of a metric for an MLflow run. | |
| Get Run | mlflow_get_run | Get metadata, metrics, params and tags for an MLflow run. | |
| List Artifacts | mlflow_list_artifacts | List artifacts stored for an MLflow run. | |
| Log Batch | mlflow_log_batch | Log a batch of metrics, params and tags to an MLflow run in one call. | |
| Log Metric | mlflow_log_metric | Log a metric value for an MLflow run. | |
| Log Param | mlflow_log_param | Log a parameter (hyperparameter) for an MLflow run. | |
| Restore Experiment | mlflow_restore_experiment | Restore a deleted MLflow experiment. | |
| Restore Run | mlflow_restore_run | Restore a deleted MLflow run. | |
| Search Experiments | mlflow_search_experiments | Search for MLflow experiments matching filter criteria. | |
| Search Runs | mlflow_search_runs | Search for MLflow runs across one or more experiments. | |
| Set Experiment Tag | mlflow_set_experiment_tag | Set a tag on an MLflow experiment. | |
| Set Run Tag | mlflow_set_run_tag | Set a tag on an MLflow run. | |
| Update Experiment | mlflow_update_experiment | Update an MLflow experiment’s name. | |
| Update Run | mlflow_update_run | Update the status, end time or name of an MLflow run. |
MLflow model registry
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Create Model Version | mlflow_create_model_version | Create a new version of a registered model. | |
| Create Registered Model | mlflow_create_registered_model | Create a new registered model in the MLflow Model Registry. | |
| Create Registry Webhook | mlflow_create_registry_webhook | Create a Model Registry webhook that fires on registry events. | |
| Delete Model Version | mlflow_delete_model_version | Delete a specific model version. | |
| Delete Model Version Tag | mlflow_delete_model_version_tag | Delete a tag from a model version. | |
| Delete Registered Model | mlflow_delete_registered_model | Delete a registered model. | |
| Delete Registered Model Tag | mlflow_delete_registered_model_tag | Delete a tag from a registered model. | |
| Delete Registry Webhook | mlflow_delete_registry_webhook | Delete a Model Registry webhook. | |
| Get Latest Model Versions | mlflow_get_latest_model_versions | Get the latest model versions for a registered model, optionally filtered by stages. | |
| Get Model Version | mlflow_get_model_version | Get the details of a specific model version. | |
| Get Model Version Download URI | mlflow_get_model_version_download_uri | Get the download URI for a model version’s artifacts. | |
| Get Registered Model | mlflow_get_registered_model | Get the details of a registered model. | |
| List Registry Webhooks | mlflow_list_registry_webhooks | List Model Registry webhooks, optionally filtered by model or events. | |
| Rename Registered Model | mlflow_rename_registered_model | Rename a registered model. | |
| Search Model Versions | mlflow_search_model_versions | Search for model versions matching a filter. | |
| Search Registered Models | mlflow_search_registered_models | Search for registered models matching a filter. | |
| Set Model Version Tag | mlflow_set_model_version_tag | Set a tag on a model version. | |
| Set Registered Model Alias | mlflow_set_registered_model_alias | Set an alias pointing to a specific version of a registered model. | |
| Set Registered Model Tag | mlflow_set_registered_model_tag | Set a tag on a registered model. | |
| Test Registry Webhook | mlflow_test_registry_webhook | Send a test event to a Model Registry webhook. | |
| Transition Model Version Stage | mlflow_transition_model_version_stage | Transition a model version to a new stage. | |
| Update Model Version | mlflow_update_model_version | Update the description of a model version. | |
| Update Registered Model | mlflow_update_registered_model | Update the description of a registered model. | |
| Update Registry Webhook | mlflow_update_registry_webhook | Update an existing Model Registry webhook. |
Pipelines
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Create Pipeline | create_pipeline | Create a new Delta Live Tables pipeline. | |
| Delete Pipeline | delete_pipeline | Delete a pipeline. | |
| Get Pipeline | get_pipeline | Get a single pipeline’s definition and status. | |
| Get Pipeline Update | get_pipeline_update | Get the status of a specific pipeline update. | |
| List Pipeline Events | list_pipeline_events | List event log entries for a pipeline. | |
| List Pipeline Updates | list_pipeline_updates | List updates (runs) for a pipeline. | |
| List Pipelines | list_pipelines | List Delta Live Tables pipelines in the workspace. | |
| Start Pipeline Update | start_pipeline_update | Trigger a new update (run) of a pipeline. | |
| Stop Pipeline | stop_pipeline | Stop the pipeline’s active update if one is running. | |
| Update Pipeline | update_pipeline | Update (replace) an existing pipeline’s settings. |
Secrets
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Create Secret Scope | create_secret_scope | Create a Databricks-backed or Azure Key Vault-backed secret scope. | |
| Delete Secret | delete_secret | Delete a secret from a scope. | |
| Delete Secret ACL | delete_secret_acl | Delete an ACL on a secret scope for a principal. | |
| Delete Secret Scope | delete_secret_scope | Delete a secret scope. | |
| Get Secret | get_secret | Get the bytes value of a secret. | |
| Get Secret ACL | get_secret_acl | Get the ACL applied to a principal for a secret scope. | |
| List Secret ACLs | list_secret_acls | List all ACLs applied to a secret scope. | |
| List Secret Scopes | list_secret_scopes | List secret scopes. | |
| List Secrets | list_secrets | List secret metadata (keys and timestamps) for a scope. | |
| Put Secret | put_secret | Insert or update a secret in a scope. | |
| Put Secret ACL | put_secret_acl | Create or overwrite an ACL on a secret scope for a principal. |
Serving endpoints
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Create Serving Endpoint | create_serving_endpoint | Create a new model serving endpoint. | |
| Delete Serving Endpoint | delete_serving_endpoint | Delete a serving endpoint by name. | |
| Get Serving Endpoint | get_serving_endpoint | Get details of a serving endpoint by name. | |
| Get Serving Endpoint Metrics | get_serving_endpoint_metrics | Get the metrics of a serving endpoint (Prometheus/OpenMetrics format). | |
| Get Serving Endpoint OpenAPI | get_serving_endpoint_openapi | Get the OpenAPI schema of a serving endpoint. | |
| List Serving Endpoints | list_serving_endpoints | List all serving endpoints in the workspace. | |
| Patch Serving Endpoint Tags | patch_serving_endpoint_tags | Add or remove tags on a serving endpoint. | |
| Put Serving Endpoint Rate Limits | put_serving_endpoint_rate_limits | Set (replace) the rate limits on a serving endpoint. | |
| Query Serving Endpoint | query_serving_endpoint | Query (invoke) a serving endpoint with a request payload. | |
| Update Serving Endpoint Config | update_serving_endpoint_config | Update the config (served entities and traffic) of a serving endpoint. |
SQL
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Cancel SQL Statement | cancel_statement | Cancel an in-progress SQL statement execution. | |
| Get SQL Statement | get_statement | Poll status and fetch results for a SQL statement. | |
| Run SQL Statement | run_statement | Execute a SQL statement on a SQL warehouse. |
SQL queries
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Create Query | create_query | Create a new SQL query. | |
| Delete Query | delete_query | Move a SQL query to the trash. | |
| Get Query | get_query | Get a SQL query by ID. | |
| List Data Sources | list_data_sources | List the SQL warehouses available as query data sources. | |
| List Queries | list_queries | List all SQL queries in the workspace. | |
| List Query History | list_query_history | List the history of SQL query executions. | |
| List Query Visualizations | list_query_visualizations | List visualizations on a SQL query. | |
| Update Query | update_query | Update an existing SQL query. |
SQL warehouses
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Create Warehouse | create_warehouse | Create a new SQL warehouse. | |
| Delete Warehouse | delete_warehouse | Delete a SQL warehouse. | |
| Edit Warehouse | edit_warehouse | Update the configuration of an existing SQL warehouse. | |
| Get SQL Warehouse | get_warehouse | Get info/state for a single SQL warehouse. | |
| Get Warehouse Workspace Config | get_warehouse_workspace_config | Get the workspace-level configuration that applies to all SQL warehouses. | |
| List SQL Warehouses | list_warehouses | List all SQL warehouses in the workspace. | |
| Set Warehouse Workspace Config | set_warehouse_workspace_config | Set the workspace-level configuration that applies to all SQL warehouses. | |
| Start SQL Warehouse | start_warehouse | Start (resume) a stopped SQL warehouse. | |
| Stop SQL Warehouse | stop_warehouse | Stop a running SQL warehouse. |
Triggers
| Operation | ID | Description | Trigger |
|---|---|---|---|
| On Any Job Event | on_any_job_event | Fires on any Databricks job webhook notification event. | Yes |
| On Job Duration Threshold Exceeded | on_job_duration_warning | Fires when a Databricks job run exceeds its configured duration warning threshold. | Yes |
| On Job Run Failed | on_job_failure | Fires when a Databricks job run ends in an unsuccessful state. | Yes |
| On Job Run Started | on_job_start | Fires when a Databricks job run starts. | Yes |
| On Job Run Succeeded | on_job_success | Fires when a Databricks job run completes successfully. | Yes |
Unity catalog
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Check Table Exists | check_table_exists | Check whether a table exists in Unity Catalog. | |
| Create Catalog | create_catalog | Create a new catalog in Unity Catalog. | |
| Create Connection | create_connection | Create a new Unity Catalog connection to an external data system. | |
| Create External Location | create_external_location | Create a new external location in Unity Catalog. | |
| Create Function | create_function | Create a new function in Unity Catalog. | |
| Create Metastore | create_metastore | Create a new Unity Catalog metastore. | |
| Create Schema | create_schema | Create a new schema in a Unity Catalog catalog. | |
| Create Storage Credential | create_storage_credential | Create a new storage credential in Unity Catalog. | |
| Create Volume | create_volume | Create a new volume in Unity Catalog. | |
| Delete Catalog | delete_catalog | Delete a catalog from Unity Catalog. | |
| Delete Connection | delete_connection | Delete a Unity Catalog connection by name. | |
| Delete External Location | delete_external_location | Delete an external location. | |
| Delete Function | delete_function | Delete a function from Unity Catalog. | |
| Delete Metastore | delete_metastore | Delete a Unity Catalog metastore by ID. | |
| Delete Schema | delete_schema | Delete a schema from Unity Catalog. | |
| Delete Storage Credential | delete_storage_credential | Delete a storage credential. | |
| Delete Table | delete_table | Delete a table from Unity Catalog. | |
| Delete Volume | delete_volume | Delete a volume from Unity Catalog. | |
| Get Catalog | get_catalog | Get a catalog by name from Unity Catalog. | |
| Get Connection | get_connection | Get a Unity Catalog connection by name. | |
| Get Current Metastore Assignment | get_current_metastore_assignment | Get the metastore assignment for the current workspace. | |
| Get External Location | get_external_location | Get an external location by name. | |
| Get Function | get_function | Get a function from Unity Catalog by its full name. | |
| Get Metastore | get_metastore | Get a Unity Catalog metastore by ID. | |
| Get Metastore Summary | get_metastore_summary | Get summary information about the metastore assigned to the current workspace. | |
| Get Schema | get_schema | Get a schema by full name from Unity Catalog. | |
| Get Storage Credential | get_storage_credential | Get a storage credential by name. | |
| Get Table | get_table | Get a table’s metadata/columns by full name. | |
| Get Volume | get_volume | Get metadata for a volume in Unity Catalog. | |
| List Catalogs | list_catalogs | List Unity Catalog catalogs. | |
| List Connections | list_connections | List all Unity Catalog connections in the metastore. | |
| List External Locations | list_external_locations | List external locations in the Unity Catalog metastore. | |
| List Functions | list_functions | List functions within a Unity Catalog schema. | |
| List Metastores | list_metastores | List all Unity Catalog metastores the caller has access to. | |
| List Schemas | list_schemas | List schemas in a catalog. | |
| List Storage Credentials | list_storage_credentials | List storage credentials in the Unity Catalog metastore. | |
| List Table Summaries | list_table_summaries | List table summaries for a catalog in Unity Catalog. | |
| List Tables | list_tables | List tables in a schema. | |
| List Volumes | list_volumes | List volumes within a schema in Unity Catalog. | |
| Update Catalog | update_catalog | Update an existing Unity Catalog catalog. | |
| Update Connection | update_connection | Update an existing Unity Catalog connection. | |
| Update External Location | update_external_location | Update an existing external location. | |
| Update Function | update_function | Update the owner of a Unity Catalog function. | |
| Update Metastore | update_metastore | Update an existing Unity Catalog metastore. | |
| Update Schema | update_schema | Update an existing Unity Catalog schema. | |
| Update Storage Credential | update_storage_credential | Update an existing storage credential. | |
| Update Volume | update_volume | Update a volume’s name, comment, or owner in Unity Catalog. | |
| Validate Storage Credential | validate_storage_credential | Validate a storage credential against a location or self-hosted URL. |
Unity catalog grants
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Create Table Constraint | create_table_constraint | Create a primary-key, foreign-key, or check constraint on a table. | |
| Delete Table Constraint | delete_table_constraint | Delete a named constraint from a table. | |
| Disable System Schema | disable_system_schema | Disable a system schema for a metastore. | |
| Enable System Schema | enable_system_schema | Enable a system schema for a metastore. | |
| Get Artifact Allowlist | get_artifact_allowlist | Get the artifact allowlist of a certain artifact type in the metastore. | |
| Get Effective Grants | get_effective_grants | Get effective (inherited) permissions on a securable in Unity Catalog. | |
| Get Grants | get_grants | Get permissions on a securable object in Unity Catalog. | |
| List Resource Quotas | list_resource_quotas | List all resource quotas under a metastore. | |
| List System Schemas | list_system_schemas | List system schemas for a metastore. | |
| Set Artifact Allowlist | set_artifact_allowlist | Set the artifact allowlist of a certain artifact type in the metastore. | |
| Update Grants | update_grants | Update permissions on a securable object in Unity Catalog. |
Unity catalog models
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Create Registered Model | create_registered_model | Create a registered model in Unity Catalog. | |
| Delete Model Version | delete_model_version | Delete a model version. | |
| Delete Registered Model | delete_registered_model | Delete a registered model. | |
| Delete Registered Model Alias | delete_registered_model_alias | Delete an alias from a registered model. | |
| Get Model Version | get_model_version | Get a specific model version by number. | |
| Get Model Version By Alias | get_model_version_by_alias | Get a model version by alias. | |
| Get Registered Model | get_registered_model | Get a registered model by its full three-level name. | |
| List Model Versions | list_model_versions | List versions of a registered model. | |
| List Registered Models | list_registered_models | List registered models in Unity Catalog. | |
| Set Registered Model Alias | set_registered_model_alias | Set an alias on a registered model pointing to a version. | |
| Update Model Version | update_model_version | Update a model version’s comment. | |
| Update Registered Model | update_registered_model | Update a registered model’s name, comment, or owner. |
Unity catalog monitoring
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Create Online Table | create_online_table | Create an online table (serving-optimized read replica of a UC table). | |
| Create Quality Monitor | create_quality_monitor | Create a Lakehouse Monitor for a Unity Catalog table. | |
| Delete Online Table | delete_online_table | Delete an online table by name. | |
| Delete Quality Monitor | delete_quality_monitor | Delete the Lakehouse Monitor for a Unity Catalog table. | |
| Get Column Lineage | get_column_lineage | Get upstream and downstream column lineage for a table column. | |
| Get Online Table | get_online_table | Get an online table by name. | |
| Get Quality Monitor | get_quality_monitor | Get the Lakehouse Monitor for a Unity Catalog table. | |
| Get Quality Monitor Refresh | get_quality_monitor_refresh | Get a specific refresh of a table’s monitor. | |
| Get Table Lineage | get_table_lineage | Get upstream and downstream table lineage for a table. | |
| List Quality Monitor Refreshes | list_quality_monitor_refreshes | List refreshes of a table’s monitor. | |
| Run Quality Monitor Refresh | run_quality_monitor_refresh | Trigger a refresh (metric recomputation) of a table’s monitor. | |
| Update Quality Monitor | update_quality_monitor | Update the Lakehouse Monitor for a Unity Catalog table. |
Vector search
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Create Vector Search Endpoint | create_vector_search_endpoint | Create a new vector search endpoint | |
| Create Vector Search Index | create_vector_search_index | Create a new vector search index | |
| Delete Vector Search Endpoint | delete_vector_search_endpoint | Delete a vector search endpoint | |
| Delete Vector Search Index | delete_vector_search_index | Delete a vector search index | |
| Delete Vector Search Index Data | delete_vector_search_index_data | Delete rows of data from a Direct Access vector search index by primary key | |
| Get Vector Search Endpoint | get_vector_search_endpoint | Get details of a vector search endpoint | |
| Get Vector Search Index | get_vector_search_index | Get details of a vector search index | |
| List Vector Search Endpoints | list_vector_search_endpoints | List all vector search endpoints in the workspace | |
| List Vector Search Indexes | list_vector_search_indexes | List all vector search indexes on an endpoint | |
| Query Vector Search Index | query_vector_search_index | Query a vector search index | |
| Query Vector Search Index Next Page | query_vector_search_index_next_page | Retrieve the next page of vector search query results | |
| Scan Vector Search Index | scan_vector_search_index | Scan the rows of a vector search index | |
| Sync Vector Search Index | sync_vector_search_index | Trigger a sync of a Delta Sync vector search index | |
| Upsert Vector Search Index Data | upsert_vector_search_index_data | Upsert rows of data into a Direct Access vector search index |
Workspace
| Operation | ID | Description | Trigger |
|---|---|---|---|
| Create Git Credential | create_git_credential | Create a Git credential entry for the calling user. | |
| Create Repo | create_repo | Create a repo in the workspace and link it to a remote Git repo. | |
| Delete Git Credential | delete_git_credential | Delete the Git credential with the given credential ID. | |
| Delete Repo | delete_repo | Delete the repo with the given repo ID. | |
| Delete Workspace Object | delete_workspace_object | Delete an object or directory in the workspace. | |
| Export Workspace Object | export_workspace | Export a notebook/file. | |
| Get Git Credential | get_git_credential | Get the Git credential with the given credential ID. | |
| Get Repo | get_repo | Get the repo with the given repo ID. | |
| Get Workspace Status | get_workspace_status | Get the status of an object or directory in the workspace. | |
| Import Workspace Object | import_workspace | Import a notebook/file to a workspace path. | |
| List Git Credentials | list_git_credentials | Get the calling user’s Git credentials. | |
| List Repos | list_repos | Get repos that the calling user has Manage permissions on. | |
| List Workspace Objects | list_workspace | List notebooks/folders/files under a workspace path. | |
| Make Workspace Directories | make_workspace_directories | Create the given directory and necessary parent directories in the workspace. | |
| Update Git Credential | update_git_credential | Update the Git credential with the given credential ID. | |
| Update Repo | update_repo | Update the repo to a different branch or tag, or update its sparse checkout settings. |