topic Re: API Definition File in Data Engineering

API Definition File

jtjohnson — Thu, 01 May 2025 17:14:16 GMT

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 🙂

Re: API Definition File

lingareddy_Alva — Thu, 01 May 2025 17:25:08 GMT

@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

Re: API Definition File

jtjohnson — Thu, 01 May 2025 18:41:40 GMT

Thank you for the feedback. The postman collection would be ideal but the link is a no longer active 😞

Re: API Definition File

lingareddy_Alva — Thu, 01 May 2025 19:52:37 GMT

@jtjohnson

yes, i tried

Re: API Definition File

CasonAshby — Wed, 07 May 2025 10:13:49 GMT

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