Get Sources Connectors

List available source connector types and their configuration schemas.

Returns connector definitions grouped by display name. Each connector includes a config array describing every configuration property — use properties where user_defined is true to build the config object for the POST /sources and PUT /sources/ endpoints.

Pass connector_code (e.g., postgresql, mysql, mongodb) to retrieve the schema for a single connector type. Omit it to retrieve all available connectors.

Each config property includes:

• name — the dot-notation key to use in the config object (e.g., database.hostname.user.defined)
• description — human-readable explanation
• required — whether the property is mandatory
• display_name — short label
• value.control — input type (string, password, one-select, etc.)
• value.default — default value, if any

GET /sources/connectors

Get Sources Connectors

cURL

curl --request GET \
  --url https://api.streamkap.com/sources/connectors \
  --header 'Authorization: Bearer <token>'

422

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

connector_code · string | null

Filter by connector type identifier (e.g., 'postgresql', 'mysql', 'mongodb'). Omit to return all available connector types.

Response

200

application/json

Successful Response