SAP Databricks API reference
Only the following workspace-level and account-level APIs listed on this page are available for SAP Databricks users.
For information on authentication, see the Databricks REST API Introduction.
Workspace-level APIs
Databricks Workspace
- Get Git credentials
- Create a credential entry
- Get a credential entry
- Update a credential
- Delete a credential
- Get repo permissions
- Set repo permissions
- Update repo permissions
- Get repo permission levels
- Get repos
- Create a repo
- Get a repo
- Update a repo
- Delete a repo
- Delete an ACL
- Get secret ACL details
- Lists ACLs
- Create/update an ACL
- Delete a secret
- Get a secret
- List secret keys
- Add a secret
- Create a new secret scope
- Delete a secret scope
- List all scopes
- Get workspace object permissions
- Set workspace object permissions
- Update workspace object permissions
- Get workspace object permission levels
- Delete a workspace object
- Export a workspace object
- Get status
- Import a workspace object
- List contents
- Create a directory
File management
- List directory contents
- Get directory metadata
- Create a directory
- Delete a directory
- Download a file
- Get file metadata
- Upload a file
- Delete a file
Machine Learning
- List artifacts
- Delete runs by creation time
- Restore runs by deletion time
- Create experiment
- Delete an experiment
- Get an experiment
- Get an experiment by name
- List experiments
- Restore an experiment
- Search experiments
- Set a tag for an experiment
- Update an experiment
- Create a logged model
- Search logged models
- Get a logged model
- Finalize a logged model
- Delete a logged model
- Log params for a logged model
- Set tags for a logged model
- Delete a tag on a logged model
- Get metric history for a run
- Create a run
- Delete a run
- Delete a tag on a run
- Get a run
- Log a batch of metrics/params/tags for a run
- Log inputs to a run
- Log a metric for a run
- Log a model
- Log a param for a run
- Log outputs from a run
- Restore a run
- Search for runs
- Set a tag for a run
- Update a run
- Get experiment permissions
- Set experiment permissions
- Update experiment permissions
- Get experiment permission levels
- Create a trace within an experiment
- Delete traces
- Search for traces
- Get a trace
- End a trace
- Create an assessment of a trace
- Get an assessment of a trace
- Update an assessment of a trace
- Delete an assessment of a trace
- Get credentials to download trace data
- Get credentials to upload trace data
- Set a tag for a trace
- Delete a tag from a trace
- Post a comment
- Delete a comment
- Update a comment
- Transition a stage
- Get model
- Create a model version
- Delete a model version.
- Delete a model version tag
- Get a model version
- Get a model version URI
- Searches model versions
- Set a version tag
- Update model version
- Create a model
- Delete a model
- Delete a model tag
- Get the latest version
- List models
- Rename a model
- Search models
- Set a tag
- Update model
- Create a webhook
- Delete a webhook
- List registry webhooks
- Test a webhook
- Update a webhook
- Approve transition request
- Make a transition request
- Delete a transition request
- List transition requests
- Reject a transition request
- Get registered model permissions
- Set registered model permissions
- Update registered model permissions
- Get registered model permission levels
Real-time Serving
- Get serving endpoint permissions
- Set serving endpoint permissions
- Update serving endpoint permissions
- Get serving endpoint permission levels
- Get all serving endpoints
- Create a new serving endpoint
- Create a new PT serving endpoint (Preview)
- Update config of a PT serving endpoint (Preview)
- Get a single serving endpoint
- Delete a serving endpoint
- Update AI Gateway of a serving endpoint (Preview)
- Update config of a serving endpoint
- Get metrics of a serving endpoint
- Get the schema for a serving endpoint (Preview)
- Update rate limits of a serving endpoint (Preview)
- Get build logs for a served model
- Get the latest logs for a served model
- Update tags of a serving endpoint
- Query a serving endpoint
Vector Search
- List all endpoints
- Create an endpoint
- Get an endpoint
- Delete an endpoint
- Update the budget policy of an endpoint (Preview)
- List indexes
- Create an index
- Get an index
- Delete an index
- Delete data from index
- Query an index
- Query next page
- Scan an index
- Synchronize an index
- Upsert data into an index
Identity & Access Management
- Get object permissions
- Set object permissions
- Update object permissions
- Get object permission levels
- List service principals.
- Get service principal details.
- Replace service principal.
- Update service principal details.
- Delete a service principal.
Databricks SQL
- Execute a SQL statement
- Get status, manifest, and result first chunk
- Cancel statement execution
- Get result chunk by index
- Get SQL warehouse permissions
- Set SQL warehouse permissions
- Update SQL warehouse permissions
- Get SQL warehouse permission levels
- List warehouses
- Create a warehouse
- Get warehouse info
- Delete a warehouse
- Update a warehouse
- Start a warehouse
- Stop a warehouse
Unity Catalog
- List credentials
- Create a credential
- Get a credential
- Update a credential
- Delete a credential
- Generate a temporary service credential
- Validate a credential
- Get Model Version By Alias
- List Model Versions
- Get a Model Version
- Update a Model Version
- Delete a Model Version
- Get a table monitor
- Create a table monitor
- Update a table monitor
- Delete a table monitor
- List refreshes
- Queue a metric refresh for a monitor
- Get refresh
- List Registered Models
- Create a Registered Model
- Get a Registered Model
- Update a Registered Model
- Delete a Registered Model
- Set a Registered Model Alias
- Delete a Registered Model Alias
- List credentials
- Create a storage credential
- Get a credential
- Update a credential
- Delete a credential
- Validate a storage credential
- Get securable workspace bindings
- Update securable workspace bindings
- Get catalog workspace bindings
- Update catalog workspace bindings
Delta Sharing
- List assets by provider share
- List providers
- Create an auth provider
- Get a provider
- Update a provider
- Delete a provider
- List shares by Provider
- List shares
- Create a share
- Get a share
- Update a share
- Delete a share
- Get permissions
- Update permissions
Settings
Automatic Cluster Update (Preview)
Compliance Security Profile (Preview)
- Get the default namespace setting
- Update the default namespace setting
- Delete the default namespace setting
Notebook and File exporting (Preview)
Results Table Clipboard features (Preview)
- Get the Results Table Clipboard features setting
- Update the Results Table Clipboard features setting
Notebook results download (Preview)
Restrict Workspace Admins (Preview)
- Get the restrict workspace admins setting
- Update the restrict workspace admins setting
- Delete the restrict workspace admins setting
SQL Results Download (Preview)
- Get the SQL Results Download setting
- Update the SQL Results Download setting
- Delete the SQL Results Download setting
Account-level APIs
Identity and Access Management
Account Access Control (Preview)
- List group details.
- Create a new group.
- Get group details.
- Replace a group.
- Update group details.
- Delete a group.
- List service principals.
- Create a service principal.
- Get service principal details.
- Replace service principal.
- Update service principal details.
- Delete a service principal.
- List users.
- Create a new user.
- Get user details.
- Replace a user.
- Update user details.
- Delete a user.
- Get permission assignments
- List workspace permissions
- Create or update permissions assignment
- Delete permissions assignment
Settings
- Get access lists
- Create access list
- Get IP access list
- Replace access list
- Update access list
- Delete access list
Compliance Security Profile For New Workspaces (Preview)
- Get the compliance security profile setting for new workspaces
- Update the compliance security profile setting for new workspaces