Plugins

Get a KafkaLog plugin

Get a KafkaLog plugin

get/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#KafkaLog

Response

KafkaLog 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-log' 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 15 of the 52 revisions of this API.37251

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

      response-property-enum-value-added

    • added the optional property allOf[KafkaLogPluginConfig]/config/authentication/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

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

      response-property-became-required

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

      response-optional-property-added

    • added the optional property allOf[KafkaLogPluginConfig]/config/security/ssl_verify to the response with the 200 status

      response-optional-property-added

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

      response-property-became-nullable

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

      response-property-became-nullable

  • 19e869275e28312See the full diff
    • the response property allOf[KafkaLogPluginConfig]/config/schema_registry/confluent/authentication became nullable for the status 200

      response-property-became-nullable

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

      response-property-became-optional

    • the allOf[KafkaLogPluginConfig]/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[KafkaLogPluginConfig]/config/schema_registry/confluent/authentication/mode response property for the response status 200

      response-property-enum-value-added

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

      response-optional-property-added

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

      response-optional-property-added

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

  • 96118a9cd7f42416See the full diff
    • the response property allOf[KafkaLogPluginConfig]/config/authentication became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[KafkaLogPluginConfig]/config/authentication/password became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[KafkaLogPluginConfig]/config/authentication/tokenauth became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[KafkaLogPluginConfig]/config/authentication/user became nullable for the status 200

      response-property-became-nullable

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

      response-property-became-nullable

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

      response-property-became-nullable

    • the response property allOf[KafkaLogPluginConfig]/config/custom_fields_by_lua became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[KafkaLogPluginConfig]/config/key_query_arg became nullable for the status 200

      response-property-became-nullable

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

      response-property-became-nullable

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

      response-property-became-nullable

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

      response-property-became-nullable

    • the response property allOf[KafkaLogPluginConfig]/config/schema_registry/confluent/key_schema became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[KafkaLogPluginConfig]/config/schema_registry/confluent/key_schema/schema_version became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[KafkaLogPluginConfig]/config/schema_registry/confluent/key_schema/subject_name became nullable for the status 200

      response-property-became-nullable

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

      response-property-became-nullable

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

      response-property-became-nullable

    • the response property allOf[KafkaLogPluginConfig]/config/schema_registry/confluent/value_schema became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[KafkaLogPluginConfig]/config/schema_registry/confluent/value_schema/schema_version became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[KafkaLogPluginConfig]/config/schema_registry/confluent/value_schema/subject_name became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[KafkaLogPluginConfig]/config/security became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[KafkaLogPluginConfig]/config/security/certificate_id became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[KafkaLogPluginConfig]/config/security/ssl 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 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 mode response's property default value none was added for the status 200

      response-property-default-value-added

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

      response-property-default-value-added

    • the producer_async_buffering_limits_messages_in_memory response's property default value 50000 was added for the status 200

      response-property-default-value-added

    • the producer_async_flush_timeout response's property default value 1000 was added for the status 200

      response-property-default-value-added

    • the producer_request_acks response's property default value 1 was added for the status 200

      response-property-default-value-added

    • the producer_request_limits_bytes_per_request response's property default value 1048576 was added for the status 200

      response-property-default-value-added

    • the producer_request_limits_messages_per_request response's property default value 200 was added for the status 200

      response-property-default-value-added

    • the producer_request_retries_backoff_timeout response's property default value 100 was added for the status 200

      response-property-default-value-added

    • the producer_request_retries_max_attempts response's property default value 10 was added for the status 200

      response-property-default-value-added

    • the producer_request_timeout response's property default value 2000 was added for the status 200

      response-property-default-value-added

    • the protocols response's property default value grpc grpcs http https ws wss 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

  • 2c77aeaee5fb14See the full diff
    • the response property allOf[PluginBase]/tags became nullable for the status 200

      response-property-became-nullable

    • added the optional property allOf[KafkaLogPluginConfig]/config/key_query_arg to the response with the 200 status

      response-optional-property-added

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

      response-optional-property-added

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

      response-property-became-required

    • the response property allOf[KafkaLogPluginConfig]/config/topic became required for the status 200

      response-property-became-required

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

      response-property-type-changed

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

      response-optional-property-added

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