Sign in

v1

OpenAPI 3.1.0Proprietary2026-07-13197242444.9 KB
Destinations

Deploy Destination

Deploy a PENDING destination, transitioning it to ACTIVE.

post/destinations/{destination_id}/deploy

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, Pending

desired_statestring nullable

Desired state: Pending, Active, Paused, Stopped

kc_cluster_idstring nullable

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

task_statusesobject nullable

Status information for each connector task

tagsstring[] nullable

List of tag IDs assigned to this destination