Databricks Query History, How to get "OpenAPI specification"?

Question

Mohammad Saber 591

Hi

I am trying to get Query History following the documentation.

I don't understand the explanations about OpenAPI specification. There is a file that we can download but it seems that it is a sample file.

How can I get the OpenAPI specification for the workspace or SQL warehouse that I am using?

PRADEEPCHEEKATLA 90,641 Reputation points Moderator

2023-02-27T07:13:55.4166667+00:00

@Mohammad Saber Just checking in to see if the below answer helped. If this answers your query, do click Accept Answer and Yes for was this answer helpful. And, if you have any further query do let us know.
PRADEEPCHEEKATLA 90,641 Reputation points Moderator

2023-03-02T03:17:39.7266667+00:00

@Mohammad Saber @Mohammad Saber Glad to know that the below response was helpful. Thank you for marking this answer as accepted. This will help others find useful answers faster.

Please feel free to take a survey on the relevant answer. You can help us improve by leaving feedback verbatim.

Have a good day!

Regards,

PRADEEPCHEEKATLA-MSFT

Accepted answer

0 additional answers

PRADEEPCHEEKATLA 90,641 Reputation points Moderator

2023-02-27T07:13:55.4166667+00:00

@Mohammad Saber Just checking in to see if the below answer helped. If this answers your query, do click Accept Answer and Yes for was this answer helpful. And, if you have any further query do let us know.
PRADEEPCHEEKATLA 90,641 Reputation points Moderator

2023-03-02T03:17:39.7266667+00:00

@Mohammad Saber @Mohammad Saber Glad to know that the below response was helpful. Thank you for marking this answer as accepted. This will help others find useful answers faster.

Please feel free to take a survey on the relevant answer. You can help us improve by leaving feedback verbatim.

Have a good day!

Regards,

PRADEEPCHEEKATLA-MSFT

Answer 1

PRADEEPCHEEKATLA 90,641 Moderator

@Mohammad Saber Thanks for the question and using MS Q&A platform.

Once you have downloaded the OpenAPI specification - you can view the results using Redocly, Postman, or Swagger Editor.

If you have the databricks url and PAT you can easily call the Databricks SQL REST API.

https://<databricks-instance>/api/2.0/preview/sql/queries

Accessing the Databricks SQL REST API:

User's image

Accessing the Databricks SQL REST API using the OpenAPI specification:

ADB-SQL-Query-OpenAPINew

For more details, refer to Databricks SQL API reference and Queries, Dashboards, and Alerts API
Hope this helps. Do let us know if you any further queries.

If this answers your query, do click Accept Answer and Yes for was this answer helpful. And, if you have any further query do let us know.