Skip to content
Streamkap
Esc
↑↓navigate↵open⌘Jpreview

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/{source_id} 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.

An API-source entry (api_source: true) also carries available: false where no new source of it can be created on this deployment, with the customer-facing unavailable_reason.

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
Authorization
AuthorizationBearer token · headerrequired
Query parameters
connector_codestring

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

Responses
200

Successful Response

object
422

Validation Error

detailValidationError[]
Show properties
Array of ValidationError
locstring | integer[]required
Show properties
Array of string | integer
Any of:
string
string
integer
integer
msgstringrequired
typestringrequired
inputany
ctxobject
Request
curl -X GET 'https://api.streamkap.com/sources/connectors' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "property1": [
    {
      "connector": "string",
      "display_name": "string",
      "config": [
        {}
      ],
      "metrics": [
        {}
      ],
      "schema_levels": [
        "string"
      ],
      "serialisation": "string",
      "debezium_connector_name": "string",
      "status": "string",
      "status_notice": {},
      "streamkap_comment": "string",
      "api_source": true,
      "available": true,
      "unavailable_reason": "string"
    }
  ],
  "property2": [
    {
      "connector": "string",
      "display_name": "string",
      "config": [
        {}
      ],
      "metrics": [
        {}
      ],
      "schema_levels": [
        "string"
      ],
      "serialisation": "string",
      "debezium_connector_name": "string",
      "status": "string",
      "status_notice": {},
      "streamkap_comment": "string",
      "api_source": true,
      "available": true,
      "unavailable_reason": "string"
    }
  ]
}