Sign in

v1

OpenAPI 3.1.0Proprietary2026-07-13197242444.9 KB
Destinations

Create New Destination

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

post/destinations

Query parameters

secret_returnedboolean

Whether to include secret values in the response

Whether to include secret values in the response

waitboolean

When False, save config and return immediately without waiting for KC deployment

When False, save config and return immediately without waiting for KC 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'

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: Config saved to MongoDB, KC update deferred to reconciler
  • PENDING_DELETE: Marked for deletion, KC teardown deferred to reconciler
kc_cluster_idstring nullable

KC cluster to deploy this connector to. Omit for 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, 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