Skip to main content
POST
/
destinations
/
{destination_id}
/
deploy
Deploy Destination
curl --request POST \
  --url https://api.streamkap.com/destinations/{destination_id}/deploy \
  --header 'Authorization: Bearer <token>'
{
  "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>"
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.streamkap.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

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

Path Parameters

destination_id
string
required

Response

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

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.

topic_ids
(string | integer)[] | null

List of associated topic identifiers

topic_map
Topic Map · object

Mapping of topics to their partitions or related entities

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

tags
string[] | null

List of tag IDs assigned to this destination