> For the complete documentation index, see [llms.txt](https://docs.kognitos.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.kognitos.com/guides/platform/integrations/kafka.md).

# Kafka

Overview of the Kafka integration.

{% hint style="info" %}
The following documentation is for **Kafka v1.0.0**.
{% endhint %}

## Overview

on a Kafka cluster via the REST Proxy API (Karapace / Confluent).

## Setup

The following integrations need to be connected to your Kognitos workspace:

* **Kafka**

### Steps

Follow these steps to connect the integration in Kognitos:

{% stepper %}
{% step %}

#### Navigate

Using the left navigation menu, go to **Integrations** → **Explore Integrations**.
{% endstep %}

{% step %}

#### Find

Search for the integration and click on it.
{% endstep %}

{% step %}

#### Connect

Click on <kbd>**Connect**</kbd> to add a connection to the integration.
{% endstep %}

{% step %}

#### Configure

Add a name for the connection. You'll be prompted for [**authentication**](#authentication) details if needed. Then, click on <kbd>**Connect**</kbd>.
{% endstep %}
{% endstepper %}

## Authentication

Use one of the following authentication methods to connect this integration in Kognitos. Each method has its own configuration requirements.

#### Connect using Basic Authentication

Connect to Kafka using HTTP Basic Authentication.

| Label    | Description                                                                                                                                                                           | Type        |
| -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
| Base URL | The base URL of the Kafka REST Proxy (e.g. "<https://kafka-service.aivencloud.com:12345>" for Aiven, or "<https://pkc-xxxxx.us-west-2.aws.confluent.cloud:443>" for Confluent Cloud). | `text`      |
| Username | The username or API key for authentication (e.g. "avnadmin" for Aiven).                                                                                                               | `text`      |
| Password | The password or API secret for authentication.                                                                                                                                        | `sensitive` |

#### Connect using Bearer Token

Connect to Kafka using a Bearer token.

| Label        | Description                                                                                                  | Type        |
| ------------ | ------------------------------------------------------------------------------------------------------------ | ----------- |
| Base URL     | The base URL of the Kafka REST Proxy (e.g. "<http://localhost:8082>" or "<https://kafka-rest.example.com>"). | `text`      |
| Bearer Token | The Bearer token for authentication.                                                                         | `sensitive` |

#### Connect using No Authentication

Connect to Kafka without authentication.

| Label    | Description                                                            | Type   |
| -------- | ---------------------------------------------------------------------- | ------ |
| Base URL | The base URL of the Kafka REST Proxy (e.g. "<http://localhost:8082>"). | `text` |

## Actions

{% hint style="info" %}
The available actions for **Kafka** are listed in the product UI on the integration page once you create a connection.
{% endhint %}
