Skip to main content
POST
Create New Source

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

wait
boolean
default:true

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

Body

application/json

Request body for creating a new source connector.

name
string
required

Display name for the source connector.

connector
string
required

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

config
AlloyDB · object
required

Configuration properties for the AlloyDB source connector.

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 source.

Available options:
Pending,
Active,
Paused,
Stopped,
Pending Update,
Pending Delete
kc_cluster_id
string | null

KC cluster to deploy this connector to. Omit for default cluster.

tags
string[] | null

List of tag IDs to assign to this source

Response

Successful Response

Source connector configuration and status.

name
string | null

User-defined connector name

connector
string | null

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

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

service_id
string | null

Associated service identifier

config
AlloyDB · object

Configuration properties for the AlloyDB source connector.

topic_ids
(string | integer)[] | null

List of associated topic identifiers

topic_map
Topic Map · object | null

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 | null

Status information for each connector task

tags
string[] | null

List of tag IDs assigned to this source