> ## Documentation Index
> Fetch the complete documentation index at: https://docs.streamkap.com/llms.txt
> Use this file to discover all available pages before exploring further.

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

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



## OpenAPI

````yaml /openapi/openapi.json get /sources/connectors
openapi: 3.1.0
info:
  title: Streamkap REST API
  description: >-
    The Streamkap REST API allows you to programmatically manage your CDC
    pipelines, sources, destinations, transforms, and more.


    Authenticate using a bearer token obtained from the [Access
    Token](/api-reference/auth/access-token) endpoint with your API client
    credentials.
  contact:
    name: Streamkap Support
    url: https://streamkap.com/
    email: support@streamkap.com
  license:
    name: Proprietary
  version: 2.0.0
servers:
  - url: https://api.streamkap.com
    description: Production
security: []
tags:
  - name: Alerts
    description: Manage alert subscribers, preferences, and notification credentials.
  - name: Authentication
    description: Obtain and refresh access tokens, manage client credentials and roles.
  - name: Billing
    description: Retrieve usage metrics, summaries, and export billing data.
  - name: Consumer Groups
    description: List, inspect, and reset Kafka consumer group offsets.
  - name: Dashboard
    description: Retrieve organisation-level statistics and overview data.
  - name: Destinations
    description: Create, configure, and manage data destinations and their lifecycle.
  - name: Kafka Access
    description: Manage Kafka users and their access permissions.
  - name: Logs
    description: Query and summarise system logs.
  - name: Pipelines
    description: Create, configure, and manage CDC pipelines and their lifecycle.
  - name: Project Keys
    description: Manage project keys that bundle API credentials and optional Kafka access.
  - name: Schema Registry
    description: Browse schema subjects, versions, and retrieve schema definitions.
  - name: Services
    description: View and switch service metadata.
  - name: Sources
    description: >-
      Create, configure, and manage data sources, snapshots, and their
      lifecycle.
  - name: Tags
    description: Create, update, and manage resource tags for organisation.
  - name: Topics
    description: Browse topic details, statistics, configurations, metrics, and messages.
  - name: Transforms
    description: >-
      Create, deploy, and manage data transforms, unit tests, and implementation
      details.
paths:
  /sources/connectors:
    get:
      tags:
        - Sources
      summary: Get Sources Connectors
      description: >-
        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.


        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
      operationId: listSourceConnectorTypes
      parameters:
        - name: connector_code
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              Filter by connector type identifier (e.g., 'postgresql', 'mysql',
              'mongodb'). Omit to return all available connector types.
            title: Connector Code
          description: >-
            Filter by connector type identifier (e.g., 'postgresql', 'mysql',
            'mongodb'). Omit to return all available connector types.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - FronteggHTTPAuthentication: []
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    FronteggHTTPAuthentication:
      type: http
      scheme: bearer

````