STstreamkap
Destinations

Deploy Destination

Changed on

Deploy a PENDING destination, transitioning it to ACTIVE.

post/destinations/{destination_id}/deploy

Request

Path parameters

destination_idstring required

Response

Successful Response

namestring nullable

User-defined connector name

connectorstring nullable

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

idstring nullable

Unique identifier

connector_display_namestring nullable

Human-readable connector type name

sub_idstring nullable

Subscription identifier

tenant_idstring nullable

Tenant identifier for multi-tenancy

configobject nullable

Connector configuration parameters

topic_mapobject nullable

Mapping of topics to their partitions or related entities

tasksinteger[] nullable

List of task identifiers

connector_statusstring nullable

Current status: Active, Paused, Stopped, Broken, Starting, Unassigned, Unknown, or a Pending* state echoed from desired_state while a requested change is being applied

desired_statestring nullable

Desired state: Active, Paused, Stopped, or a pending change Streamkap is still applying — Pending, Pending Update, Pending Delete, Pending Stop, Pending Pause, Pending Resume, Pending Restart

reconcile_errorstring nullable

Why the connector is Broken, as recorded when Streamkap last tried to apply its state. Secrets are masked; absent while the connector is healthy.

schema_evolution_warningstring nullable

Advisory: this destination silently drops fields its API sources start sending, because schema evolution is set to 'none'. Absent whenever nothing is at risk. Nothing is blocked — 'none' is a valid choice for a pre-created destination schema.

kc_cluster_idstring nullable

Kafka Connect cluster this connector is deployed to. None means the default cluster.

task_statusesobject nullable

Status information for each connector task

tagsstring[] nullable

List of tag IDs assigned to this destination

Changes

  • 50e54c2e65f2Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status