Apache Kafka API Configuration

Request

POST https://api.fivetran.com/v1/connections

{
  "group_id": "group_id",
  "service": "apache_kafka",
  "trust_certificates": true,
  "trust_fingerprints": true,
  "run_setup_tests": true,
  "paused": false,
  "pause_after_trial": false,
  "sync_frequency": 1440,
  "data_delay_sensitivity": "NORMAL",
  "data_delay_threshold": 0,
  "daily_sync_time": "14:00",
  "schedule_type": "auto",
  "connect_card_config": {
    "redirect_uri": "https://your.site/path",
    "hide_setup_guide": true
  },
  "proxy_agent_id": "proxy_agent_id",
  "private_link_id": "private_link_id",
  "networking_method": "Directly",
  "hybrid_deployment_agent_id": "hybrid_deployment_agent_id",
  "config": {
    "consumer_group": "consumer_group",
    "sync_type": "Unpacked | Packed",
    "client_cert": "string",
    "sasl_scram512_secret": "string",
    "sasl_plain_secret": "string",
    "schema_registry_credentials_source": "string",
    "client_cert_key": "string",
    "message_type": "Avro | Json | Text | Protobuf",
    "sasl_scram512_key": "string",
    "sasl_scram256_secret": "string",
    "servers": "serveraddress1:8080, serveraddress2:8080",
    "sasl_plain_key": "string",
    "sasl_mechanism": "PLAIN | SCRAM_SHA_256 | SCRAM_SHA_512",
    "security_protocol": "PLAINTEXT | TLS | SASL",
    "sasl_scram256_key": "string",
    "schema_registry_secret": "string",
    "trusted_cert": "string",
    "schema_registry_urls": [
      "string"
    ],
    "schema_registry_key": "string",
    "schema": "schema_name"
  }
}

Config parameters

Name	Description
`consumer_group`	Kafka consumer group name.
`sync_type`	Kafka sync type. Unpacked messages must be valid JSON.
`client_cert`	Kafka client certificate.
`sasl_scram512_secret`	API Secret
`sasl_plain_secret`	API Secret
`schema_registry_credentials_source`	Schema Registry Credentials source
`client_cert_key`	Kafka client certificate key.
`message_type`	Kafka message type.
`sasl_scram512_key`	API Key
`sasl_scram256_secret`	API Secret
`servers`	Comma-separated list of Kafka servers in the format `server:port`.
`sasl_plain_key`	API Key
`sasl_mechanism`	SASL Mechanism
`security_protocol`	Security protocol for Kafka interaction.
`sasl_scram256_key`	API Key
`schema_registry_secret`	Schema Registry Secret
`trusted_cert`	Kafka trusted certificate.
`schema_registry_urls`	Your schema registry URLs
`schema_registry_key`	Schema Registry Key
`schema`	Destination schema name. Schema name is permanent and cannot be changed after connection creation

Authorization

There are two ways to authorize this connector type:

By specifying the values for the consumer_group and servers parameters in the request.

POST https://api.fivetran.com/v1/connections

{
  "service": "apache_kafka",
  "group_id": "group_id",
  "config": {
    "consumer_group": "consumer_group",
    "servers": "serveraddress1:8080, serveraddress2:8080"
  }
}

By using the Connect Card or the Fivetran dashboard.