Sign in
Plugins

Update a ConfluentConsume plugin

Update a ConfluentConsume plugin

put/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#ConfluentConsume

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'confluent-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

ConfluentConsume 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'confluent-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 12 of the 52 revisions of this API.455102

  • 36da5cb9a674410See the full diff
    • ▲

      the response property allOf[ConfluentConsumePluginConfig]/config/cluster_api_key became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[ConfluentConsumePluginConfig]/config/cluster_api_secret became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[ConfluentConsumePluginConfig]/config/cluster_api_key became optional for the status 200

      response-property-became-optional

    • ▲

      the response property allOf[ConfluentConsumePluginConfig]/config/cluster_api_secret became optional for the status 200

      response-property-became-optional

    • ○

      added the new optional request property allOf[ConfluentConsumePluginConfig]/config/consumer_group

      new-optional-request-property

    • ○

      added the new optional request property allOf[ConfluentConsumePluginConfig]/config/error_handling

      new-optional-request-property

    • ○

      added the new optional request property allOf[ConfluentConsumePluginConfig]/config/oauthbearer

      new-optional-request-property

    • ○

      the request property allOf[ConfluentConsumePluginConfig]/config/cluster_api_key became nullable

      request-property-became-nullable

    • ○

      the request property allOf[ConfluentConsumePluginConfig]/config/cluster_api_secret became nullable

      request-property-became-nullable

    • ○

      the request property allOf[ConfluentConsumePluginConfig]/config/cluster_api_key became optional

      request-property-became-optional

    • ○

      the request property allOf[ConfluentConsumePluginConfig]/config/cluster_api_secret became optional

      request-property-became-optional

    • ○

      added the optional property allOf[ConfluentConsumePluginConfig]/config/consumer_group to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property allOf[ConfluentConsumePluginConfig]/config/error_handling to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property allOf[ConfluentConsumePluginConfig]/config/oauthbearer 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

  • 62c54f1094bb11See the full diff
    • ▲

      the request property allOf[PluginBase]/partials/items/path became required

      request-property-became-required

    • ○

      the response property allOf[PluginBase]/partials/items/path became required for the status 200

      response-property-became-required

  • 7d6a643707d92See the full diff
    • ○

      added the new optional request property allOf[PluginBase]/condition

      new-optional-request-property

    • ○

      added the optional property allOf[PluginBase]/condition to the response with the 200 status

      response-optional-property-added

  • ad02b4e24eb26See the full diff
    • ○

      added the new optional request property allOf[ConfluentConsumePluginConfig]/config/enforce_latest_offset_reset

      new-optional-request-property

    • ○

      added the new optional request property allOf[ConfluentConsumePluginConfig]/config/security

      new-optional-request-property

    • ○

      the auto_offset_reset request property default value changed from latest to earliest

      request-property-default-value-changed

    • ○

      added the optional property allOf[ConfluentConsumePluginConfig]/config/enforce_latest_offset_reset to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property allOf[ConfluentConsumePluginConfig]/config/security to the response with the 200 status

      response-optional-property-added

    • ○

      the auto_offset_reset response's property default value changed from latest to earliest for the status 200

      response-property-default-value-changed

  • 28774c89f2cb44See the full diff
    • ▲

      the response property allOf[ConfluentConsumePluginConfig]/config/schema_registry/confluent/authentication/oauth2/token_headers became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[ConfluentConsumePluginConfig]/config/schema_registry/confluent/authentication/oauth2/token_post_args became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[ConfluentConsumePluginConfig]/config/topics/items/schema_registry/confluent/authentication/oauth2/token_headers became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[ConfluentConsumePluginConfig]/config/topics/items/schema_registry/confluent/authentication/oauth2/token_post_args became nullable for the status 200

      response-property-became-nullable

    • ○

      the request property allOf[ConfluentConsumePluginConfig]/config/schema_registry/confluent/authentication/oauth2/token_headers became nullable

      request-property-became-nullable

    • ○

      the request property allOf[ConfluentConsumePluginConfig]/config/schema_registry/confluent/authentication/oauth2/token_post_args became nullable

      request-property-became-nullable

    • ○

      the request property allOf[ConfluentConsumePluginConfig]/config/topics/items/schema_registry/confluent/authentication/oauth2/token_headers became nullable

      request-property-became-nullable

    • ○

      the request property allOf[ConfluentConsumePluginConfig]/config/topics/items/schema_registry/confluent/authentication/oauth2/token_post_args became nullable

      request-property-became-nullable

  • 19e869275e288527See the full diff
    • ▲

      the allOf[ConfluentConsumePluginConfig]/name request property type/format changed from string/ to /

      request-property-type-changed

    • ▲

      the response property allOf[ConfluentConsumePluginConfig]/config/schema_registry/confluent/authentication became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[ConfluentConsumePluginConfig]/config/topics/items/schema_registry became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[ConfluentConsumePluginConfig]/config/topics/items/schema_registry/confluent/authentication became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[ConfluentConsumePluginConfig]/config/schema_registry/confluent/authentication became optional for the status 200

      response-property-became-optional

    • ▲

      the response property allOf[ConfluentConsumePluginConfig]/config/topics/items/schema_registry became optional for the status 200

      response-property-became-optional

    • ▲

      the response property allOf[ConfluentConsumePluginConfig]/config/topics/items/schema_registry/confluent/authentication became optional for the status 200

      response-property-became-optional

    • ▲

      the allOf[ConfluentConsumePluginConfig]/name response's property type/format changed from string/ to / for status 200

      response-property-type-changed

    • ●

      added the new oauth2 enum value to the allOf[ConfluentConsumePluginConfig]/config/schema_registry/confluent/authentication/mode response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new oauth2 enum value to the allOf[ConfluentConsumePluginConfig]/config/topics/items/schema_registry/confluent/authentication/mode response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new websocket enum value to the allOf[ConfluentConsumePluginConfig]/config/mode response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new ws enum value to the allOf[ConfluentConsumePluginConfig]/protocols/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new wss enum value to the allOf[ConfluentConsumePluginConfig]/protocols/items/ response property for the response status 200

      response-property-enum-value-added

    • ○

      added the new optional request property allOf[ConfluentConsumePluginConfig]/config/dlq_topic

      new-optional-request-property

    • ○

      added the new optional request property allOf[ConfluentConsumePluginConfig]/config/enable_dlq

      new-optional-request-property

    • ○

      added the new optional request property allOf[ConfluentConsumePluginConfig]/config/message_by_lua_functions

      new-optional-request-property

    • ○

      added the new optional request property allOf[ConfluentConsumePluginConfig]/config/schema_registry/confluent/authentication/oauth2

      new-optional-request-property

    • ○

      added the new optional request property allOf[ConfluentConsumePluginConfig]/config/schema_registry/confluent/authentication/oauth2_client

      new-optional-request-property

    • ○

      added the new optional request property allOf[ConfluentConsumePluginConfig]/config/topics/items/schema_registry/confluent/authentication/oauth2

      new-optional-request-property

    • ○

      added the new optional request property allOf[ConfluentConsumePluginConfig]/config/topics/items/schema_registry/confluent/authentication/oauth2_client

      new-optional-request-property

    • ○

      the request property allOf[ConfluentConsumePluginConfig]/config/schema_registry/confluent/authentication became nullable

      request-property-became-nullable

    • ○

      the request property allOf[ConfluentConsumePluginConfig]/config/topics/items/schema_registry became nullable

      request-property-became-nullable

    • ○

      the request property allOf[ConfluentConsumePluginConfig]/config/topics/items/schema_registry/confluent/authentication became nullable

      request-property-became-nullable

    • ○

      the request property allOf[ConfluentConsumePluginConfig]/config/schema_registry/confluent/authentication became optional

      request-property-became-optional

    • ○

      the request property allOf[ConfluentConsumePluginConfig]/config/topics/items/schema_registry became optional

      request-property-became-optional

    • ○

      the request property allOf[ConfluentConsumePluginConfig]/config/topics/items/schema_registry/confluent/authentication became optional

      request-property-became-optional

    • ○

      the protocols request property default value changed from grpc grpcs http https to grpc grpcs http https ws wss

      request-property-default-value-changed

    • ○

      added the new oauth2 enum value to the request property allOf[ConfluentConsumePluginConfig]/config/schema_registry/confluent/authentication/mode

      request-property-enum-value-added

    • ○

      added the new oauth2 enum value to the request property allOf[ConfluentConsumePluginConfig]/config/topics/items/schema_registry/confluent/authentication/mode

      request-property-enum-value-added

    • ○

      added the new websocket enum value to the request property allOf[ConfluentConsumePluginConfig]/config/mode

      request-property-enum-value-added

    • ○

      added the new ws enum value to the request property allOf[ConfluentConsumePluginConfig]/protocols/items/

      request-property-enum-value-added

    • ○

      added the new wss enum value to the request property allOf[ConfluentConsumePluginConfig]/protocols/items/

      request-property-enum-value-added

    • ○

      added the optional property allOf[ConfluentConsumePluginConfig]/config/dlq_topic to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property allOf[ConfluentConsumePluginConfig]/config/enable_dlq to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property allOf[ConfluentConsumePluginConfig]/config/message_by_lua_functions to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property allOf[ConfluentConsumePluginConfig]/config/schema_registry/confluent/authentication/oauth2 to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property allOf[ConfluentConsumePluginConfig]/config/schema_registry/confluent/authentication/oauth2_client to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property allOf[ConfluentConsumePluginConfig]/config/topics/items/schema_registry/confluent/authentication/oauth2 to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property allOf[ConfluentConsumePluginConfig]/config/topics/items/schema_registry/confluent/authentication/oauth2_client to the response with the 200 status

      response-optional-property-added

    • ○

      the protocols response's property default value changed from grpc grpcs http https to grpc grpcs http https ws wss for the status 200

      response-property-default-value-changed

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • f030590166225See the full diff
    • ▲

      the request property allOf[PluginBase]/partials/items/name became not nullable

      request-property-became-not-nullable

    • ▲

      the request property allOf[PluginBase]/partials/items/path became not nullable

      request-property-became-not-nullable

    • ▲

      the allOf[PluginBase]/id request property's minLength was increased from 0 to 1

      request-property-min-length-increased

    • ▲

      the allOf[PluginBase]/name request property's minLength was increased from 0 to 1

      request-property-min-length-increased

    • ▲

      the allOf[PluginBase]/partials/items/id request property's minLength was increased from 0 to 1

      request-property-min-length-increased

  • 96118a9cd7f41541See the full diff
    • ▲

      the response property allOf[ConfluentConsumePluginConfig]/config/bootstrap_servers became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[ConfluentConsumePluginConfig]/config/cluster_name became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[ConfluentConsumePluginConfig]/config/confluent_cloud_api_key became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[ConfluentConsumePluginConfig]/config/confluent_cloud_api_secret became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[ConfluentConsumePluginConfig]/config/schema_registry became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[ConfluentConsumePluginConfig]/config/schema_registry/confluent became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[ConfluentConsumePluginConfig]/config/schema_registry/confluent/authentication/basic became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[ConfluentConsumePluginConfig]/config/schema_registry/confluent/ttl became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[ConfluentConsumePluginConfig]/config/schema_registry/confluent/url became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[ConfluentConsumePluginConfig]/config/topics/items/schema_registry/confluent became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[ConfluentConsumePluginConfig]/config/topics/items/schema_registry/confluent/authentication/basic became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[ConfluentConsumePluginConfig]/config/topics/items/schema_registry/confluent/ttl became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[ConfluentConsumePluginConfig]/config/topics/items/schema_registry/confluent/url became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[PluginBase]/partials/items/name became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[PluginBase]/partials/items/path became nullable for the status 200

      response-property-became-nullable

    • ○

      the request property allOf[ConfluentConsumePluginConfig]/config/bootstrap_servers became nullable

      request-property-became-nullable

    • ○

      the request property allOf[ConfluentConsumePluginConfig]/config/cluster_name became nullable

      request-property-became-nullable

    • ○

      the request property allOf[ConfluentConsumePluginConfig]/config/confluent_cloud_api_key became nullable

      request-property-became-nullable

    • ○

      the request property allOf[ConfluentConsumePluginConfig]/config/confluent_cloud_api_secret became nullable

      request-property-became-nullable

    • ○

      the request property allOf[ConfluentConsumePluginConfig]/config/schema_registry became nullable

      request-property-became-nullable

    • ○

      the request property allOf[ConfluentConsumePluginConfig]/config/schema_registry/confluent became nullable

      request-property-became-nullable

    • ○

      the request property allOf[ConfluentConsumePluginConfig]/config/schema_registry/confluent/authentication/basic became nullable

      request-property-became-nullable

    • ○

      the request property allOf[ConfluentConsumePluginConfig]/config/schema_registry/confluent/ttl became nullable

      request-property-became-nullable

    • ○

      the request property allOf[ConfluentConsumePluginConfig]/config/schema_registry/confluent/url became nullable

      request-property-became-nullable

    • ○

      the request property allOf[ConfluentConsumePluginConfig]/config/topics/items/schema_registry/confluent became nullable

      request-property-became-nullable

    • ○

      the request property allOf[ConfluentConsumePluginConfig]/config/topics/items/schema_registry/confluent/authentication/basic became nullable

      request-property-became-nullable

    • ○

      the request property allOf[ConfluentConsumePluginConfig]/config/topics/items/schema_registry/confluent/ttl became nullable

      request-property-became-nullable

    • ○

      the request property allOf[ConfluentConsumePluginConfig]/config/topics/items/schema_registry/confluent/url became nullable

      request-property-became-nullable

    • ○

      the request property allOf[PluginBase]/partials/items/name became nullable

      request-property-became-nullable

    • ○

      the request property allOf[PluginBase]/partials/items/path became nullable

      request-property-became-nullable

    • ○

      the auto_offset_reset request property default value latest was added

      request-property-default-value-added

    • ○

      the commit_strategy request property default value auto was added

      request-property-default-value-added

    • ○

      the enabled request property default value true was added

      request-property-default-value-added

    • ○

      the keepalive request property default value 60000 was added

      request-property-default-value-added

    • ○

      the keepalive_enabled request property default value false was added

      request-property-default-value-added

    • ○

      the message_deserializer request property default value noop was added

      request-property-default-value-added

    • ○

      the mode request property default value http-get was added

      request-property-default-value-added

    • ○

      the mode request property default value none was added

      request-property-default-value-added

    • ○

      the mode request property default value none was added

      request-property-default-value-added

    • ○

      the protocols request property default value grpc grpcs http https was added

      request-property-default-value-added

    • ○

      the ssl_verify request property default value true was added

      request-property-default-value-added

    • ○

      the ssl_verify request property default value true was added

      request-property-default-value-added

    • ○

      the timeout request property default value 10000 was added

      request-property-default-value-added

    • ○

      the auto_offset_reset response's property default value latest was added for the status 200

      response-property-default-value-added

    • ○

      the commit_strategy response's property default value auto was added for the status 200

      response-property-default-value-added

    • ○

      the enabled response's property default value true was added for the status 200

      response-property-default-value-added

    • ○

      the keepalive response's property default value 60000 was added for the status 200

      response-property-default-value-added

    • ○

      the keepalive_enabled response's property default value false was added for the status 200

      response-property-default-value-added

    • ○

      the message_deserializer response's property default value noop was added for the status 200

      response-property-default-value-added

    • ○

      the mode response's property default value http-get was added for the status 200

      response-property-default-value-added

    • ○

      the mode response's property default value none was added for the status 200

      response-property-default-value-added

    • ○

      the mode response's property default value none was added for the status 200

      response-property-default-value-added

    • ○

      the protocols response's property default value grpc grpcs http https was added for the status 200

      response-property-default-value-added

    • ○

      the ssl_verify response's property default value true was added for the status 200

      response-property-default-value-added

    • ○

      the ssl_verify response's property default value true was added for the status 200

      response-property-default-value-added

    • ○

      the timeout response's property default value 10000 was added for the status 200

      response-property-default-value-added

    This revision also has 7 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 2c77aeaee5fb68See the full diff
    • ▲

      added the new required request property allOf[ConfluentConsumePluginConfig]/config/topics/items/schema_registry

      new-required-request-property

    • ▲

      the request property allOf[ConfluentConsumePluginConfig]/config became required

      request-property-became-required

    • ▲

      the request property allOf[ConfluentConsumePluginConfig]/config/cluster_api_key became required

      request-property-became-required

    • ▲

      the request property allOf[ConfluentConsumePluginConfig]/config/cluster_api_secret became required

      request-property-became-required

    • ▲

      the request property allOf[ConfluentConsumePluginConfig]/config/topics became required

      request-property-became-required

    • ▲

      the response property allOf[PluginBase]/tags became nullable for the status 200

      response-property-became-nullable

    • ○

      added the new optional request property allOf[ConfluentConsumePluginConfig]/config/schema_registry

      new-optional-request-property

    • ○

      the request property allOf[PluginBase]/tags became nullable

      request-property-became-nullable

    • ○

      added the optional property allOf[ConfluentConsumePluginConfig]/config/schema_registry to the response with the 200 status

      response-optional-property-added

    • ○

      the response property allOf[ConfluentConsumePluginConfig]/config became required for the status 200

      response-property-became-required

    • ○

      the response property allOf[ConfluentConsumePluginConfig]/config/cluster_api_key became required for the status 200

      response-property-became-required

    • ○

      the response property allOf[ConfluentConsumePluginConfig]/config/cluster_api_secret became required for the status 200

      response-property-became-required

    • ○

      the response property allOf[ConfluentConsumePluginConfig]/config/topics became required for the status 200

      response-property-became-required

    • ○

      added the required property allOf[ConfluentConsumePluginConfig]/config/topics/items/schema_registry to the response with the 200 status

      response-required-property-added

  • c308b7426a7c2See the full diff
    • ▲

      the allOf[ConfluentConsumePluginConfig]/protocols request property type/format changed from array/ to array/set

      request-property-type-changed

    • ▲

      the allOf[ConfluentConsumePluginConfig]/protocols response's property type/format changed from array/ to array/set for status 200

      response-property-type-changed