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

# Create a KafkaLog plugin

`POST /plugins#KafkaLog`

Create a KafkaLog plugin

## Request body

- KafkaLogPlugin — 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` 'kafka-log', 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
    - `authentication` object
      - `mechanism` 'PLAIN' | 'SCRAM-SHA-256' | 'SCRAM-SHA-512' — The SASL authentication mechanism. Supported options: `PLAIN`, `SCRAM-SHA-256` or `SCRAM-SHA-512`.
      - `password` string — Password for SASL authentication.
      - `strategy` 'sasl' — The authentication strategy for the plugin, the only option for the value is `sasl`.
      - `tokenauth` boolean — Enable this to indicate `DelegationToken` authentication
      - `user` string — Username for SASL authentication.
    - `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_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.
    - `custom_fields_by_lua` object — Lua code as a key-value map
    - `keepalive` integer
    - `keepalive_enabled` boolean
    - `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 Produce 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
    - `security` object
      - `certificate_id` string — UUID of certificate entity for mTLS authentication.
      - `ssl` boolean — Enables TLS.
    - `timeout` integer — Socket timeout in milliseconds.
    - `topic` string — The Kafka topic 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 list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls.
  - `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 KafkaLog plugin

- KafkaLogPlugin — 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` 'kafka-log', 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
    - `authentication` object
      - `mechanism` 'PLAIN' | 'SCRAM-SHA-256' | 'SCRAM-SHA-512' — The SASL authentication mechanism. Supported options: `PLAIN`, `SCRAM-SHA-256` or `SCRAM-SHA-512`.
      - `password` string — Password for SASL authentication.
      - `strategy` 'sasl' — The authentication strategy for the plugin, the only option for the value is `sasl`.
      - `tokenauth` boolean — Enable this to indicate `DelegationToken` authentication
      - `user` string — Username for SASL authentication.
    - `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_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.
    - `custom_fields_by_lua` object — Lua code as a key-value map
    - `keepalive` integer
    - `keepalive_enabled` boolean
    - `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 Produce 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
    - `security` object
      - `certificate_id` string — UUID of certificate entity for mTLS authentication.
      - `ssl` boolean — Enables TLS.
    - `timeout` integer — Socket timeout in milliseconds.
    - `topic` string — The Kafka topic 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 list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls.
  - `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-04-04** `e07a25288f1f` — 2 breaking, 1 warning, 10 info
  - added `#/components/schemas/PluginBase` to the request body `allOf` list
  - request body became required
  - removed `#/components/schemas/Plugin` from the request body `allOf` list
  - added the new optional request property `allOf[#/components/schemas/KafkaLogPluginConfig]/consumer`
  - …9 more
- **2024-11-26** `99e71588eb61` — 4 breaking, 1 warning, 25 info
  - added the new required request property `allOf[#/components/schemas/Plugin]/config`
  - added the new required request property `allOf[#/components/schemas/Plugin]/name`
  - the `allOf[#/components/schemas/Plugin]/` request property type/format changed from ``/`` to `object`/``
  - the `allOf[#/components/schemas/Plugin]/` response's property type/format changed from ``/`` to `object`/`` for status `201`
  - …26 more
- **2024-09-11** `5bd52189d290` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/kong/apis/kong-enterprise-admin-api/changes/plugins#KafkaLog/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)