STstreamkap
Sources

Deploy Source

Changed on

Deploy a PENDING source, transitioning it to ACTIVE.

post/sources/{source_id}/deploy

Request

Path parameters

source_idstring required

Response

Successful Response

namestring nullable

User-defined connector name

connectorstring nullable

Connector type (e.g., 'postgresql', 'mysql', 'mongodb')

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

service_idstring nullable

Associated service identifier

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, Throttled (an api source waiting out its vendor's rate budget; task_statuses carries suspend_reason and resume_at), or a Pending* state echoed from desired_state while a requested change is being applied

desired_statestring nullable

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

reconcile_errorstring nullable

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

connection_warningstring nullable

API sources, on the create and update responses only: what the credential and resource checks found that did not stop the save but needs action, e.g. an ad account that is not active, an access token that expires within 14 days, or a resource that returned no rows (each resource's warning prefixed with its name, <resource>: <warning>). The same texts Test connection returns as its message and as each passing resource's warning. Absent when there is nothing to report.

kc_cluster_idstring nullable

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

task_statusesobject nullable

Status information for each connector task

tagsstring[] nullable

List of tag IDs assigned to this source

Changes

  • 50e54c2e65f2Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status