Azure Databricks REST API reference

This reference contains information about the Azure Databricks application programming interfaces (APIs). Each API reference page is presented primarily from a representational state transfer (REST) perspective.
Azure Databricks REST API calls typically include the following components:
  • The workspace instance name of your Azure Databricks deployment.
  • The REST API operation type, such as GET, POST, PATCH, or DELETE.
  • The REST API operation path, such as /api/2.0/clusters/get, to get information for the specified cluster.
  • Azure Databricks authentication information, such as an Azure Databricks personal access token.
  • Any request payload or request query parameters that are supported by the REST API operation, such as a cluster's ID.
Azure Databricks REST API calls typically return a response payload that contains information about the request, such as a cluster's settings. These response payloads are typically in JSON format.
For instance, the following curl command requests information about the cluster with the specified cluster ID. In this command, the local environment variables DATABRICKS_HOST and DATABRICKS_TOKEN represent the workspace instance name of your Azure Databricks deployment and your Azure Databricks personal access token value, respectively. To set local environment variables, see your operating system's documentation.
curl --request GET "https://${DATABRICKS_HOST}/api/2.0/clusters/get" \
     --header "Authorization: Bearer ${DATABRICKS_TOKEN}" \
     --data '{ "cluster_id": "1234-567890-a12bcde3" }'
The response payload contains contents similar to the following in JSON format. Some response payload fields are omitted here for brevity.
{
  "cluster_id": "1234-567890-a12bcde3",
  "creator_user_name": "someone@example.com",
  "...": "...",
  "cluster_name": "My New Cluster",
  "...": "...",
  "autotermination_minutes": 15,
  "...": "...",
  "state": "TERMINATED",
  "state_message": "Inactive cluster terminated (inactive for 15 minutes).",
  "...": "..."
}
For information about how to provide the preceding components to your preferred developer tool, as well as how to parse response payloads, see your provider's documentation. Azure Databricks developer tools such as the Azure Databricks command-line interface (CLI), the Azure Databricks software development kits (SDKs), and the Azure Databricks Terraform provider provide the preceding Azure Databricks REST API components within common command-line and programming language constructs.
This reference describes the types, paths, and any request payload or query parameters, for each supported Azure Databricks REST API operation. Many reference pages also provide request and response payload examples. Some reference pages also provide examples for calling an Azure Databricks REST API operation by using the Azure Databricks CLI, the Azure Databricks Terraform provider, or one or more of the Azure Databricks SDKs.

Rate limits

To ensure high quality of service under heavy load, Azure Databricks enforces rate limits for all REST API calls. Limits are set per endpoint and per workspace to ensure fair usage and high availability.
Requests that exceed the rate limit return a 429 response status code.