--- title: Kafka Connect url: https://docs.vultr.com/products/storage/databases/kafka/management/kafka-connect description: A tool for integrating Apache Kafka with external systems through connectors for data import and export publish_date: 2025-03-21T15:27:59.592222Z last_updated: 2026-05-26T19:43:55.513655Z --- # How to Use Kafka Connect with Vultr Managed Apache Kafka® Kafka Connect is a key component that enables scalable and reliable data integration in Vultr Managed Apache Kafka® cluster. You can use Kafka Connect to move data in and out of topics in a Vultr Managed Apache Kafka®, providing an efficient way to integrate multiple applications such as databases, Object Storage, and Elasticsearch in your cluster. Follow this guide to enable Kafka Connect in Vultr Managed Apache Kafka® and create new connectors using the Vultr Console, Vultr API, or Terraform. === "Vultr Console" 1. Navigate to **Products** and click **Databases**. 1. Click your target Vultr Managed Apache Kafka® cluster to open its management page. 1. Navigate to the **Kafka Connect** tab. 1. Verify the list of available connectors compatible with your cluster. 1. Choose your desired connector type: * **Sink**: Read data from Kafka topics and push the data to external sources such as search indexes, batch systems and databases for processsing. * **Source**: Pull data from external sources and publish the data to specific Kafka topics in the cluster. 1. Click **Add Connector**. 1. Specify the connector label and specify the topics to link in your cluster. 1. Modify the default **Config JSON** parameters to include the connector information, such as: * Destination details. * Output format. * Queries. * Protocols. * Size specifications. * Maximum timeout and retry information. 1. Remove any unused optional properties in the connector configuration. 1. Click **Add Connector** to create the connector. 1. Verify the list of active connectors in the cluster. 1. Click **Connector Status** to monitor the connector status. * Verify the **Connector State** information. * Click **Refresh Status** to refresh the connector information. * Click **Restart Connector** to restart it. * Click **Pause Connector** to pause the configuration. * Click **Resume Connector** to resume a paused connector. 1. Click **Edit Connector** to modify the connector information. 1. Click **Delete Connector** to delete the connector. === "Vultr API" 1. Send a `GET` request to the [**List Managed Databases** endpoint](https://www.vultr.com/api/#tag/managed-databases/operation/list-databases) and note the target database cluster's ID. ```console $ curl "https://api.vultr.com/v2/databases" \ -X GET \ -H "Authorization: Bearer ${VULTR_API_KEY}" ``` 1. Send a `GET` request to the [**List Database Available Connectors** endpoint](https://www.vultr.com/api/#tag/managed-databases/operation/list-database-available-connectors), specifing the database ID to list all available connectors and note the target connector class. ```console $ curl "https://api.vultr.com/v2/databases/{database-id}/available-connectors" \ -X GET \ -H "Authorization: Bearer ${VULTR_API_KEY}" ``` 1. Send a `GET` request to the Get Database Connector Configuration Schema, specifying the target database ID and connector class to get the default connector configuration. ```console $ curl "https://api.vultr.com/v2/databases/{database-id}/available-connectors/{connector-class}/configuration" \ -X GET \ -H "Authorization: Bearer ${VULTR_API_KEY}" ``` 1. Send a `GET` request to the [**List Database Topics** endpoint](https://www.vultr.com/api/#tag/managed-databases/operation/list-database-topics), specifying the target database ID to list all topics and note your target topic's ID. ```console $ curl "https://api.vultr.com/v2/databases//topics" \ -X GET \ -H "Authorization: Bearer ${VULTR_API_KEY}" ``` 1. Send a `POST` request to the [**Create Database Connector** endpoint](https://www.vultr.com/api/#tag/managed-databases/operation/create-database-connector), specifying the target database ID, connector class and topics to create a new connector. ```console $ curl "https://api.vultr.com/v2/databases/{database-id}/connectors" \ -X POST \ -H "Authorization: Bearer ${VULTR_API_KEY}" \ -H "Content-Type: application/json" \ --data '{ "name" : "", "class" : "", "topics" : "", "config" : { "{configuration property}": , "{configuration property}": "", "{configuration property}": "" } }' ``` 1. Send a `GET` request to the [**List Database Connectors** endpoint](https://www.vultr.com/api/#tag/managed-databases/operation/list-database-connectors), specifying the target database ID to list all active connectors. ```console $ curl "https://api.vultr.com/v2/databases/{database-id}/connectors" \ -X GET \ -H "Authorization: Bearer ${VULTR_API_KEY}" ``` 1. Send a `PUT` request to the [**Update Database Connector** endpoint](https://www.vultr.com/api/#tag/managed-databases/operation/update-database-connector), specifying the target database ID and the connector name to update its configuration. ```console $ curl "https://api.vultr.com/v2/databases/{database-id}/connectors/{connector-name}" \ -X PUT \ -H "Authorization: Bearer ${VULTR_API_KEY}" \ -H "Content-Type: application/json" \ --data '{ "topics" : "", "config" : { "{configuration property}": , "{configuration property}": "", "{configuration property}": "" } }' ``` 1. Send a `GET` request to the [**Get Database Connector Status** endpoint](https://www.vultr.com/api/#tag/managed-databases/operation/get-database-connector-status), specifyng the target database ID and the connector name to get its status information. ```console $ curl "https://api.vultr.com/v2/databases/{database-id}/connectors/{connector-name}/status" \ -X GET \ -H "Authorization: Bearer ${VULTR_API_KEY}" ``` 1. Send a `POST` request to the [**Pause Database Connector** endpoint](https://www.vultr.com/api/#tag/managed-databases/operation/pause-database-connector), specifying the target database ID and the connector name to pause. ```console $ curl "https://api.vultr.com/v2/databases/{database-id}/connectors/{connector-name}/pause" \ -X POST \ -H "Authorization: Bearer ${VULTR_API_KEY}" ``` 1. Send a `POST` request to the [**Resume Database Connector** endpoint](https://www.vultr.com/api/#tag/managed-databases/operation/resume-database-connector), specifying the target database ID and the connector name to resume. ```console $ curl "https://api.vultr.com/v2/databases/{database-id}/connectors/{connector-name}/resume" \ -X POST \ -H "Authorization: Bearer ${VULTR_API_KEY}" ``` 1. Send a `POST` request to the [**Restart Database Connector Task** endpoint](https://www.vultr.com/api/#tag/managed-databases/operation/restart-database-connector-task), specifying the target database ID, and the connector task ID to restart. ```console $ curl "https://api.vultr.com/v2/databases/{database-id}/connectors/{connector-name}/tasks/{task-id}/restart" \ -X POST \ -H "Authorization: Bearer ${VULTR_API_KEY}" ``` 1. Send a `DELETE` request to the [**Delete Database Connector** endpoint](https://www.vultr.com/api/#tag/managed-databases/operation/delete-database-connector), specifying the target database ID and the connector name to delete from the cluster. ```console $ curl "https://api.vultr.com/v2/databases/{database-id}/connectors/{connector-name}" \ -X DELETE \ -H "Authorization: Bearer ${VULTR_API_KEY}" ``` === "Terraform" 1. Open your Terraform configuration for the existing Managed Apache Kafka® resource. 1. Enable Kafka Connect by setting `enable_kafka_connect = true` on your Kafka resource and apply. ```terraform resource "vultr_database" "kafka" { # ...existing fields (database_engine, region, plan, label, etc.) enable_kafka_connect = true } ``` 1. Apply the configuration and observe the following output: ``` Apply complete! Resources: 0 added, 1 changed, 0 destroyed. ```