Databricks SQL API reference
The Databricks SQL REST API supports services to manage queries and dashboards, query history, and SQL endpoints.
This article provides an overview of how to use the REST API. Links to each API reference are listed at the end of the article.
For information about authenticating to the REST API using personal access tokens, see Authentication using Azure Databricks personal access tokens in Databricks SQL.
For information about authenticating to the REST API using Azure Active Directory tokens, see Authenticate using Azure Active Directory tokens. For examples, see Use an Azure AD access token for a user and Use an Azure AD access token for a service principal.
Databricks SQL is not available in Azure China regions.
The Databricks REST API supports a maximum of 30 requests/second per workspace. Requests that exceed the rate limit will receive a 429 response status code.
It can be useful to parse out parts of the JSON output. In these cases, we recommend that you to use the utility
jq. For more information, see the jq Manual. You can install
jq on MacOS using Homebrew by running
brew install jq.
STRING fields (which contain error and descriptive messaging intended to be consumed by the UI) are unstructured, and you should not depend on the format of these fields in programmatic workflows.
Invoke a GET using a query string
While most API calls require that you specify a JSON body, for
GET calls you can specify the object to be retrieved. For example, to get the details for a SQL endpoint, run:
curl ... https://<databricks-instance>/api/2.0/sql/endpoints/<endpoint-id>
Authenticate to Databricks SQL APIs
Databricks SQL APIs
Submit and view feedback for