Sign in
Plugins

Get a KafkaUpstream plugin

Get a KafkaUpstream plugin

get/{workspace}/plugins/{PluginId}#KafkaUpstream

Response

KafkaUpstream 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-upstream' 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 set of strings representing HTTP protocols.

Changes

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

  • 28b1f8a59cdc13See the full diff
    • ●

      added the new OAUTHBEARER enum value to the allOf[KafkaUpstreamPluginConfig]/config/authentication/mechanism response property for the response status 200

      response-property-enum-value-added

    • ○

      added the optional property allOf[KafkaUpstreamPluginConfig]/config/authentication/oauthbearer to the response with the 200 status

      response-optional-property-added

    • ○

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

      response-optional-property-added

    • ○

      added the optional property allOf[KafkaUpstreamPluginConfig]/config/headers to the response with the 200 status

      response-optional-property-added

  • 9555cbb8b2593See the full diff
    • ○

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

  • 65f3141f166211See the full diff
    • ●

      removed the optional property name from the response with the 200 status

      response-optional-property-removed

    • ○

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

  • 740b73588ef41See 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.