Skip to main content
PUT
/
pipelines
/
{pipeline_id}
Update Existing Pipeline
curl --request PUT \
  --url https://api.streamkap.com/pipelines/{pipeline_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "destination": {
    "connector": "<string>",
    "name": "<string>",
    "id": "<string>"
  },
  "source": {
    "connector": "<string>",
    "name": "<string>",
    "id": "<string>",
    "topics": [
      "<string>"
    ]
  },
  "tags": [
    "<string>"
  ],
  "transforms": [
    {
      "topic_id": "<string>"
    }
  ],
  "periodic_audit": {
    "topics": [
      "<string>"
    ],
    "timestamp_column": "<string>",
    "interval_minutes": 123,
    "fix_deletes_only": false
  },
  "topic_auto_discovery_transforms": []
}
'
import requests

url = "https://api.streamkap.com/pipelines/{pipeline_id}"

payload = {
"name": "<string>",
"destination": {
"connector": "<string>",
"name": "<string>",
"id": "<string>"
},
"source": {
"connector": "<string>",
"name": "<string>",
"id": "<string>",
"topics": ["<string>"]
},
"tags": ["<string>"],
"transforms": [{ "topic_id": "<string>" }],
"periodic_audit": {
"topics": ["<string>"],
"timestamp_column": "<string>",
"interval_minutes": 123,
"fix_deletes_only": False
},
"topic_auto_discovery_transforms": []
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
destination: {connector: '<string>', name: '<string>', id: '<string>'},
source: {connector: '<string>', name: '<string>', id: '<string>', topics: ['<string>']},
tags: ['<string>'],
transforms: [{topic_id: '<string>'}],
periodic_audit: {
topics: ['<string>'],
timestamp_column: '<string>',
interval_minutes: 123,
fix_deletes_only: false
},
topic_auto_discovery_transforms: []
})
};

fetch('https://api.streamkap.com/pipelines/{pipeline_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.streamkap.com/pipelines/{pipeline_id}",
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([
'name' => '<string>',
'destination' => [
'connector' => '<string>',
'name' => '<string>',
'id' => '<string>'
],
'source' => [
'connector' => '<string>',
'name' => '<string>',
'id' => '<string>',
'topics' => [
'<string>'
]
],
'tags' => [
'<string>'
],
'transforms' => [
[
'topic_id' => '<string>'
]
],
'periodic_audit' => [
'topics' => [
'<string>'
],
'timestamp_column' => '<string>',
'interval_minutes' => 123,
'fix_deletes_only' => false
],
'topic_auto_discovery_transforms' => [

]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$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 := "https://api.streamkap.com/pipelines/{pipeline_id}"

payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"destination\": {\n \"connector\": \"<string>\",\n \"name\": \"<string>\",\n \"id\": \"<string>\"\n },\n \"source\": {\n \"connector\": \"<string>\",\n \"name\": \"<string>\",\n \"id\": \"<string>\",\n \"topics\": [\n \"<string>\"\n ]\n },\n \"tags\": [\n \"<string>\"\n ],\n \"transforms\": [\n {\n \"topic_id\": \"<string>\"\n }\n ],\n \"periodic_audit\": {\n \"topics\": [\n \"<string>\"\n ],\n \"timestamp_column\": \"<string>\",\n \"interval_minutes\": 123,\n \"fix_deletes_only\": false\n },\n \"topic_auto_discovery_transforms\": []\n}")

req, _ := http.NewRequest("PUT", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
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("https://api.streamkap.com/pipelines/{pipeline_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"destination\": {\n \"connector\": \"<string>\",\n \"name\": \"<string>\",\n \"id\": \"<string>\"\n },\n \"source\": {\n \"connector\": \"<string>\",\n \"name\": \"<string>\",\n \"id\": \"<string>\",\n \"topics\": [\n \"<string>\"\n ]\n },\n \"tags\": [\n \"<string>\"\n ],\n \"transforms\": [\n {\n \"topic_id\": \"<string>\"\n }\n ],\n \"periodic_audit\": {\n \"topics\": [\n \"<string>\"\n ],\n \"timestamp_column\": \"<string>\",\n \"interval_minutes\": 123,\n \"fix_deletes_only\": false\n },\n \"topic_auto_discovery_transforms\": []\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.streamkap.com/pipelines/{pipeline_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"destination\": {\n \"connector\": \"<string>\",\n \"name\": \"<string>\",\n \"id\": \"<string>\"\n },\n \"source\": {\n \"connector\": \"<string>\",\n \"name\": \"<string>\",\n \"id\": \"<string>\",\n \"topics\": [\n \"<string>\"\n ]\n },\n \"tags\": [\n \"<string>\"\n ],\n \"transforms\": [\n {\n \"topic_id\": \"<string>\"\n }\n ],\n \"periodic_audit\": {\n \"topics\": [\n \"<string>\"\n ],\n \"timestamp_column\": \"<string>\",\n \"interval_minutes\": 123,\n \"fix_deletes_only\": false\n },\n \"topic_auto_discovery_transforms\": []\n}"

response = http.request(request)
puts response.read_body
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

pipeline_id
string | null
required

Query Parameters

secret_returned
boolean
default:false

Whether to include secret values in the response

wait
boolean
default:true

When False, defer destination config update to reconciler instead of calling KC directly

Body

application/json
name
string
required
destination
PipelineDestinationConnector · object
required
source
PipelineSourceConnector · object
required
tags
string[]
required
transforms
PipelineTransformConnector · object[] | null
periodic_audit
UpdatePipelineAuditReq · object | null

Update pipeline audit request.

topic_auto_discovery_transforms
TopicAutoDiscoveryTransform · object[]

Response

Successful Response