curl --request GET \
--url http://localhost:8080/api/v1/catalog/{name}/export \
--header 'x-api-key: <api-key>'import requests
url = "http://localhost:8080/api/v1/catalog/{name}/export"
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/catalog/{name}/export', 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/catalog/{name}/export",
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/catalog/{name}/export"
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/catalog/{name}/export")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/api/v1/catalog/{name}/export")
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"<string>"Export a catalog as a zip backup
Downloads one zip archive of the catalog: manifest.json, taps/<name>.json (run status, ownership, timestamps and script references cleared), taps/<name>.py (each Python tap’s script), taps/<name>.state.json (incremental state, when the tap has any), pipelines/<name>.json, pipelines/<name>/validation-schema/<file> (a referenced validation schema) and pipelines/<name>/codegen/<kind>.py (CodeGen scripts, reference copies only). Placeholders are never exported. Secret values are never in the archive: manifest.requiredSecrets lists each secret name, the items using it and its type. manifest.warnings names members the key may not read (omitted from the archive, never a 403 for the whole export), scripts or schemas that could not be read, taps whose state was included, and install-specific values copied verbatim (object-store endpoint, bucket override, warehouse, absolute s3:// validation schema), and every inline credential removed from a pipeline (preprocessor and REST destination bearerToken/apiKey, restEndpoint row-function token parameters). The manifest carries formatVersion: 1. Requires pipeline:read; each member is also checked against the key’s owner and catalog scopes as tap:read / pipeline:read.
curl --request GET \
--url http://localhost:8080/api/v1/catalog/{name}/export \
--header 'x-api-key: <api-key>'import requests
url = "http://localhost:8080/api/v1/catalog/{name}/export"
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/catalog/{name}/export', 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/catalog/{name}/export",
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/catalog/{name}/export"
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/catalog/{name}/export")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/api/v1/catalog/{name}/export")
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"<string>"Authorizations
Optional API key for authentication (enabled via application.yaml)
Path Parameters
Catalog name. Uncataloged (any case) is refused.
Response
The archive. Content-Disposition is attachment; filename="<name>-<yyyyMMdd-HHmm>.zip".
The response is of type file.
