Skip to main content
POST
/
destinations
Create New Destination
curl --request POST \
  --url https://api.streamkap.com/destinations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "connector": "<string>",
  "config": {},
  "created_from": "api",
  "desired_state": "Pending"
}
'
{
  "name": "<string>",
  "connector": "<string>",
  "id": "<string>",
  "connector_display_name": "<string>",
  "created_timestamp": "<string>",
  "sub_id": "<string>",
  "tenant_id": "<string>",
  "config": {},
  "topic_ids": [
    "<string>"
  ],
  "topic_map": {},
  "topics": [
    "<string>"
  ],
  "tasks": [
    123
  ],
  "connector_status": "<string>",
  "desired_state": "<string>",
  "task_statuses": {}
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
secret_returned
boolean
default:false

Whether to include secret values in the response

Body

application/json
​
name
string
required

Display name for the destination connector.

​
connector
string
required

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

​
config
Config · object
required

Connector-specific configuration properties using dot notation. Use GET /destinations/connectors with connector_code to retrieve the full schema — only include properties where user_defined: true.

​
created_from
enum<string> | null
default:api

Origin of the entity creation.

Available options:
terraform,
web,
api
​
desired_state
enum<string> | null

Desired operational state of the destination.

Available options:
Pending,
Active,
Paused,
Stopped

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
Config · object

Connector configuration parameters

​
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

​
task_statuses
Task Statuses · object

Status information for each connector task