Create a new source connector.
The config object contains connector-specific configuration properties using dot notation (e.g., table.include.list, schema.include.list). Available properties vary by connector type.
GET /sources/connectors?connector_code=postgresql (or your connector type) to retrieve the connector schema.user_defined: true in your config object for create/update requests.Each config property definition includes: name, description, required, user_defined, display_name, value.control, value.default, value.raw_values, and tab. See the Get Sources Connectors endpoint for full details.
{
"name": "My PostgreSQL Source",
"connector": "postgresql",
"config": {
"database.hostname.user.defined": "db.example.com",
"database.port.user.defined": "5432",
"database.dbname.user.defined": "mydb",
"database.user.user.defined": "streamkap_user",
"database.password.user.defined": "secret",
"schema.include.list": "public",
"table.include.list": "public.orders,public.customers"
}
}
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Whether to include secret values in the response
Display name for the source connector.
Connector type identifier (e.g., postgresql, mysql, mongodb, dynamodb, sqlserveraws).
Connector-specific configuration properties using dot notation. Use GET /sources/connectors with connector_code to retrieve the full schema — only include properties where user_defined: true.
Origin of the entity creation.
terraform, web, api Desired operational state of the source.
Pending, Active, Paused, Stopped Successful Response
Source connector configuration and status.
User-defined connector name
Connector type (e.g., 'postgresql', 'mysql', 'mongodb')
Unique identifier
Human-readable connector type name
Creation timestamp (ISO 8601)
Subscription identifier
Tenant identifier for multi-tenancy
Associated service identifier
Connector configuration parameters
List of associated topic identifiers
Mapping of topics to their partitions or related entities
List of topic names
List of task identifiers
Current status: Active, Paused, Stopped, Broken, Starting, Unassigned, Unknown, Pending
Desired state: Pending, Active, Paused, Stopped
Status information for each connector task