STstreamkap
Destinations

Create New Destination

Changed on

spec: /specs/20_Destinations/spec.md#create-destination

post/destinations

Request

Query parameters

secret_returnedboolean

Whether to include secret values in the response

waitboolean

When False (default), save the configuration and return immediately; the connector is deployed to Kafka Connect asynchronously and its desired_state stays Pending until then. When True, wait for the deployment.

Request body

namestring required

Display name for the destination connector.

connectorstring required

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

configobject required

Connector-specific configuration 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.

created_from'terraform' | 'web' | 'api'

Origin of an entity in the system.

Tracks how entities (sources, destinations, pipelines) were created, enabling audit trails and origin-specific behavior.

desired_state'Pending' | 'Active' | 'Paused' | 'Stopped' | 'Pending Update' | 'Pending Delete' | 'Pending Stop' | 'Pending Pause' | 'Pending Resume' | 'Pending Restart'

Desired state for sources and destinations.

Represents the target state for the connector:

  • Pending: Configuration saved, not yet deployed
  • Active: Connector should be running (default for existing connectors)
  • Paused: Connector should be paused
  • Stopped: Connector should be stopped
  • Pending Update: Configuration change saved, not yet applied to the running connector
  • Pending Delete: Marked for deletion, connector not yet removed
  • Pending Stop / Pending Pause / Pending Resume / Pending Restart: action requested, not yet applied. Once applied the state becomes Stopped / Paused / Active / Active respectively.
kc_cluster_idstring nullable

Kafka Connect cluster to deploy this connector to. Omit for the default cluster.

tagsstring[] nullable

List of tag IDs to assign to this destination

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
    • breaking

      for the query request parameter wait, default value was changed from true to false

    • info

      added the new Pending Pause enum value to the request property /

    • info

      added the new Pending Restart enum value to the request property /

    • info

      added the new Pending Resume enum value to the request property /

    • info

      added the new Pending Stop enum value to the request property /

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status