Plugins

Update a KafkaConsume plugin

Update a KafkaConsume plugin

put/{workspace}/plugins/{PluginId}#KafkaConsume

Request body

conditionstring nullable

An expression used for conditional control over plugin execution. If the expression evaluates to true during the request flow, the plugin is executed; otherwise, it is skipped.

created_atinteger nullable

Unix epoch when the resource was created.

enabledboolean nullable

Whether the plugin is applied.

idstring nullable

A string representing a UUID (universally unique identifier).

instance_namestring nullable

A unique string representing a UTF-8 encoded name.

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.

tagsstring[] nullable

An optional set of strings associated with the Plugin for grouping and filtering.

updated_atinteger nullable

Unix epoch when the resource was last updated.

protocolsstring[]

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.

Response

KafkaConsume plugin

conditionstring nullable

An expression used for conditional control over plugin execution. If the expression evaluates to true during the request flow, the plugin is executed; otherwise, it is skipped.

created_atinteger nullable

Unix epoch when the resource was created.

enabledboolean nullable

Whether the plugin is applied.

idstring nullable

A string representing a UUID (universally unique identifier).

instance_namestring nullable

A unique string representing a UTF-8 encoded name.

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.

tagsstring[] nullable

An optional set of strings associated with the Plugin for grouping and filtering.

updated_atinteger nullable

Unix epoch when the resource was last updated.

protocolsstring[]

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.

Changes

Changed in 4 of the 11 revisions of this API.320

Jul 6, 202628b1f8a59cdc17See the full diff
- ●
  added the new OAUTHBEARER enum value to the allOf[KafkaConsumePluginConfig]/config/authentication/mechanism response property for the response status 200
  response-property-enum-value-added
- ○
  added the new optional request property allOf[KafkaConsumePluginConfig]/config/authentication/oauthbearer
  new-optional-request-property
- ○
  added the new optional request property allOf[KafkaConsumePluginConfig]/config/consumer_group
  new-optional-request-property
- ○
  added the new optional request property allOf[KafkaConsumePluginConfig]/config/error_handling
  new-optional-request-property
- ○
  added the new OAUTHBEARER enum value to the request property allOf[KafkaConsumePluginConfig]/config/authentication/mechanism
  request-property-enum-value-added
- ○
  added the optional property allOf[KafkaConsumePluginConfig]/config/authentication/oauthbearer to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property allOf[KafkaConsumePluginConfig]/config/consumer_group to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property allOf[KafkaConsumePluginConfig]/config/error_handling to the response with the 200 status
  response-optional-property-added
Apr 24, 20269555cbb8b25910See the full diff
- ○
  added the new optional request property allOf[KafkaConsumePluginConfig]/config/enforce_latest_offset_reset
  new-optional-request-property
- ○
  added the new optional request property allOf[KafkaConsumePluginConfig]/config/security/ssl_verify
  new-optional-request-property
- ○
  added the new optional request property allOf[PluginBase]/condition
  new-optional-request-property
- ○
  the ssl_verify request property default value changed from false to true
  request-property-default-value-changed
- ○
  the ssl_verify request property default value changed from false to true
  request-property-default-value-changed
- ○
  added the optional property allOf[KafkaConsumePluginConfig]/config/enforce_latest_offset_reset to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property allOf[KafkaConsumePluginConfig]/config/security/ssl_verify to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property allOf[PluginBase]/condition to the response with the 200 status
  response-optional-property-added
- ○
  the ssl_verify response's property default value changed from false to true for the status 200
  response-property-default-value-changed
- ○
  the ssl_verify response's property default value changed from false to true for the status 200
  response-property-default-value-changed
Nov 25, 202565f3141f166222See the full diff
- ●
  removed the request property name
  request-property-removed
- ●
  removed the optional property name from the response with the 200 status
  response-optional-property-removed
- ○
  added the new optional request property allOf[KafkaConsumePluginConfig]/name
  new-optional-request-property
- ○
  added the optional property allOf[KafkaConsumePluginConfig]/name to the response with the 200 status
  response-optional-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Oct 9, 2025740b73588ef41See the full diff
- ○
  endpoint added
  endpoint-added
This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 11 revisions, 1 has no diff computed.