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": {}
}
'

{
  "name": "<string>",
  "connector": "<string>",
  "id": "<string>",
  "connector_display_name": "<string>",
  "created_timestamp": "<string>",
  "sub_id": "<string>",
  "tenant_id": "<string>",
  "service_id": "<string>",
  "config": {},
  "topic_ids": [
    "<string>"
  ],
  "topic_map": {},
  "topics": [
    "<string>"
  ],
  "tasks": [
    123
  ],
  "connector_status": "<string>",
  "desired_state": "<string>",
  "task_statuses": {}
}

Sources

Update Existing Source

Update an existing source connector’s configuration.

The config object contains connector-specific configuration properties using dot notation. Use GET /sources/connectors?connector_code=<type> to discover available properties — only those with user_defined: true should be included in your request.

How to add tables via API

To add a new table to a source, update the table.include.list property to include both the existing and new tables. The value is replaced, not appended — you must send the complete list.

Example: If your source currently replicates public.orders and public.customers, and you want to add public.new_table:

{
  "name": "My PostgreSQL Source",
  "connector": "postgresql",
  "config": {
    "table.include.list": "public.orders,public.customers,public.new_table"
  }
}

Important: Any tables removed from table.include.list will stop being replicated.

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": {}
}
'

{
  "name": "<string>",
  "connector": "<string>",
  "id": "<string>",
  "connector_display_name": "<string>",
  "created_timestamp": "<string>",
  "sub_id": "<string>",
  "tenant_id": "<string>",
  "service_id": "<string>",
  "config": {},
  "topic_ids": [
    "<string>"
  ],
  "topic_map": {},
  "topics": [
    "<string>"
  ],
  "tasks": [
    123
  ],
  "connector_status": "<string>",
  "desired_state": "<string>",
  "task_statuses": {}
}

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

Body

application/json

name

string

required

Display name for the source connector.

connector

string

required

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

config

Config · object

required

Connector-specific configuration properties using dot notation. Use GET /sources/connectors with connector_code to retrieve the full schema — only include properties where user_defined: true.

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')

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

Config · object

Connector configuration parameters

Show child attributes

topic_ids

(string | integer)[] | null

List of associated topic identifiers

topic_map

Topic Map · object

Mapping of topics to their partitions or related entities

Show child attributes

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

task_statuses

Task Statuses · object

Status information for each connector task

Show child attributes

Get Source Delete Existing Source

⌘I

Authentication

Topics

Logs

Transforms

Services

Alerts

Billing

Dashboard

Destinations

Sources

Pipelines

Kafka Access

Consumer Groups

Schema Registry

Tags

Update Existing Source

How to add tables via API

Authorizations

Path Parameters

Query Parameters

Body

Response