Databricks

Collection of Databricks REST APIs for managing workspaces, clusters, jobs, and data operations.

57 APIs 16 Features

AIAnalyticsApache SparkBig DataClean RoomsCloud ComputingDataData AnalyticsData EngineeringData GovernanceDelta LakeDelta SharingETLIdentity ManagementLakehouseMachine LearningMLflowModel ServingSecuritySQLUnity CatalogVector SearchVisualize

APIs

Databricks

Databricks is a cloud-based data platform that simplifies and accelerates the process of preparing and analyzing large volumes of data. The platform integrates with popular data...

Databricks Clusters API

The Databricks Clusters API allows you to create, start, edit, list, terminate, and delete clusters. Clusters are managed cloud resources that enable you to run data engineering...

Databricks Jobs API

The Databricks Jobs API allows you to create, edit, delete, and trigger jobs. Jobs are the primary mechanism for running automated workloads on Databricks, including notebooks, ...

Databricks DBFS API

The Databricks File System (DBFS) API is a distributed file system mounted into a Databricks workspace and available on Databricks clusters. The API enables you to interact with...

Databricks Workspace API

The Databricks Workspace API allows you to list, import, export, and delete notebooks, folders, and libraries in a Databricks workspace. It provides programmatic access to manag...

Databricks SQL Warehouses API

The Databricks SQL Warehouses API allows you to create, edit, list, start, stop, and delete SQL warehouses. SQL warehouses are compute resources that enable you to run SQL comma...

Databricks Pipelines API

The Databricks Pipelines API allows you to create, edit, delete, start, and stop Delta Live Tables pipelines. Delta Live Tables is a declarative framework for building reliable,...

Databricks Serving Endpoints API

The Databricks Serving Endpoints API allows you to create, update, query, and delete model serving endpoints. Mosaic AI Model Serving provides a unified interface to deploy, gov...

Databricks Secrets API

The Databricks Secrets API allows you to manage secrets, secret scopes, and secret ACLs. Secrets provide a secure way to store and reference credentials and other sensitive info...

Databricks Instance Pools API

The Databricks Instance Pools API allows you to create, edit, delete, and list instance pools. Instance pools reduce cluster start and auto-scaling times by maintaining a set of...

Databricks Token Management API

The Databricks Token Management API enables workspace administrators to manage personal access tokens for users and service principals. It allows creating, listing, and revoking...

Databricks Catalogs API

The Databricks Catalogs API is part of Unity Catalog and allows you to create, update, list, and delete catalogs. Catalogs are the top-level container for data objects in Unity ...

Databricks Vector Search Indexes API

The Databricks Vector Search Indexes API allows you to create, manage, query, and delete vector search indexes. Vector Search enables you to store vector representations of your...

Databricks Model Versions API

The Databricks Model Versions API allows you to manage model versions within the Unity Catalog model registry. It provides programmatic access to create, update, list, and delet...

Databricks Permissions API

The Databricks Permissions API allows you to manage permissions on workspace objects such as clusters, jobs, notebooks, and SQL warehouses. It provides programmatic access to ge...

Databricks Repos API

The Databricks Repos API allows you to manage Git repositories within a Databricks workspace. It provides programmatic access to create, update, delete, and list repos, as well ...

Databricks Git Credentials API

The Databricks Git Credentials API allows you to manage Git credentials for authenticating with Git providers. It provides programmatic access to create, update, delete, and lis...

Databricks Cluster Policies API

The Databricks Cluster Policies API allows administrators to create, edit, delete, and list cluster policies. Cluster policies limit the ability to configure clusters based on a...

Databricks Libraries API

The Databricks Libraries API allows you to install, uninstall, and list libraries on clusters. It provides programmatic management of Python, Java, Scala, and R library dependen...

Databricks Global Init Scripts API

The Databricks Global Init Scripts API enables workspace administrators to manage global initialization scripts that run on every cluster in the workspace. It provides programma...

Databricks Command Execution API

The Databricks Command Execution API allows you to execute Python, Scala, SQL, or R commands on running Databricks clusters. It provides programmatic access to create execution ...

Databricks Statement Execution API

The Databricks Statement Execution API allows you to execute SQL statements on Databricks SQL warehouses and retrieve results. It provides a synchronous and asynchronous interfa...

Databricks Queries API

The Databricks Queries API allows you to create, update, delete, list, and run saved SQL queries in Databricks SQL. It provides programmatic management of SQL query objects, ena...

Databricks Alerts API

The Databricks Alerts API allows you to create, update, delete, and list alerts in Databricks SQL. Alerts automate query execution, evaluate custom conditions, and deliver notif...

Databricks Schemas API

The Databricks Schemas API is part of Unity Catalog and allows you to create, update, list, and delete schemas. Schemas, also known as databases, reside within catalogs and cont...

Databricks Tables API

The Databricks Tables API is part of Unity Catalog and allows you to create, update, list, and delete tables. Tables reside within schemas and represent structured data assets, ...

Databricks Volumes API

The Databricks Volumes API is part of Unity Catalog and allows you to create, update, list, and delete volumes. Volumes provide a governed location for storing and accessing non...

Databricks Functions API

The Databricks Functions API is part of Unity Catalog and allows you to create, list, and delete user-defined functions. Functions reside within schemas and can be used in SQL q...

Databricks Grants API

The Databricks Grants API is part of Unity Catalog and allows you to get, update, and manage permissions on Unity Catalog securable objects. It provides programmatic control ove...

Databricks External Locations API

The Databricks External Locations API is part of Unity Catalog and allows you to create, update, list, and delete external locations. External locations combine a cloud storage ...

Databricks Storage Credentials API

The Databricks Storage Credentials API is part of Unity Catalog and allows you to create, update, list, and delete storage credentials. Storage credentials contain long-term clo...

Databricks Metastores API

The Databricks Metastores API is part of Unity Catalog and allows you to create, update, list, and delete metastores. A metastore is the top-level container of objects in Unity ...

Databricks Connections API

The Databricks Connections API is part of Unity Catalog and allows you to create, update, list, and delete connections to external data sources. Connections enable federated que...

Databricks Registered Models API

The Databricks Registered Models API allows you to create, update, list, and delete registered models in the Unity Catalog model registry. It provides centralized model lifecycl...

Databricks Experiments API

The Databricks Experiments API allows you to create, update, list, and manage MLflow experiments. Experiments are the primary unit of organization in MLflow, grouping runs that ...

Databricks Online Tables API

The Databricks Online Tables API allows you to create, get, and delete online tables. Online tables are materialized copies of Delta tables optimized for low-latency lookups, en...

Databricks Quality Monitors API

The Databricks Quality Monitors API allows you to create, update, get, and delete data quality monitors for tables. Quality monitors enable automated data profiling and anomaly ...

Databricks Vector Search Endpoints API

The Databricks Vector Search Endpoints API allows you to create, list, get, and delete vector search endpoints. Vector search endpoints are compute resources that host vector se...

Databricks Shares API

The Databricks Shares API is part of Delta Sharing and allows you to create, update, list, and delete shares. A share is a read-only logical collection of tables and table parti...

Databricks Recipients API

The Databricks Recipients API is part of Delta Sharing and allows you to create, update, list, and delete recipients. A recipient is an entity that receives shared data from a p...

Databricks Providers API

The Databricks Providers API is part of Delta Sharing and allows you to create, update, list, and delete data providers. Providers represent organizations that share data throug...

Databricks Clean Rooms API

The Databricks Clean Rooms API allows you to create, update, list, and delete clean rooms. Clean rooms use Delta Sharing and serverless compute to provide a secure and privacy-p...

Databricks Notification Destinations API

The Databricks Notification Destinations API allows you to create, update, list, and delete notification destinations for a workspace. Notification destinations define where ale...

Databricks Apps API

The Databricks Apps API allows you to create, deploy, manage, and delete Databricks Apps. Apps run directly on a Databricks workspace, integrating with workspace data and servic...

Databricks Lakeview API

The Databricks Lakeview API allows you to create, update, get, list, and delete AI/BI dashboards. Lakeview dashboards provide a modern visualization experience built on top of D...

Databricks Files API

The Databricks Files API provides a standard HTTP interface for reading, writing, listing, and deleting files and directories in Unity Catalog volumes and other workspace storag...

Databricks Tokens API

The Databricks Tokens API allows you to create, list, and revoke personal access tokens. Personal access tokens are used to authenticate with the Databricks REST API and integra...

Databricks IP Access Lists API

The Databricks IP Access Lists API allows administrators to configure IP allow lists and block lists for a workspace. It provides programmatic management of network security rul...

Databricks Current User API

The Databricks Current User API allows you to retrieve information about the currently authenticated user or service principal. It returns identity details including username, d...

Databricks Groups API

The Databricks Groups API allows you to create, update, list, and delete groups in a workspace. Groups simplify identity management by enabling administrators to assign access p...

Databricks Service Principals API

The Databricks Service Principals API allows you to create, update, list, and delete service principals in a workspace. Service principals are identities for automated tools, jo...

Databricks Users API

The Databricks Users API allows you to create, update, list, and delete users in a workspace. It provides programmatic management of user identities and their workspace access, ...

Databricks Dashboards API

The Databricks Dashboards API allows you to create, update, list, and delete legacy SQL dashboards. Dashboards provide visual representations of query results, enabling business...

Databricks Model Registry API

The Databricks Model Registry API provides the workspace model registry for managing the full lifecycle of ML models. It enables creating registered models, managing model versi...

Databricks Workspace Bindings API

The Databricks Workspace Bindings API allows you to manage the binding of Unity Catalog securables to specific workspaces. It enables configuring whether catalogs and other obje...

Databricks System Schemas API

The Databricks System Schemas API allows you to enable, disable, and list system schemas within a metastore. System schemas contain system tables that provide operational data a...

Databricks Table Constraints API

The Databricks Table Constraints API allows you to create and delete primary key and foreign key constraints on Unity Catalog tables. Table constraints define relationships betw...

SQL Serverless: ~$0.70/DBU (infra included)

Serverless Jobs: $0.35-$0.40/DBU

Editions: Standard (Azure legacy), Premium (default), Enterprise (AWS)

Multi-cloud: AWS, Azure, GCP

REST API: 30 req/sec default, 10 req/sec for jobs/run-now

DBSQL Statement Execution API

Unity Catalog for governance

Delta Lake table format

Mosaic AI / MLflow for ML lifecycle

Genie / AI/BI for natural-language analytics

Workflows for orchestration

Lakeflow Connect for data ingestion

Model Serving for low-latency inference

Committed Use Contracts for volume discounts

Use Cases

Data Engineering

Build and orchestrate ETL pipelines with Delta Live Tables and multi-task workflows.

Data Warehousing

Run analytical SQL queries on lakehouse data with serverless SQL warehouses.

Machine Learning

Train, track, and deploy ML models with MLflow experiment tracking and model registry.

Real-Time Analytics

Process streaming data with structured streaming and serve results through online tables.

Data Governance

Govern data assets across the organization with Unity Catalog metadata management.

Semantic Vocabularies

Databricks Context

0 classes · 0 properties

JSON-LD

API Governance Rules

Databricks API Rules

7 rules · 7 errors

8 properties

GitHubOrganization

Terraform Provider

SDKs

🔗

MLflow API Reference

Sources

opencollection: 1.0.0
info:
  name: Databricks REST API
  version: 2.1.0
request:
  auth:
    type: bearer
    token: '{{bearerToken}}'
items:
- info:
    name: Clusters
    type: folder
  items:
  - info:
      name: Databricks Create a New Cluster
      type: http
    http:
      method: POST
      url: https://{workspace_host}/api/2.0/clusters/create
      body:
        type: json
        data: '{}'
    docs: Creates a new Spark cluster. This method acquires new instances from the cloud provider and starts the Spark driver
      and worker processes. The cluster is created asynchronously; use the cluster_id returned to poll for status.
  - info:
      name: Databricks List All Clusters
      type: http
    http:
      method: GET
      url: https://{workspace_host}/api/2.0/clusters/list
      params:
      - name: can_use_client
        value: example_value
        type: query
        description: Filter clusters by client compatibility.
    docs: Returns information about all clusters in the workspace, including terminated clusters. Clusters are ordered by
      cluster_id.
  - info:
      name: Databricks Get Cluster Details
      type: http
    http:
      method: GET
      url: https://{workspace_host}/api/2.0/clusters/get
      params:
      - name: cluster_id
        value: '500123'
        type: query
        description: The unique identifier of the cluster.
    docs: Retrieves detailed information about a cluster, including its current state, configuration, and runtime properties.
  - info:
      name: Databricks Start a Terminated Cluster
      type: http
    http:
      method: POST
      url: https://{workspace_host}/api/2.0/clusters/start
      body:
        type: json
        data: '{}'
    docs: Starts a terminated cluster given its cluster_id. This is similar to creating a cluster except it uses the configuration
      of the previously terminated cluster.
  - info:
      name: Databricks Restart a Cluster
      type: http
    http:
      method: POST
      url: https://{workspace_host}/api/2.0/clusters/restart
      body:
        type: json
        data: '{}'
    docs: Restarts a Spark cluster given its cluster_id. If the cluster is not in a RUNNING state, nothing happens.
  - info:
      name: Databricks Terminate a Cluster
      type: http
    http:
      method: POST
      url: https://{workspace_host}/api/2.0/clusters/delete
      body:
        type: json
        data: '{}'
    docs: Terminates a Spark cluster given its cluster_id. The cluster is removed after being terminated. Use the permanent-delete
      endpoint if you want to remove the cluster configuration entirely.
  - info:
      name: Databricks Permanently Delete a Cluster
      type: http
    http:
      method: POST
      url: https://{workspace_host}/api/2.0/clusters/permanent-delete
      body:
        type: json
        data: '{}'
    docs: Permanently deletes a Spark cluster. If the cluster is running, it is terminated and resources are asynchronously
      removed. If the cluster is terminated, it is immediately removed. A cluster can only be permanently deleted by an admin
      or the cluster creator.
  - info:
      name: Databricks Edit Cluster Configuration
      type: http
    http:
      method: POST
      url: https://{workspace_host}/api/2.0/clusters/edit
      body:
        type: json
        data: '{}'
    docs: Edits the configuration of a cluster to match the provided attributes. The cluster must be in a RUNNING or TERMINATED
      state. If the cluster is running, it will be restarted to apply the changes.
  - info:
      name: Databricks List Cluster Events
      type: http
    http:
      method: POST
      url: https://{workspace_host}/api/2.0/clusters/events
      body:
        type: json
        data: '{}'
    docs: Retrieves a list of events about the activity of a cluster. Events are returned in reverse chronological order.
      This endpoint can be used to audit cluster activity and monitor lifecycle changes.
- info:
    name: Jobs
    type: folder
  items:
  - info:
      name: Databricks Create a New Job
      type: http
    http:
      method: POST
      url: https://{workspace_host}/api/2.1/jobs/create
      body:
        type: json
        data: '{}'
    docs: Creates a new job with the provided settings. The job can be configured with a single task or multiple tasks with
      dependencies forming a directed acyclic graph (DAG).
  - info:
      name: Databricks List All Jobs
      type: http
    http:
      method: GET
      url: https://{workspace_host}/api/2.1/jobs/list
      params:
      - name: limit
        value: '10'
        type: query
        description: The number of jobs to return. This value must be greater than 0 and less than or equal to 25. The default
          value is 20.
      - name: offset
        value: '10'
        type: query
        description: The offset of the first job to return.
      - name: name
        value: Example Title
        type: query
        description: A filter on the list based on the exact (case-insensitive) job name.
      - name: expand_tasks
        value: 'true'
        type: query
        description: Whether to include task and cluster details in the response.
    docs: Retrieves a list of jobs in the workspace. Results are paginated and can be filtered by name.
  - info:
      name: Databricks Get a Job
      type: http
    http:
      method: GET
      url: https://{workspace_host}/api/2.1/jobs/get
      params:
      - name: job_id
        value: '500123'
        type: query
        description: The canonical identifier of the job to retrieve.
    docs: Retrieves the details of a single job, including its settings, creator, and run history summary.
  - info:
      name: Databricks Partially Update a Job
      type: http
    http:
      method: POST
      url: https://{workspace_host}/api/2.1/jobs/update
      body:
        type: json
        data: '{}'
    docs: Add, update, or remove specific settings of an existing job. Use reset to overwrite all settings.
  - info:
      name: Databricks Delete a Job
      type: http
    http:
      method: POST
      url: https://{workspace_host}/api/2.1/jobs/delete
      body:
        type: json
        data: '{}'
    docs: Deletes a job and all its associated runs. The job is permanently removed and cannot be recovered.
  - info:
      name: Databricks Trigger a Job Run
      type: http
    http:
      method: POST
      url: https://{workspace_host}/api/2.1/jobs/run-now
      body:
        type: json
        data: '{}'
    docs: Triggers an immediate run of a job. One run is triggered for each call. Runs triggered by run-now are considered
      triggered runs. Parameters can be passed to override the job defaults.
  - info:
      name: Databricks List Job Runs
      type: http
    http:
      method: GET
      url: https://{workspace_host}/api/2.1/jobs/runs/list
      params:
      - name: job_id
        value: '500123'
        type: query
        description: The job for which to list runs. If omitted, lists runs for all jobs.
      - name: active_only
        value: 'true'
        type: query
        description: If true, only active runs are included in the results; otherwise lists both active and completed runs.
      - name: completed_only
        value: 'true'
        type: query
        description: If true, only completed runs are included in the results.
      - name: offset
        value: '10'
        type: query
        description: The offset of the first run to return.
      - name: limit
        value: '10'
        type: query
        description: The number of runs to return (max 25).
      - name: run_type
        value: JOB_RUN
        type: query
        description: The type of runs to return.
      - name: expand_tasks
        value: 'true'
        type: query
        description: Whether to include task details in each run.
      - name: start_time_from
        value: '10'
        type: query
        description: Filter runs started after this time (epoch milliseconds).
      - name: start_time_to
        value: '10'
        type: query
        description: Filter runs started before this time (epoch milliseconds).
    docs: Lists runs from most recently started to least. Results are paginated. Runs can be filtered by job, active state,
      and completion status.
  - info:
      name: Databricks Get a Job Run
      type: http
    http:
      method: GET
      url: https://{workspace_host}/api/2.1/jobs/runs/get
      params:
      - name: run_id
        value: '500123'
        type: query
        description: The canonical identifier of the run.
      - name: include_history
        value: 'true'
        type: query
        description: Whether to include the repair history in the response.
      - name: include_resolved_values
        value: 'true'
        type: query
        description: Whether to include resolved parameter values in the response.
    docs: Retrieves the metadata of a run, including start time, end time, status, and task details.
  - info:
      name: Databricks Cancel a Job Run
      type: http
    http:
      method: POST
      url: https://{workspace_host}/api/2.1/jobs/runs/cancel
      body:
        type: json
        data: '{}'
    docs: Cancels an active run. The run is canceled asynchronously, and the request returns immediately. The canceled run
      transitions to a TERMINATING state.
  - info:
      name: Databricks Get Run Output
      type: http
    http:
      method: GET
      url: https://{workspace_host}/api/2.1/jobs/runs/get-output
      params:
      - name: run_id
        value: '500123'
        type: query
        description: The canonical identifier of the run.
    docs: Retrieves the output and metadata of a single task run. This endpoint can be used for notebook, JAR, Python, and
      Spark submit task outputs.
- info:
    name: Workspace
    type: folder
  items:
  - info:
      name: Databricks List Workspace Objects
      type: http
    http:
      method: GET
      url: https://{workspace_host}/api/2.0/workspace/list
      params:
      - name: path
        value: example_value
        type: query
        description: The absolute path of the workspace directory to list. Must start with /.
      - name: notebooks_modified_after
        value: '10'
        type: query
        description: If provided, only notebooks modified after this timestamp (epoch seconds) are returned.
    docs: Lists the contents of a directory in the workspace, or the object if it is not a directory. If the input path does
      not exist, a RESOURCE_DOES_NOT_EXIST error is returned.
  - info:
      name: Databricks Get Workspace Object Status
      type: http
    http:
      method: GET
      url: https://{workspace_host}/api/2.0/workspace/get-status
      params:
      - name: path
        value: example_value
        type: query
        description: The absolute path of the workspace object. Must start with /.
    docs: Gets the status of an object or a directory in the workspace. If the object does not exist, a RESOURCE_DOES_NOT_EXIST
      error is returned.
  - info:
      name: Databricks Export a Workspace Object
      type: http
    http:
      method: GET
      url: https://{workspace_host}/api/2.0/workspace/export
      params:
      - name: path
        value: example_value
        type: query
        description: The absolute path of the object or directory to export. Must start with /.
      - name: format
        value: SOURCE
        type: query
        description: The format in which to export the notebook. The default is SOURCE.
      - name: direct_download
        value: 'true'
        type: query
        description: Whether to download the file directly. If true, the response is the exported content.
    docs: Exports a notebook or the contents of an entire directory. Notebooks can be exported in SOURCE, HTML, JUPYTER, or
      DBC format.
  - info:
      name: Databricks Import a Workspace Object
      type: http
    http:
      method: POST
      url: https://{workspace_host}/api/2.0/workspace/import
      body:
        type: json
        data: '{}'
    docs: Imports a notebook or the contents of an entire directory. If the object already exists and overwrite is set to
      false, a RESOURCE_ALREADY_EXISTS error is returned.
  - info:
      name: Databricks Delete a Workspace Object
      type: http
    http:
      method: POST
      url: https://{workspace_host}/api/2.0/workspace/delete
      body:
        type: json
        data: '{}'
    docs: Deletes an object or a directory and optionally all of its contents. If the path does not exist, a RESOURCE_DOES_NOT_EXIST
      error is returned. If path is a non-empty directory and recursive is false, a DIRECTORY_NOT_EMPTY error is returned.
  - info:
      name: Databricks Create a Directory
      type: http
    http:
      method: POST
      url: https://{workspace_host}/api/2.0/workspace/mkdirs
      body:
        type: json
        data: '{}'
    docs: Creates the given directory and necessary parent directories if they do not exist. If there is an object (not a
      directory) at any prefix of the input path, a RESOURCE_ALREADY_EXISTS error is returned.
bundled: true

Databricks

Agent Skills showing 24 of 26