Update Existing Destination

Update an existing destination connector.

The config object contains connector-specific properties using dot notation.

Use the GET /destinations/connectors endpoint with a connector_code query parameter to retrieve the full configuration schema for a specific connector type.

PUT /destinations/{destination_id}

Update Existing Destination

cURL

curl --request PUT \
  --url https://api.streamkap.com/destinations/{destination_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "connector": "<string>",
  "config": {
    "azblob.connection.string.user.defined": "<string>",
    "azblob.container.name": "<string>",
    "format.user.defined": "json",
    "format.csv.write.headers": false,
    "topics.dir": "<string>",
    "file.name.template": "{{topic}}-{{partition}}-{{start_offset}}",
    "flush.size": 1000,
    "file.size": 65536,
    "rotate.interval.ms": -1,
    "compression": "<string>"
  },
  "kc_cluster_id": "<string>",
  "tags": [
    "<string>"
  ]
}
'

200

{
  "name": "<string>",
  "connector": "<string>",
  "id": "<string>",
  "connector_display_name": "<string>",
  "created_timestamp": "<string>",
  "sub_id": "<string>",
  "tenant_id": "<string>",
  "config": {
    "azblob.connection.string.user.defined": "<string>",
    "azblob.container.name": "<string>",
    "format.user.defined": "json",
    "format.csv.write.headers": false,
    "topics.dir": "<string>",
    "file.name.template": "{{topic}}-{{partition}}-{{start_offset}}",
    "flush.size": 1000,
    "file.size": 65536,
    "rotate.interval.ms": -1,
    "compression": "<string>"
  },
  "topic_ids": [
    "<string>"
  ],
  "topic_map": {},
  "topics": [
    "<string>"
  ],
  "tasks": [
    123
  ],
  "connector_status": "<string>",
  "desired_state": "<string>",
  "kc_cluster_id": "<string>",
  "task_statuses": {},
  "tags": [
    "<string>"
  ]
}

Authorizations

Authorization · string · header · required

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

Path Parameters

destination_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 destination connector.

name · string · required

Display name for the destination connector.

connector · string · required

Connector type identifier (e.g., 'snowflake', 'bigquery', 'clickhouse', 'postgresql', 's3').

config · Azure Blob Storage · object · required

Configuration properties for the Azure Blob Storage destination connector.

Azure Blob Storage

BigQuery

ClickHouse

CockroachDB

Databricks

Db2

GCS

HTTP Sink

Iceberg

Kafka

Kafka Direct

Motherduck

MySQL

Oracle

Pinecone

PostgreSQL

R2

Redis

Redshift

S3

Snowflake

SQL Server

Starburst

Weaviate

Show child attributes

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 destination

Response

200

application/json

Successful Response

Destination connector configuration and status.

name · string | null

User-defined connector name

connector · string | null

Connector type (e.g., 'snowflake', 'bigquery', 'clickhouse')

id · string | null

Unique identifier

connector_display_name · string | null

Human-readable connector type name

created_timestamp · string string<date-time>

Creation timestamp (ISO 8601)

sub_id · string | null

Subscription identifier

tenant_id · string | null

Tenant identifier for multi-tenancy

config · Azure Blob Storage · object

Configuration properties for the Azure Blob Storage destination connector.

Azure Blob Storage

BigQuery

ClickHouse

CockroachDB

Databricks

Db2

GCS

HTTP Sink

Iceberg

Kafka

Kafka Direct

Motherduck

MySQL

Oracle

Pinecone

PostgreSQL

R2

Redis

Redshift

S3

Snowflake

SQL Server

Starburst

Weaviate

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

kc_cluster_id · string | null

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

task_statuses · Task Statuses · object

Status information for each connector task

Show child attributes

tags · string[] | null

List of tag IDs assigned to this destination