cancel
Showing results forย 
Search instead forย 
Did you mean:ย 
Data Engineering
Join discussions on data engineering best practices, architectures, and optimization strategies within the Databricks Community. Exchange insights and solutions with fellow data engineers.
cancel
Showing results forย 
Search instead forย 
Did you mean:ย 

API Definition File

jtjohnson
New Contributor II

Hello. We are in the process of setting up Azure APIM to Databricks Rest API(s). Is there an official definition file available for download?

Any help would be greatly appreciated ๐Ÿ™‚

4 REPLIES 4

lingareddy_Alva
Honored Contributor II

@jtjohnson 

I dont think Databricks does currently provide an official OpenAPI (Swagger) definition file for its REST APIs. However,
here are your options to integrate Databricks REST APIs with Azure API Management (APIM):

Options for Integration:

1. Manually define APIs in APIM
You can manually create REST operations in Azure APIM based on the [Databricks REST API documentation](https://docs.databricks.com/api/latest/index.html).

2. Use Postman Collections
Databricks provides official [Postman collections](https://github.com/databricks/postman-databricks) for REST APIs. You can export these and convert them into OpenAPI format using tools like:
- [Postman-to-OpenAPI](https://github.com/joolfe/postman-to-openapi)

3. Third-party Swagger generation tools
Some users use tools like SwaggerHub, Stoplight, or Insomnia to model the Databricks APIs and export OpenAPI 3.0 specs manually.

Authentication in APIM
Remember that Databricks APIs require either:
- Personal Access Tokens (PATs) or
- Azure AD tokens (for Azure Databricks)
Youโ€™ll likely need to set up header-based token injection or OAuth 2.0 flows in APIM policies

LR

It helped me, Thank you so much for the info.

jtjohnson
New Contributor II

Thank you for the feedback. The postman collection would be ideal but the link is a no longer active ๐Ÿ˜ž

lingareddy_Alva
Honored Contributor II

@jtjohnson 

yes, i tried

 

LR

Join Us as a Local Community Builder!

Passionate about hosting events and connecting people? Help us grow a vibrant local communityโ€”sign up today to get started!

Sign Up Now