curl --request PUT \
--url http://localhost:8080/api/v1/catalog/{name} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"newName": "<string>"
}
'import requests
url = "http://localhost:8080/api/v1/catalog/{name}"
payload = { "newName": "<string>" }
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({newName: '<string>'})
};
fetch('http://localhost:8080/api/v1/catalog/{name}', 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}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'newName' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:8080/api/v1/catalog/{name}"
payload := strings.NewReader("{\n \"newName\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("http://localhost:8080/api/v1/catalog/{name}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"newName\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/api/v1/catalog/{name}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"newName\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"renamed": [
"<string>"
],
"failed": [
{
"name": "<string>",
"error": "<string>"
}
],
"affectedKeys": [
"<string>"
],
"placeholder": "created"
}{
"renamed": [
"<string>"
],
"failed": [
{
"name": "<string>",
"error": "<string>"
}
],
"affectedKeys": [
"<string>"
],
"placeholder": "created"
}{
"error": "Catalog 'sales' already exists. Use move to merge catalogs."
}Rename a catalog
Relabels every tap and pipeline whose catalog equals name to newName, each through a versioned write (one new definition version per member, with a change note naming the rename and the actor). Every hidden placeholder of the catalog (a __catalog__* tap whose catalog field is name, or whose name suffix is name when that field is empty) is removed, and __catalog__<newName> is created with catalog=newName. A member already moved out of name by a concurrent change is listed under failed (“no longer in catalog”), and placeholders are left untouched when no member moved. A rename never merges: if newName already exists (any tap or pipeline carries it, or it has a placeholder; matched case-sensitively) the request is refused with 409 and nothing changes. To combine catalogs, move their items. Not transactional: members that fail are listed under failed and the rest still move (207). API keys whose capabilities are scoped catalog=<name> are listed under affectedKeys; their scopes are not rewritten. Catalog operations (rename, detach, cascade) are serialized server-side, so concurrent requests run one after another and the later one sees the earlier one’s result. Requires pipeline:update; each member is also checked against the key’s owner and catalog scopes. If any member is refused by scope, placeholders are left untouched (placeholder: skipped); for a catalog with only a placeholder, the placeholder is scope-checked (403 on denial).
curl --request PUT \
--url http://localhost:8080/api/v1/catalog/{name} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"newName": "<string>"
}
'import requests
url = "http://localhost:8080/api/v1/catalog/{name}"
payload = { "newName": "<string>" }
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({newName: '<string>'})
};
fetch('http://localhost:8080/api/v1/catalog/{name}', 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}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'newName' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:8080/api/v1/catalog/{name}"
payload := strings.NewReader("{\n \"newName\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("http://localhost:8080/api/v1/catalog/{name}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"newName\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/api/v1/catalog/{name}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"newName\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"renamed": [
"<string>"
],
"failed": [
{
"name": "<string>",
"error": "<string>"
}
],
"affectedKeys": [
"<string>"
],
"placeholder": "created"
}{
"renamed": [
"<string>"
],
"failed": [
{
"name": "<string>",
"error": "<string>"
}
],
"affectedKeys": [
"<string>"
],
"placeholder": "created"
}{
"error": "Catalog 'sales' already exists. Use move to merge catalogs."
}Authorizations
Optional API key for authentication (enabled via application.yaml)
Path Parameters
Current catalog name. Uncataloged (any case) is refused.
Body
New catalog name (letters, digits, _ and -; mixed case allowed). Catalog names are matched case-sensitively.
^[A-Za-z0-9_-]+$