---
title: "Update a KafkaConsume plugin"
method: PUT
path: "/plugins/{PluginId}#KafkaConsume"
tags: ["Plugins"]
---

# Update a KafkaConsume plugin

`PUT /plugins/{PluginId}#KafkaConsume`

Update a KafkaConsume plugin

## Request body

- KafkaConsumePlugin — 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-consume', 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` or `SCRAM-SHA-256`.
      - `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.
    - `auto_offset_reset` 'earliest' | 'latest' — The offset to start from when there is no initial offset in the consumer group.
    - `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.
    - `commit_strategy` 'auto' | 'off' — The strategy to use for committing offsets.
    - `message_deserializer` 'json' | 'noop' — The deserializer to use for the consumed messages.
    - `mode` 'http-get' | 'server-sent-events' — The mode of operation for the plugin.
    - `security` object
      - `certificate_id` string — UUID of certificate entity for mTLS authentication.
      - `ssl` boolean — Enables TLS.
    - `topics` object[] — The Kafka topics and their configuration you want to consume from.
      - `name` string, required
  - `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 `200`

KafkaConsume plugin

- KafkaConsumePlugin — 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-consume', 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` or `SCRAM-SHA-256`.
      - `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.
    - `auto_offset_reset` 'earliest' | 'latest' — The offset to start from when there is no initial offset in the consumer group.
    - `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.
    - `commit_strategy` 'auto' | 'off' — The strategy to use for committing offsets.
    - `message_deserializer` 'json' | 'noop' — The deserializer to use for the consumed messages.
    - `mode` 'http-get' | 'server-sent-events' — The mode of operation for the plugin.
    - `security` object
      - `certificate_id` string — UUID of certificate entity for mTLS authentication.
      - `ssl` boolean — Enables TLS.
    - `topics` object[] — The Kafka topics and their configuration you want to consume from.
      - `name` string, required
  - `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-05-01** `daef3e27adf6` — 1 info
  - endpoint added

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