Get Sources Connectors
Sources
Get Sources Connectors
Retrieve the configuration schema for source connectors.
The response is keyed by connector display name, with each value being an array of config property definitions. Use the connector_code query parameter to filter results to a single connector type.
Config property fields
Each config property definition includes the following fields:
| Field | Description |
|---|---|
name | Property key to use in the config object (e.g., database.hostname.user.defined) |
description | Human-readable description of the property |
required | Whether the property is required to create or update the connector |
user_defined | Whether the property should be set by the user (use only user_defined: true properties in your config object) |
display_name | Human-readable label for the property |
value.control | UI control type (e.g., text, password, select) |
value.default | Default value if not provided |
value.raw_values | Allowed values for select-type controls |
tab | UI grouping tab for the property |
Example
GET /sources/connectors?connector_code=postgresql
This returns the full schema for PostgreSQL source connectors, including all available config properties with their types, defaults, and constraints.
GET
Get Sources Connectors
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Filter by source connector type identifier (e.g., postgresql, mysql). Omit to return all connectors.
Response
Successful Response