curl --request GET \
--url http://localhost:8080/api/v1/unity-catalog/browse \
--header 'x-api-key: <api-key>'import requests
url = "http://localhost:8080/api/v1/unity-catalog/browse"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('http://localhost:8080/api/v1/unity-catalog/browse', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/api/v1/unity-catalog/browse",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "http://localhost:8080/api/v1/unity-catalog/browse"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://localhost:8080/api/v1/unity-catalog/browse")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/api/v1/unity-catalog/browse")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"secret": "<string>",
"level": "catalogs",
"catalogs": [
"<string>"
],
"schemas": [
"<string>"
],
"tables": [
{
"name": "<string>",
"datrisPipeline": "<string>"
}
],
"columns": [
{
"name": "<string>",
"type": "<string>",
"comment": "<string>"
}
],
"tags": {},
"tagsAvailable": true,
"datrisPipeline": "<string>"
}Browse Unity Catalog with a Databricks Platform secret
Read-only walk of what a Databricks Platform secret can see, one level per call: no catalog lists catalogs; catalog lists schemas; catalog + schema lists tables (tables tagged datris_pipeline carry datrisPipeline); adding table returns columns (name, type, comment) and tags. Catalog and schema listings are cached for 5 minutes per secret. Requires metadata:read plus read access to the named secret. Every call is audit-logged as unity-catalog / browse. The SQL warehouse is the warehouse param, else the secret’s optional warehouse field (aliases httpPath, http_path, DATABRICKS_WAREHOUSE), else the warehouse of the first Databricks pipeline using the secret.
curl --request GET \
--url http://localhost:8080/api/v1/unity-catalog/browse \
--header 'x-api-key: <api-key>'import requests
url = "http://localhost:8080/api/v1/unity-catalog/browse"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('http://localhost:8080/api/v1/unity-catalog/browse', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/api/v1/unity-catalog/browse",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "http://localhost:8080/api/v1/unity-catalog/browse"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://localhost:8080/api/v1/unity-catalog/browse")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/api/v1/unity-catalog/browse")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"secret": "<string>",
"level": "catalogs",
"catalogs": [
"<string>"
],
"schemas": [
"<string>"
],
"tables": [
{
"name": "<string>",
"datrisPipeline": "<string>"
}
],
"columns": [
{
"name": "<string>",
"type": "<string>",
"comment": "<string>"
}
],
"tags": {},
"tagsAvailable": true,
"datrisPipeline": "<string>"
}Authorizations
Optional API key for authentication (enabled via application.yaml)
Query Parameters
Name of a Platform secret holding Databricks credentials
SQL warehouse ID, HTTP path, or JDBC URL
Requires catalog
Requires catalog and schema
Response
One level of the Unity Catalog tree
