Rename a pipeline
curl --request POST \
--url http://localhost:8080/api/v1/pipelines/{name}/rename \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"newName": "<string>"
}
'import requests
url = "http://localhost:8080/api/v1/pipelines/{name}/rename"
payload = { "newName": "<string>" }
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({newName: '<string>'})
};
fetch('http://localhost:8080/api/v1/pipelines/{name}/rename', 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/pipelines/{name}/rename",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
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/pipelines/{name}/rename"
payload := strings.NewReader("{\n \"newName\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", 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.post("http://localhost:8080/api/v1/pipelines/{name}/rename")
.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/pipelines/{name}/rename")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.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{
"name": "<string>",
"previousName": "<string>",
"version": 123,
"repointedTaps": [
"<string>"
],
"failed": [
{
"name": "<string>",
"error": "<string>"
}
],
"warnings": [
"<string>"
]
}{
"name": "<string>",
"previousName": "<string>",
"version": 123,
"repointedTaps": [
"<string>"
],
"failed": [
{
"name": "<string>",
"error": "<string>"
}
],
"warnings": [
"<string>"
]
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}Pipelines
Rename a pipeline
Changes the pipeline’s name and nothing else: destination data is not touched, definition versions and stored CodeGen scripts (with their history) move to the new name, an incremental pull keeps its position, and every tap whose targetPipeline is the old name is re-pointed (taps the caller cannot see are re-pointed but never named). Needs the access a delete needs (own on the pipeline’s catalog, or pipeline:delete for an API key). A rename that stopped part way is finished by sending it again. Audited as pipeline / rename on the old name with newName in the metadata. A caller who cannot see every pipeline gets the taken-name 409 for a new name that a pipeline hidden from it had before it was renamed (previousNames).
POST
/
api
/
v1
/
pipelines
/
{name}
/
rename
Rename a pipeline
curl --request POST \
--url http://localhost:8080/api/v1/pipelines/{name}/rename \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"newName": "<string>"
}
'import requests
url = "http://localhost:8080/api/v1/pipelines/{name}/rename"
payload = { "newName": "<string>" }
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({newName: '<string>'})
};
fetch('http://localhost:8080/api/v1/pipelines/{name}/rename', 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/pipelines/{name}/rename",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
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/pipelines/{name}/rename"
payload := strings.NewReader("{\n \"newName\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", 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.post("http://localhost:8080/api/v1/pipelines/{name}/rename")
.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/pipelines/{name}/rename")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.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{
"name": "<string>",
"previousName": "<string>",
"version": 123,
"repointedTaps": [
"<string>"
],
"failed": [
{
"name": "<string>",
"error": "<string>"
}
],
"warnings": [
"<string>"
]
}{
"name": "<string>",
"previousName": "<string>",
"version": 123,
"repointedTaps": [
"<string>"
],
"failed": [
{
"name": "<string>",
"error": "<string>"
}
],
"warnings": [
"<string>"
]
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}Authorizations
Response
Renamed
