Deploy Destination

Deploy a PENDING destination, transitioning it to ACTIVE.

POST/destinations/{destination_id}/deploy

Authorization

AuthorizationBearer token · headerrequired

Path parameters

destination_idstringrequired

Responses

200

Successful Response

namestring | null

User-defined connector name

Show properties

Any of:

string

string

null

null

connectorstring | null

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

Show properties

Any of:

string

string

null

null

idstring | null

Unique identifier

Show properties

Any of:

string

string

null

null

connector_display_namestring | null

Human-readable connector type name

Show properties

Any of:

string

string

null

null

created_timestampstring | string<date-time> | null

Creation timestamp (ISO 8601)

Show properties

Any of:

string

string

string<date-time>

string<date-time>

null

null

sub_idstring | null

Subscription identifier

Show properties

Any of:

string

string

null

null

tenant_idstring | null

Tenant identifier for multi-tenancy

Show properties

Any of:

string

string

null

null

configobject | null

The connector's configuration. Its properties per connector type are documented on the create and update requests' config.

Show properties

Any of:

object

object

null

null

topic_idsstring | integer[] | null

List of associated topic identifiers

Show properties

Any of:

string | integer[]

Array of string | integer

Any of:

string

string

integer

integer

null

null

topic_mapobject | null

Mapping of topics to their partitions or related entities

Show properties

Any of:

object

object

null

null

topicsstring | integer[] | null

List of topic names

Show properties

Any of:

string | integer[]

Array of string | integer

Any of:

string

string

integer

integer

null

null

tasksinteger[] | null

List of task identifiers

Show properties

Any of:

integer[]

Array of integer

integer

null

null

connector_statusstring | null

Current status: Active, Paused, Stopped, Broken, Starting, Unassigned, Unknown, or a Pending* state echoed from desired_state while a requested change is being applied

Show properties

Any of:

string

string

null

null

desired_statestring | null

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

Show properties

Any of:

string

string

null

null

reconcile_errorstring | null

Why the connector is Broken, as recorded when Streamkap last tried to apply its state. Secrets are masked; absent while the connector is healthy.

Show properties

Any of:

string

string

null

null

schema_evolution_warningstring | null

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.

Show properties

Any of:

string

string

null

null

kc_cluster_idstring | null

Kafka Connect cluster this connector is deployed to. None means the default cluster.

Show properties

Any of:

string

string

null

null

task_statusesobject | null

Status information for each connector task

Show properties

Any of:

object

object

null

null

tagsstring[] | null

List of tag IDs assigned to this destination

Show properties

Any of:

string[]

Array of string

string

null

null

422

Validation Error

detailValidationError[]

Show properties

Array of ValidationError

locstring | integer[]required

Show properties

Array of string | integer

Any of:

string

string

integer

integer

msgstringrequired

typestringrequired

inputany

ctxobject

Request

curl -X POST 'https://api.streamkap.com/destinations/string/deploy' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'

const response = await fetch("https://api.streamkap.com/destinations/string/deploy", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json"
  }
});

import requests

response = requests.post(
    "https://api.streamkap.com/destinations/string/deploy",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json"
    },
)

Response

{
  "name": "string",
  "connector": "string",
  "id": "string",
  "connector_display_name": "string",
  "created_timestamp": "string",
  "sub_id": "string",
  "tenant_id": "string",
  "config": {
    "property1": "string",
    "property2": "string"
  },
  "topic_ids": [
    "string"
  ],
  "topic_map": {
    "property1": [
      "string"
    ],
    "property2": [
      "string"
    ]
  },
  "topics": [
    "string"
  ],
  "tasks": [
    0
  ],
  "connector_status": "string",
  "desired_state": "string",
  "reconcile_error": "string",
  "schema_evolution_warning": "string",
  "kc_cluster_id": "string",
  "task_statuses": {
    "property1": {
      "property1": "string",
      "property2": "string"
    },
    "property2": {
      "property1": "string",
      "property2": "string"
    }
  },
  "tags": [
    "string"
  ]
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}