---
title: "Create a Confluent plugin"
method: POST
path: "/plugins#Confluent"
tags: ["Plugins"]
---

# Create a Confluent plugin

`POST /plugins#Confluent`

Create a Confluent plugin

## Request body

- ConfluentPlugin — A Plugin entity represents a plugin configuration that will be executed during the HTTP request/response lifecycle. It is how you can add functionalities to Services that run behind Kong, like Authentication or Rate Limiting for example. You can find more information about how to install and what values each plugin takes by visiting the [Kong Hub](https://docs.konghq.com/hub/). When adding a Plugin Configuration to a Service, every request made by a client to that Service will run said Plugin. If a Plugin needs to be tuned to different values for some specific Consumers, you can do so by creating a separate plugin instance that specifies both the Service and the Consumer, through the `service` and `consumer` fields.
  - `created_at` integer, nullable — Unix epoch when the resource was created.
  - `enabled` boolean, nullable — Whether the plugin is applied.
  - `id` string, nullable
  - `instance_name` string, nullable
  - `name` 'confluent', required — The name of the Plugin that's going to be added. Currently, the Plugin must be installed in every Kong instance separately.
  - `ordering` object, nullable
    - `after` object
      - `access` string[]
    - `before` object
      - `access` string[]
  - `partials` object[], nullable
    - `id` string
    - `name` string
    - `path` string
  - `tags` string[] — An optional set of strings associated with the Plugin for grouping and filtering.
  - `updated_at` integer, nullable — Unix epoch when the resource was last updated.
  - `config` object
    - `allowed_topics` string[] — The list of allowed topic names to which messages can be sent. The default topic configured in the `topic` field is always allowed, regardless of its inclusion in `allowed_topics`.
    - `bootstrap_servers` object[] — Set of bootstrap brokers in a `{host: host, port: port}` list format.
      - `host` string, required — A string representing a host name, such as example.com.
      - `port` integer, required — An integer representing a port number between 0 and 65535, inclusive.
    - `cluster_api_key` string — Username/Apikey for SASL authentication.
    - `cluster_api_secret` string — Password/ApiSecret for SASL authentication.
    - `cluster_name` string — An identifier for the Kafka cluster. By default, this field generates a random string. You can also set your own custom cluster identifier. If more than one Kafka plugin is configured without a `cluster_name` (that is, if the default autogenerated value is removed), these plugins will use the same producer, and by extension, the same cluster. Logs will be sent to the leader of the cluster.
    - `confluent_cloud_api_key` string — Apikey for authentication with Confluent Cloud. This allows for management tasks such as creating topics, ACLs, etc.
    - `confluent_cloud_api_secret` string — The corresponding secret for the Confluent Cloud API key.
    - `forward_body` boolean — Include the request body in the message. At least one of these must be true: `forward_method`, `forward_uri`, `forward_headers`, `forward_body`.
    - `forward_headers` boolean — Include the request headers in the message. At least one of these must be true: `forward_method`, `forward_uri`, `forward_headers`, `forward_body`.
    - `forward_method` boolean — Include the request method in the message. At least one of these must be true: `forward_method`, `forward_uri`, `forward_headers`, `forward_body`.
    - `forward_uri` boolean — Include the request URI and URI arguments (as in, query arguments) in the message. At least one of these must be true: `forward_method`, `forward_uri`, `forward_headers`, `forward_body`.
    - `keepalive` integer — Keepalive timeout in milliseconds.
    - `keepalive_enabled` boolean
    - `message_by_lua_functions` string[] — The Lua functions that manipulates the message being sent to the Kafka topic.
    - `producer_async` boolean — Flag to enable asynchronous mode.
    - `producer_async_buffering_limits_messages_in_memory` integer — Maximum number of messages that can be buffered in memory in asynchronous mode.
    - `producer_async_flush_timeout` integer — Maximum time interval in milliseconds between buffer flushes in asynchronous mode.
    - `producer_request_acks` -1 | 0 | 1 — The number of acknowledgments the producer requires the leader to have received before considering a request complete. Allowed values: 0 for no acknowledgments; 1 for only the leader; and -1 for the full ISR (In-Sync Replica set).
    - `producer_request_limits_bytes_per_request` integer — Maximum size of a Produce request in bytes.
    - `producer_request_limits_messages_per_request` integer — Maximum number of messages to include into a single producer request.
    - `producer_request_retries_backoff_timeout` integer — Backoff interval between retry attempts in milliseconds.
    - `producer_request_retries_max_attempts` integer — Maximum number of retry attempts per single Produce request.
    - `producer_request_timeout` integer — Time to wait for a Produce response in milliseconds.
    - `timeout` integer — Socket timeout in milliseconds.
    - `topic` string — The default Kafka topic to publish to if the query parameter defined in the `topics_query_arg` does not exist in the request
    - `topics_query_arg` string — The request query parameter name that contains the topics to publish to
  - `consumer` object — If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
    - `id` string
  - `protocols` string[] — A set of strings representing HTTP protocols.
  - `route` object — If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
    - `id` string
  - `service` object — If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
    - `id` string

## Response `201`

Created Confluent plugin

- ConfluentPlugin — A Plugin entity represents a plugin configuration that will be executed during the HTTP request/response lifecycle. It is how you can add functionalities to Services that run behind Kong, like Authentication or Rate Limiting for example. You can find more information about how to install and what values each plugin takes by visiting the [Kong Hub](https://docs.konghq.com/hub/). When adding a Plugin Configuration to a Service, every request made by a client to that Service will run said Plugin. If a Plugin needs to be tuned to different values for some specific Consumers, you can do so by creating a separate plugin instance that specifies both the Service and the Consumer, through the `service` and `consumer` fields.
  - `created_at` integer, nullable — Unix epoch when the resource was created.
  - `enabled` boolean, nullable — Whether the plugin is applied.
  - `id` string, nullable
  - `instance_name` string, nullable
  - `name` 'confluent', required — The name of the Plugin that's going to be added. Currently, the Plugin must be installed in every Kong instance separately.
  - `ordering` object, nullable
    - `after` object
      - `access` string[]
    - `before` object
      - `access` string[]
  - `partials` object[], nullable
    - `id` string
    - `name` string
    - `path` string
  - `tags` string[] — An optional set of strings associated with the Plugin for grouping and filtering.
  - `updated_at` integer, nullable — Unix epoch when the resource was last updated.
  - `config` object
    - `allowed_topics` string[] — The list of allowed topic names to which messages can be sent. The default topic configured in the `topic` field is always allowed, regardless of its inclusion in `allowed_topics`.
    - `bootstrap_servers` object[] — Set of bootstrap brokers in a `{host: host, port: port}` list format.
      - `host` string, required — A string representing a host name, such as example.com.
      - `port` integer, required — An integer representing a port number between 0 and 65535, inclusive.
    - `cluster_api_key` string — Username/Apikey for SASL authentication.
    - `cluster_api_secret` string — Password/ApiSecret for SASL authentication.
    - `cluster_name` string — An identifier for the Kafka cluster. By default, this field generates a random string. You can also set your own custom cluster identifier. If more than one Kafka plugin is configured without a `cluster_name` (that is, if the default autogenerated value is removed), these plugins will use the same producer, and by extension, the same cluster. Logs will be sent to the leader of the cluster.
    - `confluent_cloud_api_key` string — Apikey for authentication with Confluent Cloud. This allows for management tasks such as creating topics, ACLs, etc.
    - `confluent_cloud_api_secret` string — The corresponding secret for the Confluent Cloud API key.
    - `forward_body` boolean — Include the request body in the message. At least one of these must be true: `forward_method`, `forward_uri`, `forward_headers`, `forward_body`.
    - `forward_headers` boolean — Include the request headers in the message. At least one of these must be true: `forward_method`, `forward_uri`, `forward_headers`, `forward_body`.
    - `forward_method` boolean — Include the request method in the message. At least one of these must be true: `forward_method`, `forward_uri`, `forward_headers`, `forward_body`.
    - `forward_uri` boolean — Include the request URI and URI arguments (as in, query arguments) in the message. At least one of these must be true: `forward_method`, `forward_uri`, `forward_headers`, `forward_body`.
    - `keepalive` integer — Keepalive timeout in milliseconds.
    - `keepalive_enabled` boolean
    - `message_by_lua_functions` string[] — The Lua functions that manipulates the message being sent to the Kafka topic.
    - `producer_async` boolean — Flag to enable asynchronous mode.
    - `producer_async_buffering_limits_messages_in_memory` integer — Maximum number of messages that can be buffered in memory in asynchronous mode.
    - `producer_async_flush_timeout` integer — Maximum time interval in milliseconds between buffer flushes in asynchronous mode.
    - `producer_request_acks` -1 | 0 | 1 — The number of acknowledgments the producer requires the leader to have received before considering a request complete. Allowed values: 0 for no acknowledgments; 1 for only the leader; and -1 for the full ISR (In-Sync Replica set).
    - `producer_request_limits_bytes_per_request` integer — Maximum size of a Produce request in bytes.
    - `producer_request_limits_messages_per_request` integer — Maximum number of messages to include into a single producer request.
    - `producer_request_retries_backoff_timeout` integer — Backoff interval between retry attempts in milliseconds.
    - `producer_request_retries_max_attempts` integer — Maximum number of retry attempts per single Produce request.
    - `producer_request_timeout` integer — Time to wait for a Produce response in milliseconds.
    - `timeout` integer — Socket timeout in milliseconds.
    - `topic` string — The default Kafka topic to publish to if the query parameter defined in the `topics_query_arg` does not exist in the request
    - `topics_query_arg` string — The request query parameter name that contains the topics to publish to
  - `consumer` object — If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
    - `id` string
  - `protocols` string[] — A set of strings representing HTTP protocols.
  - `route` object — If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
    - `id` string
  - `service` object — If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
    - `id` string

## Other responses

- `401` — Unauthorized

## Changes

> 7 revisions in range; 1 not diffed.

- **2025-05-01** `daef3e27adf6` — 6 info
  - added the new optional request property `allOf[#/components/schemas/ConfluentPluginConfig]/config/allowed_topics`
  - added the new optional request property `allOf[#/components/schemas/ConfluentPluginConfig]/config/message_by_lua_functions`
  - added the new optional request property `allOf[#/components/schemas/ConfluentPluginConfig]/config/topics_query_arg`
  - added the optional property `allOf[#/components/schemas/ConfluentPluginConfig]/config/allowed_topics` to the response with the `201` status
  - …2 more
- **2025-04-04** `e07a25288f1f` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/kong/apis/kong-enterprise-admin-api/changes/plugins#Confluent/post.md)

---

[API](https://skmtc.dev/kong/apis/kong-enterprise-admin-api.md) · [All operations](https://skmtc.dev/kong/apis/kong-enterprise-admin-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/kong/kong-enterprise-admin-api/revisions/daef3e27adf6/schema)