Skip to main content
PUT
/
sources
/
{source_id}
Update Existing Source
curl --request PUT \
  --url https://api.streamkap.com/sources/{source_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "connector": "<string>",
  "config": {
    "database.hostname.user.defined": "<string>",
    "database.port.user.defined": "5432",
    "database.user": "<string>",
    "database.password": "<string>",
    "database.dbname": "<string>",
    "signal.data.collection.schema.or.database": "<string>",
    "slot.name": "streamkap_pgoutput_slot",
    "publication.name": "streamkap_pub",
    "schema.include.list": "<string>",
    "table.include.list.user.defined": "<string>",
    "ssh.host": "<string>",
    "ssh.port": "22",
    "ssh.user": "streamkap",
    "ssh.public.key.user.displayed": "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIJVbRrHqNN3SyIYnNF46SMd+ArZz+QheAtjnQzKiBWrc",
    "transforms.ValueToKey.fields.include.list": "<string>",
    "transforms.ValueToKey.replace.null.with.default": true,
    "preserve.null.values": false,
    "transforms.OversizedRecords.fields.include.list": "<string>",
    "transforms.OversizedRecords.fields.exclude.list": "<string>",
    "transforms.OversizedRecords.max.field.size.bytes": 1048576,
    "transforms.OversizedRecords.oversized.field.behavior": "TRUNCATE",
    "transforms.OversizedRecords.truncation.suffix": "",
    "transforms.OversizedRecords.max.record.size.bytes": -1,
    "transforms.OversizedRecords.semantic.types.exclude": "io.debezium.data.Json,io.debezium.data.Xml",
    "transforms.OversizedRecords.replace.null.with.default": true,
    "InsertTopicName.enabled": false,
    "snapshot.read.only.user.defined": "Yes",
    "column.include.list.toggled": true,
    "column.include.list.user.defined": "<string>",
    "column.exclude.list.user.defined": "<string>",
    "heartbeat.enabled": true,
    "heartbeat.data.collection.schema.or.database": "<string>",
    "post.processors": "reselector",
    "database.sslmode": "require",
    "include.source.db.name.in.table.name.user.defined": false,
    "binary.handling.mode": "bytes",
    "transforms.InsertStaticKey1.static.field": "<string>",
    "transforms.InsertStaticKey1.static.value": "<string>",
    "transforms.InsertStaticValue1.static.field": "<string>",
    "transforms.InsertStaticValue1.static.value": "<string>",
    "transforms.InsertStaticKey2.static.field": "<string>",
    "transforms.InsertStaticKey2.static.value": "<string>",
    "transforms.InsertStaticValue2.static.field": "<string>",
    "transforms.InsertStaticValue2.static.value": "<string>",
    "predicates.IsTopicToEnrich.pattern": "$^",
    "ssh.enabled": false
  },
  "kc_cluster_id": "<string>",
  "tags": [
    "<string>"
  ]
}
'
import requests

url = "https://api.streamkap.com/sources/{source_id}"

payload = {
    "name": "<string>",
    "connector": "<string>",
    "config": {
        "database.hostname.user.defined": "<string>",
        "database.port.user.defined": "5432",
        "database.user": "<string>",
        "database.password": "<string>",
        "database.dbname": "<string>",
        "signal.data.collection.schema.or.database": "<string>",
        "slot.name": "streamkap_pgoutput_slot",
        "publication.name": "streamkap_pub",
        "schema.include.list": "<string>",
        "table.include.list.user.defined": "<string>",
        "ssh.host": "<string>",
        "ssh.port": "22",
        "ssh.user": "streamkap",
        "ssh.public.key.user.displayed": "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIJVbRrHqNN3SyIYnNF46SMd+ArZz+QheAtjnQzKiBWrc",
        "transforms.ValueToKey.fields.include.list": "<string>",
        "transforms.ValueToKey.replace.null.with.default": True,
        "preserve.null.values": False,
        "transforms.OversizedRecords.fields.include.list": "<string>",
        "transforms.OversizedRecords.fields.exclude.list": "<string>",
        "transforms.OversizedRecords.max.field.size.bytes": 1048576,
        "transforms.OversizedRecords.oversized.field.behavior": "TRUNCATE",
        "transforms.OversizedRecords.truncation.suffix": "",
        "transforms.OversizedRecords.max.record.size.bytes": -1,
        "transforms.OversizedRecords.semantic.types.exclude": "io.debezium.data.Json,io.debezium.data.Xml",
        "transforms.OversizedRecords.replace.null.with.default": True,
        "InsertTopicName.enabled": False,
        "snapshot.read.only.user.defined": "Yes",
        "column.include.list.toggled": True,
        "column.include.list.user.defined": "<string>",
        "column.exclude.list.user.defined": "<string>",
        "heartbeat.enabled": True,
        "heartbeat.data.collection.schema.or.database": "<string>",
        "post.processors": "reselector",
        "database.sslmode": "require",
        "include.source.db.name.in.table.name.user.defined": False,
        "binary.handling.mode": "bytes",
        "transforms.InsertStaticKey1.static.field": "<string>",
        "transforms.InsertStaticKey1.static.value": "<string>",
        "transforms.InsertStaticValue1.static.field": "<string>",
        "transforms.InsertStaticValue1.static.value": "<string>",
        "transforms.InsertStaticKey2.static.field": "<string>",
        "transforms.InsertStaticKey2.static.value": "<string>",
        "transforms.InsertStaticValue2.static.field": "<string>",
        "transforms.InsertStaticValue2.static.value": "<string>",
        "predicates.IsTopicToEnrich.pattern": "$^",
        "ssh.enabled": False
    },
    "kc_cluster_id": "<string>",
    "tags": ["<string>"]
}
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>',
    connector: '<string>',
    config: {
      'database.hostname.user.defined': '<string>',
      'database.port.user.defined': '5432',
      'database.user': '<string>',
      'database.password': '<string>',
      'database.dbname': '<string>',
      'signal.data.collection.schema.or.database': '<string>',
      'slot.name': 'streamkap_pgoutput_slot',
      'publication.name': 'streamkap_pub',
      'schema.include.list': '<string>',
      'table.include.list.user.defined': '<string>',
      'ssh.host': '<string>',
      'ssh.port': '22',
      'ssh.user': 'streamkap',
      'ssh.public.key.user.displayed': 'ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIJVbRrHqNN3SyIYnNF46SMd+ArZz+QheAtjnQzKiBWrc',
      'transforms.ValueToKey.fields.include.list': '<string>',
      'transforms.ValueToKey.replace.null.with.default': true,
      'preserve.null.values': false,
      'transforms.OversizedRecords.fields.include.list': '<string>',
      'transforms.OversizedRecords.fields.exclude.list': '<string>',
      'transforms.OversizedRecords.max.field.size.bytes': 1048576,
      'transforms.OversizedRecords.oversized.field.behavior': 'TRUNCATE',
      'transforms.OversizedRecords.truncation.suffix': '',
      'transforms.OversizedRecords.max.record.size.bytes': -1,
      'transforms.OversizedRecords.semantic.types.exclude': 'io.debezium.data.Json,io.debezium.data.Xml',
      'transforms.OversizedRecords.replace.null.with.default': true,
      'InsertTopicName.enabled': false,
      'snapshot.read.only.user.defined': 'Yes',
      'column.include.list.toggled': true,
      'column.include.list.user.defined': '<string>',
      'column.exclude.list.user.defined': '<string>',
      'heartbeat.enabled': true,
      'heartbeat.data.collection.schema.or.database': '<string>',
      'post.processors': 'reselector',
      'database.sslmode': 'require',
      'include.source.db.name.in.table.name.user.defined': false,
      'binary.handling.mode': 'bytes',
      'transforms.InsertStaticKey1.static.field': '<string>',
      'transforms.InsertStaticKey1.static.value': '<string>',
      'transforms.InsertStaticValue1.static.field': '<string>',
      'transforms.InsertStaticValue1.static.value': '<string>',
      'transforms.InsertStaticKey2.static.field': '<string>',
      'transforms.InsertStaticKey2.static.value': '<string>',
      'transforms.InsertStaticValue2.static.field': '<string>',
      'transforms.InsertStaticValue2.static.value': '<string>',
      'predicates.IsTopicToEnrich.pattern': '$^',
      'ssh.enabled': false
    },
    kc_cluster_id: '<string>',
    tags: ['<string>']
  })
};

fetch('https://api.streamkap.com/sources/{source_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/sources/{source_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>',
    'connector' => '<string>',
    'config' => [
        'database.hostname.user.defined' => '<string>',
        'database.port.user.defined' => '5432',
        'database.user' => '<string>',
        'database.password' => '<string>',
        'database.dbname' => '<string>',
        'signal.data.collection.schema.or.database' => '<string>',
        'slot.name' => 'streamkap_pgoutput_slot',
        'publication.name' => 'streamkap_pub',
        'schema.include.list' => '<string>',
        'table.include.list.user.defined' => '<string>',
        'ssh.host' => '<string>',
        'ssh.port' => '22',
        'ssh.user' => 'streamkap',
        'ssh.public.key.user.displayed' => 'ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIJVbRrHqNN3SyIYnNF46SMd+ArZz+QheAtjnQzKiBWrc',
        'transforms.ValueToKey.fields.include.list' => '<string>',
        'transforms.ValueToKey.replace.null.with.default' => true,
        'preserve.null.values' => false,
        'transforms.OversizedRecords.fields.include.list' => '<string>',
        'transforms.OversizedRecords.fields.exclude.list' => '<string>',
        'transforms.OversizedRecords.max.field.size.bytes' => 1048576,
        'transforms.OversizedRecords.oversized.field.behavior' => 'TRUNCATE',
        'transforms.OversizedRecords.truncation.suffix' => '',
        'transforms.OversizedRecords.max.record.size.bytes' => -1,
        'transforms.OversizedRecords.semantic.types.exclude' => 'io.debezium.data.Json,io.debezium.data.Xml',
        'transforms.OversizedRecords.replace.null.with.default' => true,
        'InsertTopicName.enabled' => false,
        'snapshot.read.only.user.defined' => 'Yes',
        'column.include.list.toggled' => true,
        'column.include.list.user.defined' => '<string>',
        'column.exclude.list.user.defined' => '<string>',
        'heartbeat.enabled' => true,
        'heartbeat.data.collection.schema.or.database' => '<string>',
        'post.processors' => 'reselector',
        'database.sslmode' => 'require',
        'include.source.db.name.in.table.name.user.defined' => false,
        'binary.handling.mode' => 'bytes',
        'transforms.InsertStaticKey1.static.field' => '<string>',
        'transforms.InsertStaticKey1.static.value' => '<string>',
        'transforms.InsertStaticValue1.static.field' => '<string>',
        'transforms.InsertStaticValue1.static.value' => '<string>',
        'transforms.InsertStaticKey2.static.field' => '<string>',
        'transforms.InsertStaticKey2.static.value' => '<string>',
        'transforms.InsertStaticValue2.static.field' => '<string>',
        'transforms.InsertStaticValue2.static.value' => '<string>',
        'predicates.IsTopicToEnrich.pattern' => '$^',
        'ssh.enabled' => false
    ],
    'kc_cluster_id' => '<string>',
    'tags' => [
        '<string>'
    ]
  ]),
  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/sources/{source_id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"connector\": \"<string>\",\n  \"config\": {\n    \"database.hostname.user.defined\": \"<string>\",\n    \"database.port.user.defined\": \"5432\",\n    \"database.user\": \"<string>\",\n    \"database.password\": \"<string>\",\n    \"database.dbname\": \"<string>\",\n    \"signal.data.collection.schema.or.database\": \"<string>\",\n    \"slot.name\": \"streamkap_pgoutput_slot\",\n    \"publication.name\": \"streamkap_pub\",\n    \"schema.include.list\": \"<string>\",\n    \"table.include.list.user.defined\": \"<string>\",\n    \"ssh.host\": \"<string>\",\n    \"ssh.port\": \"22\",\n    \"ssh.user\": \"streamkap\",\n    \"ssh.public.key.user.displayed\": \"ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIJVbRrHqNN3SyIYnNF46SMd+ArZz+QheAtjnQzKiBWrc\",\n    \"transforms.ValueToKey.fields.include.list\": \"<string>\",\n    \"transforms.ValueToKey.replace.null.with.default\": true,\n    \"preserve.null.values\": false,\n    \"transforms.OversizedRecords.fields.include.list\": \"<string>\",\n    \"transforms.OversizedRecords.fields.exclude.list\": \"<string>\",\n    \"transforms.OversizedRecords.max.field.size.bytes\": 1048576,\n    \"transforms.OversizedRecords.oversized.field.behavior\": \"TRUNCATE\",\n    \"transforms.OversizedRecords.truncation.suffix\": \"\",\n    \"transforms.OversizedRecords.max.record.size.bytes\": -1,\n    \"transforms.OversizedRecords.semantic.types.exclude\": \"io.debezium.data.Json,io.debezium.data.Xml\",\n    \"transforms.OversizedRecords.replace.null.with.default\": true,\n    \"InsertTopicName.enabled\": false,\n    \"snapshot.read.only.user.defined\": \"Yes\",\n    \"column.include.list.toggled\": true,\n    \"column.include.list.user.defined\": \"<string>\",\n    \"column.exclude.list.user.defined\": \"<string>\",\n    \"heartbeat.enabled\": true,\n    \"heartbeat.data.collection.schema.or.database\": \"<string>\",\n    \"post.processors\": \"reselector\",\n    \"database.sslmode\": \"require\",\n    \"include.source.db.name.in.table.name.user.defined\": false,\n    \"binary.handling.mode\": \"bytes\",\n    \"transforms.InsertStaticKey1.static.field\": \"<string>\",\n    \"transforms.InsertStaticKey1.static.value\": \"<string>\",\n    \"transforms.InsertStaticValue1.static.field\": \"<string>\",\n    \"transforms.InsertStaticValue1.static.value\": \"<string>\",\n    \"transforms.InsertStaticKey2.static.field\": \"<string>\",\n    \"transforms.InsertStaticKey2.static.value\": \"<string>\",\n    \"transforms.InsertStaticValue2.static.field\": \"<string>\",\n    \"transforms.InsertStaticValue2.static.value\": \"<string>\",\n    \"predicates.IsTopicToEnrich.pattern\": \"$^\",\n    \"ssh.enabled\": false\n  },\n  \"kc_cluster_id\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ]\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/sources/{source_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"connector\": \"<string>\",\n  \"config\": {\n    \"database.hostname.user.defined\": \"<string>\",\n    \"database.port.user.defined\": \"5432\",\n    \"database.user\": \"<string>\",\n    \"database.password\": \"<string>\",\n    \"database.dbname\": \"<string>\",\n    \"signal.data.collection.schema.or.database\": \"<string>\",\n    \"slot.name\": \"streamkap_pgoutput_slot\",\n    \"publication.name\": \"streamkap_pub\",\n    \"schema.include.list\": \"<string>\",\n    \"table.include.list.user.defined\": \"<string>\",\n    \"ssh.host\": \"<string>\",\n    \"ssh.port\": \"22\",\n    \"ssh.user\": \"streamkap\",\n    \"ssh.public.key.user.displayed\": \"ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIJVbRrHqNN3SyIYnNF46SMd+ArZz+QheAtjnQzKiBWrc\",\n    \"transforms.ValueToKey.fields.include.list\": \"<string>\",\n    \"transforms.ValueToKey.replace.null.with.default\": true,\n    \"preserve.null.values\": false,\n    \"transforms.OversizedRecords.fields.include.list\": \"<string>\",\n    \"transforms.OversizedRecords.fields.exclude.list\": \"<string>\",\n    \"transforms.OversizedRecords.max.field.size.bytes\": 1048576,\n    \"transforms.OversizedRecords.oversized.field.behavior\": \"TRUNCATE\",\n    \"transforms.OversizedRecords.truncation.suffix\": \"\",\n    \"transforms.OversizedRecords.max.record.size.bytes\": -1,\n    \"transforms.OversizedRecords.semantic.types.exclude\": \"io.debezium.data.Json,io.debezium.data.Xml\",\n    \"transforms.OversizedRecords.replace.null.with.default\": true,\n    \"InsertTopicName.enabled\": false,\n    \"snapshot.read.only.user.defined\": \"Yes\",\n    \"column.include.list.toggled\": true,\n    \"column.include.list.user.defined\": \"<string>\",\n    \"column.exclude.list.user.defined\": \"<string>\",\n    \"heartbeat.enabled\": true,\n    \"heartbeat.data.collection.schema.or.database\": \"<string>\",\n    \"post.processors\": \"reselector\",\n    \"database.sslmode\": \"require\",\n    \"include.source.db.name.in.table.name.user.defined\": false,\n    \"binary.handling.mode\": \"bytes\",\n    \"transforms.InsertStaticKey1.static.field\": \"<string>\",\n    \"transforms.InsertStaticKey1.static.value\": \"<string>\",\n    \"transforms.InsertStaticValue1.static.field\": \"<string>\",\n    \"transforms.InsertStaticValue1.static.value\": \"<string>\",\n    \"transforms.InsertStaticKey2.static.field\": \"<string>\",\n    \"transforms.InsertStaticKey2.static.value\": \"<string>\",\n    \"transforms.InsertStaticValue2.static.field\": \"<string>\",\n    \"transforms.InsertStaticValue2.static.value\": \"<string>\",\n    \"predicates.IsTopicToEnrich.pattern\": \"$^\",\n    \"ssh.enabled\": false\n  },\n  \"kc_cluster_id\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ]\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.streamkap.com/sources/{source_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  \"connector\": \"<string>\",\n  \"config\": {\n    \"database.hostname.user.defined\": \"<string>\",\n    \"database.port.user.defined\": \"5432\",\n    \"database.user\": \"<string>\",\n    \"database.password\": \"<string>\",\n    \"database.dbname\": \"<string>\",\n    \"signal.data.collection.schema.or.database\": \"<string>\",\n    \"slot.name\": \"streamkap_pgoutput_slot\",\n    \"publication.name\": \"streamkap_pub\",\n    \"schema.include.list\": \"<string>\",\n    \"table.include.list.user.defined\": \"<string>\",\n    \"ssh.host\": \"<string>\",\n    \"ssh.port\": \"22\",\n    \"ssh.user\": \"streamkap\",\n    \"ssh.public.key.user.displayed\": \"ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIJVbRrHqNN3SyIYnNF46SMd+ArZz+QheAtjnQzKiBWrc\",\n    \"transforms.ValueToKey.fields.include.list\": \"<string>\",\n    \"transforms.ValueToKey.replace.null.with.default\": true,\n    \"preserve.null.values\": false,\n    \"transforms.OversizedRecords.fields.include.list\": \"<string>\",\n    \"transforms.OversizedRecords.fields.exclude.list\": \"<string>\",\n    \"transforms.OversizedRecords.max.field.size.bytes\": 1048576,\n    \"transforms.OversizedRecords.oversized.field.behavior\": \"TRUNCATE\",\n    \"transforms.OversizedRecords.truncation.suffix\": \"\",\n    \"transforms.OversizedRecords.max.record.size.bytes\": -1,\n    \"transforms.OversizedRecords.semantic.types.exclude\": \"io.debezium.data.Json,io.debezium.data.Xml\",\n    \"transforms.OversizedRecords.replace.null.with.default\": true,\n    \"InsertTopicName.enabled\": false,\n    \"snapshot.read.only.user.defined\": \"Yes\",\n    \"column.include.list.toggled\": true,\n    \"column.include.list.user.defined\": \"<string>\",\n    \"column.exclude.list.user.defined\": \"<string>\",\n    \"heartbeat.enabled\": true,\n    \"heartbeat.data.collection.schema.or.database\": \"<string>\",\n    \"post.processors\": \"reselector\",\n    \"database.sslmode\": \"require\",\n    \"include.source.db.name.in.table.name.user.defined\": false,\n    \"binary.handling.mode\": \"bytes\",\n    \"transforms.InsertStaticKey1.static.field\": \"<string>\",\n    \"transforms.InsertStaticKey1.static.value\": \"<string>\",\n    \"transforms.InsertStaticValue1.static.field\": \"<string>\",\n    \"transforms.InsertStaticValue1.static.value\": \"<string>\",\n    \"transforms.InsertStaticKey2.static.field\": \"<string>\",\n    \"transforms.InsertStaticKey2.static.value\": \"<string>\",\n    \"transforms.InsertStaticValue2.static.field\": \"<string>\",\n    \"transforms.InsertStaticValue2.static.value\": \"<string>\",\n    \"predicates.IsTopicToEnrich.pattern\": \"$^\",\n    \"ssh.enabled\": false\n  },\n  \"kc_cluster_id\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ]\n}"

response = http.request(request)
puts response.read_body
{
  "name": "<string>",
  "connector": "<string>",
  "id": "<string>",
  "connector_display_name": "<string>",
  "created_timestamp": "<string>",
  "sub_id": "<string>",
  "tenant_id": "<string>",
  "service_id": "<string>",
  "config": {
    "database.hostname.user.defined": "<string>",
    "database.port.user.defined": "5432",
    "database.user": "<string>",
    "database.password": "<string>",
    "database.dbname": "<string>",
    "signal.data.collection.schema.or.database": "<string>",
    "slot.name": "streamkap_pgoutput_slot",
    "publication.name": "streamkap_pub",
    "schema.include.list": "<string>",
    "table.include.list.user.defined": "<string>",
    "ssh.host": "<string>",
    "ssh.port": "22",
    "ssh.user": "streamkap",
    "ssh.public.key.user.displayed": "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIJVbRrHqNN3SyIYnNF46SMd+ArZz+QheAtjnQzKiBWrc",
    "transforms.ValueToKey.fields.include.list": "<string>",
    "transforms.ValueToKey.replace.null.with.default": true,
    "preserve.null.values": false,
    "transforms.OversizedRecords.fields.include.list": "<string>",
    "transforms.OversizedRecords.fields.exclude.list": "<string>",
    "transforms.OversizedRecords.max.field.size.bytes": 1048576,
    "transforms.OversizedRecords.oversized.field.behavior": "TRUNCATE",
    "transforms.OversizedRecords.truncation.suffix": "",
    "transforms.OversizedRecords.max.record.size.bytes": -1,
    "transforms.OversizedRecords.semantic.types.exclude": "io.debezium.data.Json,io.debezium.data.Xml",
    "transforms.OversizedRecords.replace.null.with.default": true,
    "InsertTopicName.enabled": false,
    "snapshot.read.only.user.defined": "Yes",
    "column.include.list.toggled": true,
    "column.include.list.user.defined": "<string>",
    "column.exclude.list.user.defined": "<string>",
    "heartbeat.enabled": true,
    "heartbeat.data.collection.schema.or.database": "<string>",
    "post.processors": "reselector",
    "database.sslmode": "require",
    "include.source.db.name.in.table.name.user.defined": false,
    "binary.handling.mode": "bytes",
    "transforms.InsertStaticKey1.static.field": "<string>",
    "transforms.InsertStaticKey1.static.value": "<string>",
    "transforms.InsertStaticValue1.static.field": "<string>",
    "transforms.InsertStaticValue1.static.value": "<string>",
    "transforms.InsertStaticKey2.static.field": "<string>",
    "transforms.InsertStaticKey2.static.value": "<string>",
    "transforms.InsertStaticValue2.static.field": "<string>",
    "transforms.InsertStaticValue2.static.value": "<string>",
    "predicates.IsTopicToEnrich.pattern": "$^",
    "ssh.enabled": false
  },
  "topic_ids": [
    "<string>"
  ],
  "topic_map": {},
  "topics": [
    "<string>"
  ],
  "tasks": [
    123
  ],
  "connector_status": "<string>",
  "desired_state": "<string>",
  "kc_cluster_id": "<string>",
  "task_statuses": {},
  "tags": [
    "<string>"
  ]
}
{
  "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

​
source_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, save config and return immediately without waiting for KC update

Body

application/json

Request body for updating an existing source connector.

​
name
string
required

Display name for the source connector.

​
connector
string
required

Connector type identifier (e.g., 'postgresql', 'mysql', 'mongodb', 'dynamodb', 'sqlserveraws').

​
config
AlloyDB · object
required

Configuration properties for the AlloyDB source connector.

​
kc_cluster_id
string | null

KC cluster to deploy this connector to. Omit for default cluster.

​
tags
string[] | null

List of tag IDs to assign to this source

Response

Successful Response

Source connector configuration and status.

​
name
string | null

User-defined connector name

​
connector
string | null

Connector type (e.g., 'postgresql', 'mysql', 'mongodb')

​
id
string | null

Unique identifier

​
connector_display_name
string | null

Human-readable connector type name

​
created_timestamp

Creation timestamp (ISO 8601)

​
sub_id
string | null

Subscription identifier

​
tenant_id
string | null

Tenant identifier for multi-tenancy

​
service_id
string | null

Associated service identifier

​
config
AlloyDB · object

Configuration properties for the AlloyDB source connector.

​
topic_ids
(string | integer)[] | null

List of associated topic identifiers

​
topic_map
Topic Map · object | null

Mapping of topics to their partitions or related entities

​
topics
(string | integer)[] | null

List of topic names

​
tasks
integer[] | null

List of task identifiers

​
connector_status
string | null

Current status: Active, Paused, Stopped, Broken, Starting, Unassigned, Unknown, Pending

​
desired_state
string | null

Desired state: Pending, Active, Paused, Stopped

​
kc_cluster_id
string | null

KC cluster this connector is deployed to. None means default cluster.

​
task_statuses
Task Statuses · object | null

Status information for each connector task

​
tags
string[] | null

List of tag IDs assigned to this source