Kafka data connector configuration object consists of the following attributes:

AttributeDescription
typeConnector type; must be always set to kafka.
idApp wide unique connector id.
serverProvide only the domain part of the URL without scheme.
portService port number.
sslEither true or false. If true uses TLS connection.
sslConfigOptional Used when server uses a self signed certificate. It consists of two sections: server and client. Each section has its own fields as shown in Test and Create example.
topicThe name of the topic that the message will be delivered to.
dataProcessingMethodOptional. Id or name of the App method that will be used for filtering and/or transforming incoming data. See Overview page for details.
disabledOptional. When true data connector stops streaming.
POST .../v3/apps/:ref/dataconnectors/test

{
    "type": "kafka",
    "id": "dc.kafka.1",
    "server": "kafka-3ab75600-smart-bb56.aivencloud.com",
    "port": 14016,
    "topic": "test",
    "ssl": true,
    "sslConfig": {
     "server": {
       "certificate": "-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----"
        },
     "client": {
       "certificate": "-----BEGIN CERTIFICATE-----\...-----END CERTIFICATE-----",
       "key": "-----BEGIN PRIVATE KEY-----...-----END PRIVATE KEY-----"
     }
    },
    "disabled": false
}
POST .../v3/apps/:ref/dataconnectors

{
    "type": "kafka",
    "id": "dc.kafka.1",
    "server": "kafka-3ab75600-smart-bb56.aivencloud.com",
    "port": 14016,
    "topic": "test",
    "ssl": true,
    "sslConfig": {
     "server": {
       "certificate": "-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----"
        },
     "client": {
       "certificate": "-----BEGIN CERTIFICATE-----\...-----END CERTIFICATE-----",
       "key": "-----BEGIN PRIVATE KEY-----...-----END PRIVATE KEY-----"
     }
    },
    "dataProcessingMethod": "processData",   
    "disabled": false
}
PUT .../v3/apps/:ref/dataconnectors/dc.kafka.1

{
  "topic": "test",
  "dataProcessingMethod": "processData",
  "ssl": true
  "disabled": false
}

What’s Next