API scopes
API scopes restrict which Databricks REST API endpoints a token can access. Each scope grants access to specific API operations.
AI/BI
dashboards
Perform operations related to AI/BI Dashboards.
| Operation | API |
|---|---|
| List Dashboards | Lakeview |
| Create Dashboard | Lakeview |
| Migrate Dashboard | Lakeview |
| Update Dashboard | Lakeview |
| Get Dashboard | Lakeview |
| Trash Dashboard | Lakeview |
| Publish Dashboard | Lakeview |
| Get Published Dashboard | Lakeview |
| Unpublish Dashboard | Lakeview |
| Get Published Dashboard Token Info | Lakeview |
| Revert Dashboard | Lakeview |
| List Schedules | Lakeview |
| Get Schedule | Lakeview |
| Delete Schedule | Lakeview |
| List Subscriptions | Lakeview |
| Get Subscription | Lakeview |
| Delete Subscription | Lakeview |
| Create Schedule | Lakeview |
| Update Schedule | Lakeview |
| Create Subscription | Lakeview |
| Me | Scim |
Access Management
access-management
Perform operations related to users, service principals, groups and their permissions in Accounts and Workspaces.
| Operation | API |
|---|---|
| Get Object Permissions | Access Management |
| Set Object Permissions | Access Management |
| Update Object Permissions | Access Management |
| List Permission Levels | Access Management |
| Me | Scim |
Alerts
alerts
Perform operations related to Databricks SQL alerts and alert destinations.
| Operation | API |
|---|---|
| List Alerts | Alerts |
| Create Alert | Alerts |
| Update Alert | Alerts |
| Get Alert | Alerts |
| Trash Alert | Alerts |
| Me | Scim |
Apps
apps
Perform operations related to Apps on Databricks.
| Operation | API |
|---|---|
| List Apps | Apps |
| Create App | Apps |
| Update App | Apps |
| List App Deployments | Apps |
| Create App Deployment | Apps |
| Get App Deployment | Apps |
| Get App Update | Apps |
| Async Update App | Apps |
| Get App | Apps |
| Delete App | Apps |
| Start App | Apps |
| Stop App | Apps |
| Update App Thumbnail | Apps |
| Delete App Thumbnail | Apps |
| Me | Scim |
Authentication
authentication
Perform operations related to authentication settings and configurations for Accounts and Workspaces.
| Operation | API |
|---|---|
| Me | Scim |
| Create On Behalf Of Token | Token Management |
| List Tokens | Token Management |
| Update Token | Token Management |
| Get Token | Token Management |
| Delete Token | Token Management |
| Create Token | Tokens |
| Revoke Token | Tokens |
| List Tokens | Tokens |
| Update Token | Tokens |
Clean Rooms
cleanrooms
Perform operations related to clean rooms and their assets and task runs.
| Operation | API |
|---|---|
| List Clean Rooms | Clean Rooms |
| Create Clean Room | Clean Rooms |
| Create Clean Room Asset | Clean Rooms |
| Create Clean Room Auto Approval Rule | Clean Rooms |
| Update Clean Room Auto Approval Rule | Clean Rooms |
| List Clean Room Assets | Clean Rooms |
| Update Clean Room Asset | Clean Rooms |
| Get Clean Room Asset | Clean Rooms |
| Delete Clean Room Asset | Clean Rooms |
| Create Clean Room Asset Review | Clean Rooms |
| List Clean Room Asset Revisions | Clean Rooms |
| Get Clean Room Asset Revision | Clean Rooms |
| List Clean Room Auto Approval Rules | Clean Rooms |
| Get Clean Room Auto Approval Rule | Clean Rooms |
| Delete Clean Room Auto Approval Rule | Clean Rooms |
| Create Clean Room Output Catalog | Clean Rooms |
| List Clean Room Notebook Task Runs | Clean Rooms |
| List Clean Room Task Runs Handler | Clean Rooms |
| Delete Clean Room | Clean Rooms |
| Update Clean Room | Clean Rooms |
| Get Clean Room | Clean Rooms |
| Me | Scim |
Clusters
clusters
Perform operations related to cluster management for data processing and analytics.
| Operation | API |
|---|---|
| Create Policy | Cluster Policies |
| Delete Policy | Cluster Policies |
| Edit Policy | Cluster Policies |
| Get Policy | Cluster Policies |
| List Policies | Cluster Policies |
| Get Cluster Policy Revision | Cluster Policies |
| Rollback Cluster Policy | Cluster Policies |
| List Cluster Policy Revisions | Cluster Policies |
| Enforce Policy Compliance For Cluster | Clusters |
| Get Policy Compliance For Cluster | Clusters |
| List Cluster Compliance For Policy | Clusters |
| Cancel Pending Cluster Enforcement | Clusters |
| Change Cluster Owner | Clusters |
| Create Cluster | Clusters |
| Delete Cluster | Clusters |
| Edit Cluster | Clusters |
| List Events | Clusters |
| Get Cluster | Clusters |
| List Clusters | Clusters |
| List Node Types | Clusters |
| List Available Zones | Clusters |
| Permanent Delete Cluster | Clusters |
| Pin Cluster | Clusters |
| Resize Cluster | Clusters |
| Restart Cluster | Clusters |
| List Spark Versions | Clusters |
| Start Cluster | Clusters |
| Unpin Cluster | Clusters |
| Update Cluster | Clusters |
| Get Cluster Revision | Clusters |
| Rollback Cluster | Clusters |
| List Cluster Revisions | Clusters |
| List Policy Families | Policy Families |
| Get Policy Family | Policy Families |
| Me | Scim |
Command Execution
command-execution
Perform operations related to execution of commands and code on clusters and management of execution contexts.
| Operation | API |
|---|---|
| Cancel | Command Execution |
| Execute | Command Execution |
| Get Command Status | Command Execution |
| Create | Command Execution |
| Destroy | Command Execution |
| Get Context Status | Command Execution |
| Me | Scim |
Data Classification
dataclassification
Perform operations related to data classification for Unity Catalog catalogs.
| Operation | API |
|---|---|
| Update Catalog Config | Data Classification |
| Get Catalog Config | Data Classification |
| Delete Catalog Config | Data Classification |
| Create Catalog Config | Data Classification |
| Me | Scim |
Data Quality Monitoring
dataquality
Perform operations related to Data Quality Monitoring for Unity Catalog objects.
| Operation | API |
|---|---|
| List Monitor | Data Quality |
| Create Monitor | Data Quality |
| Get Monitor | Data Quality |
| Update Monitor | Data Quality |
| Delete Monitor | Data Quality |
| List Refresh | Data Quality |
| Get Refresh | Data Quality |
| Update Refresh | Data Quality |
| Delete Refresh | Data Quality |
| Cancel Refresh | Data Quality |
| Create Refresh | Data Quality |
| Me | Scim |
Databricks SQL
sql
Perform operations related to Databricks SQL assets, including warehouses, dashboards, queries and query history, and alerts.
| Operation | API |
|---|---|
| Create Alert | Alerts |
| List Alerts | Alerts |
| Get Alert | Alerts |
| Update Alert | Alerts |
| Trash Alert | Alerts |
| Create Query | Queries |
| List Queries | Queries |
| Update Query | Queries |
| Trash Query | Queries |
| Get Query | Queries |
| Me | Scim |
| Execute Statement | Statement Execution |
| Get Statement Result | Statement Execution |
| Cancel Statement | Statement Execution |
| Get Result Data | Statement Execution |
| Set Workspace Warehouse Config | Warehouses |
| Get Workspace Warehouse Config | Warehouses |
| List Warehouses | Warehouses |
| Create Warehouse | Warehouses |
| Delete Warehouse | Warehouses |
| Get Warehouse | Warehouses |
| Edit Warehouse | Warehouses |
| Start Warehouse | Warehouses |
| Stop Warehouse | Warehouses |
| Create Default Warehouse Override | Warehouses |
| List Default Warehouse Overrides | Warehouses |
| Update Default Warehouse Override | Warehouses |
| Delete Default Warehouse Override | Warehouses |
| Get Default Warehouse Override | Warehouses |
Databricks Workspace
workspace
Perform operations related to workspace-level entities that include notebooks, Git checkouts, and secrets.
| Operation | API |
|---|---|
| List Credentials | Git Credentials |
| Create Credentials | Git Credentials |
| Get Credentials | Git Credentials |
| Update Credentials | Git Credentials |
| Delete Credentials | Git Credentials |
| List Repos | Repos |
| Create Repo | Repos |
| Update Repo | Repos |
| Get Repo | Repos |
| Delete Repo | Repos |
| Me | Scim |
| Delete | Workspace Objects |
| Delete | Workspace Objects |
| Export | Workspace Objects |
| Get Status | Workspace Objects |
| Get Status | Workspace Objects |
| Import | Workspace Objects |
| Import | Workspace Objects |
| List | Workspace Objects |
| Mkdirs | Workspace Objects |
| Mkdirs | Workspace Objects |
Delta Sharing
sharing
Perform operations related to data sharing with Unity Catalog for providers, recipients, and shares.
| Operation | API |
|---|---|
| Me | Scim |
| Create Federation Policy | Sharing |
| List Federation Policies | Sharing |
| Get Federation Policy | Sharing |
| Delete Federation Policy | Sharing |
| List Provider Share Assets | Sharing |
| List Providers | Sharing |
| Create Provider | Sharing |
| Update Provider | Sharing |
| Delete Provider | Sharing |
| Get Provider | Sharing |
| List Provider Shares | Sharing |
| Retrieve Access Token | Sharing |
| Get Activation Url Info | Sharing |
| List Recipients | Sharing |
| Create Recipient | Sharing |
| Update Recipient | Sharing |
| Get Recipient | Sharing |
| Delete Recipient | Sharing |
| Rotate Recipient Token | Sharing |
| List Recipient Share Permissions | Sharing |
| List Shares | Sharing |
| Create Share | Sharing |
| Update Share | Sharing |
| Get Share | Sharing |
| Delete Share | Sharing |
| List Share Permissions | Sharing |
| Update Share Permissions | Sharing |
Disaster Recovery
disaster-recovery
Manage disaster recovery configurations and execute failover operations.
| Operation | API |
|---|---|
| Update Failover Group | Disaster Recovery |
| Get Failover Group | Disaster Recovery |
| Delete Failover Group | Disaster Recovery |
| Failover Failover Group | Disaster Recovery |
| Get Stable Url | Disaster Recovery |
| Delete Stable Url | Disaster Recovery |
| List Failover Groups | Disaster Recovery |
| Create Failover Group | Disaster Recovery |
| List Stable Urls | Disaster Recovery |
| Create Stable Url | Disaster Recovery |
| Me | Scim |
Environments
environments
Perform operations related to workspace-level environments including base environments for serverless notebooks and jobs.
| Operation | API |
|---|---|
| List Workspace Base Environments | Environments |
| Create Workspace Base Environment | Environments |
| Update Default Workspace Base Environment | Environments |
| Get Default Workspace Base Environment | Environments |
| Get Operation | Environments |
| Get Workspace Base Environment | Environments |
| Update Workspace Base Environment | Environments |
| Delete Workspace Base Environment | Environments |
| Refresh Workspace Base Environment | Environments |
| Me | Scim |
File Management
files
Perform operations related to managing files on Databricks in a filesystem-like interface.
| Operation | API |
|---|---|
| Add Block | Files |
| Close | Files |
| Create | Files |
| Delete | Files |
| Get Status | Files |
| List | Files |
| Mkdirs | Files |
| Move | Files |
| Put | Files |
| Read | Files |
| Create Directory | Files |
| Delete Directory | Files |
| Get Directory Metadata | Files |
| List Directory Contents | Files |
| Get File Metadata | Files |
| Upload File | Files |
| Delete File | Files |
| Download File | Files |
| Me | Scim |
Genie
genie
Perform operations related to Genie conversational analytics spaces and queries.
Global Init Scripts
global-init-scripts
Perform operations related to global initialization scripts.
| Operation | API |
|---|---|
| List Global Init Scripts | Global Init Scripts |
| Create Global Init Script | Global Init Scripts |
| Get Global Init Script | Global Init Scripts |
| Update Global Init Script | Global Init Scripts |
| Delete Global Init Script | Global Init Scripts |
| Me | Scim |
Identity
identity
Perform operations related to identities in Accounts and Workspaces.
| Operation | API |
|---|---|
| Resolve Group Proxy | Iam |
| Resolve Service Principal Proxy | Iam |
| Resolve User Proxy | Iam |
| Get Workspace Access Detail Local | Iam |
| Me | Scim |
Instance Pools
instance-pools
Perform operations related to management of instance pools to reduce cluster start and scale-up times.
| Operation | API |
|---|---|
| Create Instance Pool | Instance Pools |
| Delete Instance Pool | Instance Pools |
| Edit Instance Pool | Instance Pools |
| Get Instance Pool | Instance Pools |
| List Instance Pools | Instance Pools |
| Me | Scim |
Instance Profiles
instance-profiles
Perform operations related to instance profiles.
| Operation | API |
|---|---|
| Add Instance Profile | Instance Profiles |
| Edit Instance Profile | Instance Profiles |
| List Instance Profiles | Instance Profiles |
| Remove Instance Profile | Instance Profiles |
| Me | Scim |
Jobs and Workflows
jobs
Perform operations related to automated jobs and workflows on Databricks Workspaces.
| Operation | API |
|---|---|
| Enforce Policy Compliance For Job | Jobs |
| Get Policy Compliance For Job | Jobs |
| List Job Compliance For Policy | Jobs |
| Create Job | Jobs |
| Delete Job | Jobs |
| Get Job | Jobs |
| List Jobs | Jobs |
| Reset Job | Jobs |
| Run Now | Jobs |
| Cancel Run | Jobs |
| Cancel All Runs | Jobs |
| Delete Run | Jobs |
| Export Run | Jobs |
| Get Run | Jobs |
| Get Run Output | Jobs |
| List Runs | Jobs |
| Repair | Jobs |
| Submit Run | Jobs |
| Update Job | Jobs |
| Me | Scim |
Knowledge Assistants
knowledge-assistants
Perform operations related to Knowledge Assistants and related resources.
| Operation | API |
|---|---|
| List Knowledge Assistants | Knowledge Assistants |
| Create Knowledge Assistant | Knowledge Assistants |
| Update Knowledge Assistant | Knowledge Assistants |
| Delete Example | Knowledge Assistants |
| Update Example | Knowledge Assistants |
| Get Example | Knowledge Assistants |
| Get Knowledge Source | Knowledge Assistants |
| Update Knowledge Source | Knowledge Assistants |
| Delete Knowledge Source | Knowledge Assistants |
| Get Knowledge Assistant | Knowledge Assistants |
| Delete Knowledge Assistant | Knowledge Assistants |
| Sync Knowledge Sources | Knowledge Assistants |
| List Examples | Knowledge Assistants |
| Create Example | Knowledge Assistants |
| Create Knowledge Source | Knowledge Assistants |
| List Knowledge Sources | Knowledge Assistants |
| Me | Scim |
Libraries
libraries
Perform operations related to libraries on Databricks.
| Operation | API |
|---|---|
| All Cluster Statuses | Cluster Libraries |
| Cluster Status | Cluster Libraries |
| Install Libraries | Cluster Libraries |
| Uninstall Libraries | Cluster Libraries |
| Me | Scim |
MLflow
mlflow
Perform operations related to MLflow experiments, runs, models, and model registry artifacts.
Marketplace
marketplace
Perform operations related to AI and analytics assets such as ML models, notebooks, applications in an open marketplace.
Model Serving
model-serving
Perform operations related to model serving endpoints for real-time inference.
| Operation | API |
|---|---|
| Create Inference Endpoint | Model Serving |
| List Inference Endpoints | Model Serving |
| Create Provisioned Throughput Inference Endpoint | Model Serving |
| Put Provisioned Throughput Inference Endpoint Config | Model Serving |
| Delete Inference Endpoint | Model Serving |
| Get Inference Endpoint | Model Serving |
| Put Inference Endpoint Ai Gateway | Model Serving |
| Put Inference Endpoint Config | Model Serving |
| Get Export Endpoint Metrics | Model Serving |
| Update Inference Endpoint Notifications | Model Serving |
| Get Inference Endpoint Schema | Model Serving |
| Put Inference Endpoint Rate Limits | Model Serving |
| Get Served Model Build Logs | Model Serving |
| Get Served Model Logs | Model Serving |
| Patch Inference Endpoint Tags | Model Serving |
| Patch Inference Endpoint Telemetry Config | Model Serving |
| Query | Model Serving Query |
| Me | Scim |
Model Serving Inference
model-serving-inference
Query model serving endpoints for real-time inference.
| Operation | API |
|---|---|
| Query | Model Serving Query |
| Me | Scim |
Networking
networking
Perform operations related to network connectivity configurations, private access, and network policies.
| Operation | API |
|---|---|
| Create Ip Access List | Networking |
| List Ip Access Lists | Networking |
| Get Ip Access List | Networking |
| Update Ip Access List | Networking |
| Delete Ip Access List | Networking |
| Replace Ip Access List | Networking |
| Me | Scim |
Notifications
notifications
Perform operations related to notification destinations for alerts and system notifications.
| Operation | API |
|---|---|
| List Notification Destinations | Notification Destinations |
| Create Notification Destination | Notification Destinations |
| Get Notification Destination | Notification Destinations |
| Update Notification Destination | Notification Destinations |
| Delete Notification Destination | Notification Destinations |
| Me | Scim |
Pipelines
pipelines
Perform operations related to pipelines, runs, and other Delta Live Table resources.
| Operation | API |
|---|---|
| List | Pipelines |
| Create | Pipelines |
| Get | Pipelines |
| Edit | Pipelines |
| Delete | Pipelines |
| Clone | Pipelines |
| Apply Environment | Pipelines |
| Events | Pipelines |
| Stop | Pipelines |
| List Updates | Pipelines |
| Start | Pipelines |
| Get Update | Pipelines |
| Me | Scim |
Postgres Database
postgres
Perform operations related to Postgres Database Instances and their configurations.
Provisioning
provisioning
Perform operations related to Databricks Workspace deployment, cross-account IAM roles, storage, and encryption configurations.
| Operation | API |
|---|---|
| Get Endpoint | Networking |
| Delete Endpoint | Networking |
| List Endpoints | Networking |
| Create Endpoint | Networking |
| Me | Scim |
Query History
query-history
Perform operations related to query history.
| Operation | API |
|---|---|
| List Queries | Query History |
| Me | Scim |
SCIM
scim
Perform operations related to users, service principals, groups and their permissions in Accounts and Workspaces.
| Operation | API |
|---|---|
| Update Permissions | Scim |
| Set Permissions | Scim |
| Get Permissions | Scim |
| Get Permission Levels | Scim |
| Create Group | Scim |
| List Groups | Scim |
| Patch Group | Scim |
| Update Group | Scim |
| Delete Group | Scim |
| Get Group | Scim |
| Me | Scim |
| List Service Principals | Scim |
| Create Service Principal | Scim |
| Patch Service Principal | Scim |
| Update Service Principal | Scim |
| Get Service Principal | Scim |
| Delete Service Principal | Scim |
| Create User | Scim |
| List Users | Scim |
| Delete User | Scim |
| Get User | Scim |
| Patch User | Scim |
| Update User | Scim |
Secrets Management
secrets
Perform operations related to secrets for secure credential storage.
| Operation | API |
|---|---|
| Me | Scim |
| Delete Acl | Secrets |
| Get Acl | Secrets |
| List Acls | Secrets |
| Put Acl | Secrets |
| Delete Secret | Secrets |
| Get Secret | Secrets |
| List Secrets | Secrets |
| Put Secret | Secrets |
| Create Scope | Secrets |
| Delete Scope | Secrets |
| List Scopes | Secrets |
Settings
settings
Perform operations related to security settings for Accounts and Workspaces.
| Operation | API |
|---|---|
| Me | Scim |
| List Workspace Settings Metadata | Settings |
| Get Public Workspace Setting | Settings |
| Patch Public Workspace Setting | Settings |
Supervisor Agents
supervisor-agents
Manage Supervisor Agents and related resources.
| Operation | API |
|---|---|
| Me | Scim |
| List Supervisor Agents | Supervisor Agents |
| Create Supervisor Agent | Supervisor Agents |
| Get Example | Supervisor Agents |
| Update Example | Supervisor Agents |
| Delete Example | Supervisor Agents |
| Delete Tool | Supervisor Agents |
| Get Tool | Supervisor Agents |
| Get Supervisor Agent | Supervisor Agents |
| Delete Supervisor Agent | Supervisor Agents |
| List Examples | Supervisor Agents |
| Create Example | Supervisor Agents |
| List Tools | Supervisor Agents |
| Create Tool | Supervisor Agents |
| Update Supervisor Agent | Supervisor Agents |
| Update Tool | Supervisor Agents |
Tags
tags
Perform operations related to tag policies and tag assignments on workspace objects.
| Operation | API |
|---|---|
| Me | Scim |
| Create Tag Assignment | Tag Assignments |
| List Tag Assignments | Tag Assignments |
| Get Tag Assignment | Tag Assignments |
| Delete Tag Assignment | Tag Assignments |
| Update Tag Assignment | Tag Assignments |
| List Tag Policies | Tag Policies |
| Create Tag Policy | Tag Policies |
| Get Tag Policy | Tag Policies |
| Delete Tag Policy | Tag Policies |
| Update Tag Policy | Tag Policies |
Unity Catalog
unity-catalog
Perform operations related to data governance with Unity Catalog for metastores, catalogs, schemas, tables, external locations, and storage credentials.
Vector Search
vector-search
Perform operations related to Vector Search indexes.
| Operation | API |
|---|---|
| Me | Scim |
| Create Endpoint | Vector Search |
| List Endpoints | Vector Search |
| Get Endpoint | Vector Search |
| Delete Endpoint | Vector Search |
| Patch Endpoint | Vector Search |
| Patch Endpoint Budget Policy | Vector Search |
| Retrieve User Visible Metrics | Vector Search |
| List Vector Index | Vector Search |
| Create Vector Index | Vector Search |
| Delete Vector Index | Vector Search |
| Get Vector Index | Vector Search |
| Delete Data Vector Index | Vector Search |
| Query Vector Index | Vector Search |
| Query Vector Index Next Page | Vector Search |
| Scan Vector Index | Vector Search |
| Sync Vector Index | Vector Search |
| Upsert Data Vector Index | Vector Search |