Sign in
Plugins

Create a KafkaLog plugin

Create a KafkaLog plugin

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

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-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.

Response

Created 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 18 of the 52 revisions of this API.534127

  • 36da5cb9a67413See the full diff
    • ●

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

      response-property-enum-value-added

    • ○

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

      new-optional-request-property

    • ○

      added the new OAUTHBEARER enum value to the request property allOf[KafkaLogPluginConfig]/config/authentication/mechanism

      request-property-enum-value-added

    • ○

      added the optional property allOf[KafkaLogPluginConfig]/config/authentication/oauthbearer to the response with the 201 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 201

      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 201 status

      response-optional-property-added

  • ad02b4e24eb22See the full diff
    • ○

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

      new-optional-request-property

    • ○

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

      response-optional-property-added

  • 28774c89f2cb22See the full diff
    • ▲

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

      response-property-became-nullable

    • ▲

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

      response-property-became-nullable

    • ○

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

      request-property-became-nullable

    • ○

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

      request-property-became-nullable

  • 19e869275e28417See the full diff
    • ▲

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

      request-property-type-changed

    • ▲

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

      response-property-became-nullable

    • ▲

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

      response-property-became-optional

    • ▲

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

      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 201

      response-property-enum-value-added

    • ○

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

      new-optional-request-property

    • ○

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

      new-optional-request-property

    • ○

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

      request-property-became-nullable

    • ○

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

      request-property-became-optional

    • ○

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

      request-property-enum-value-added

    • ○

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

      response-optional-property-added

    • ○

      added the optional property allOf[KafkaLogPluginConfig]/config/schema_registry/confluent/authentication/oauth2_client to the response with the 201 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

  • 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

  • 96118a9cd7f42456See the full diff
    • ▲

      the response property allOf[KafkaLogPluginConfig]/config/authentication became nullable for the status 201

      response-property-became-nullable

    • ▲

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

      response-property-became-nullable

    • ▲

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

      response-property-became-nullable

    • ▲

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

      response-property-became-nullable

    • ▲

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

      response-property-became-nullable

    • ▲

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

      response-property-became-nullable

    • ▲

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

      response-property-became-nullable

    • ▲

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

      response-property-became-nullable

    • ▲

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

      response-property-became-nullable

    • ▲

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

      response-property-became-nullable

    • ▲

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

      response-property-became-nullable

    • ▲

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

      response-property-became-nullable

    • ▲

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

      response-property-became-nullable

    • ▲

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

      response-property-became-nullable

    • ▲

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

      response-property-became-nullable

    • ▲

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

      response-property-became-nullable

    • ▲

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

      response-property-became-nullable

    • ▲

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

      response-property-became-nullable

    • ▲

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

      response-property-became-nullable

    • ▲

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

      response-property-became-nullable

    • ▲

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

      response-property-became-nullable

    • ▲

      the response property allOf[KafkaLogPluginConfig]/config/security/ssl became nullable for the status 201

      response-property-became-nullable

    • ▲

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

      response-property-became-nullable

    • ▲

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

      response-property-became-nullable

    • ○

      the request property allOf[KafkaLogPluginConfig]/config/authentication became nullable

      request-property-became-nullable

    • ○

      the request property allOf[KafkaLogPluginConfig]/config/authentication/password became nullable

      request-property-became-nullable

    • ○

      the request property allOf[KafkaLogPluginConfig]/config/authentication/tokenauth became nullable

      request-property-became-nullable

    • ○

      the request property allOf[KafkaLogPluginConfig]/config/authentication/user became nullable

      request-property-became-nullable

    • ○

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

      request-property-became-nullable

    • ○

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

      request-property-became-nullable

    • ○

      the request property allOf[KafkaLogPluginConfig]/config/custom_fields_by_lua became nullable

      request-property-became-nullable

    • ○

      the request property allOf[KafkaLogPluginConfig]/config/key_query_arg became nullable

      request-property-became-nullable

    • ○

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

      request-property-became-nullable

    • ○

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

      request-property-became-nullable

    • ○

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

      request-property-became-nullable

    • ○

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

      request-property-became-nullable

    • ○

      the request property allOf[KafkaLogPluginConfig]/config/schema_registry/confluent/key_schema/schema_version became nullable

      request-property-became-nullable

    • ○

      the request property allOf[KafkaLogPluginConfig]/config/schema_registry/confluent/key_schema/subject_name became nullable

      request-property-became-nullable

    • ○

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

      request-property-became-nullable

    • ○

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

      request-property-became-nullable

    • ○

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

      request-property-became-nullable

    • ○

      the request property allOf[KafkaLogPluginConfig]/config/schema_registry/confluent/value_schema/schema_version became nullable

      request-property-became-nullable

    • ○

      the request property allOf[KafkaLogPluginConfig]/config/schema_registry/confluent/value_schema/subject_name became nullable

      request-property-became-nullable

    • ○

      the request property allOf[KafkaLogPluginConfig]/config/security became nullable

      request-property-became-nullable

    • ○

      the request property allOf[KafkaLogPluginConfig]/config/security/certificate_id became nullable

      request-property-became-nullable

    • ○

      the request property allOf[KafkaLogPluginConfig]/config/security/ssl 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 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 mode request property default value none was added

      request-property-default-value-added

    • ○

      the producer_async request property default value true was added

      request-property-default-value-added

    • ○

      the producer_async_buffering_limits_messages_in_memory request property default value 50000 was added

      request-property-default-value-added

    • ○

      the producer_async_flush_timeout request property default value 1000 was added

      request-property-default-value-added

    • ○

      the producer_request_acks request property default value 1 was added

      request-property-default-value-added

    • ○

      the producer_request_limits_bytes_per_request request property default value 1048576 was added

      request-property-default-value-added

    • ○

      the producer_request_limits_messages_per_request request property default value 200 was added

      request-property-default-value-added

    • ○

      the producer_request_retries_backoff_timeout request property default value 100 was added

      request-property-default-value-added

    • ○

      the producer_request_retries_max_attempts request property default value 10 was added

      request-property-default-value-added

    • ○

      the producer_request_timeout request property default value 2000 was added

      request-property-default-value-added

    • ○

      the protocols request property default value grpc grpcs http https ws wss 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 enabled response's property default value true was added for the status 201

      response-property-default-value-added

    • ○

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

      response-property-default-value-added

    • ○

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

      response-property-default-value-added

    • ○

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

      response-property-default-value-added

    • ○

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

      response-property-default-value-added

    • ○

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

      response-property-default-value-added

    • ○

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

      response-property-default-value-added

    • ○

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

      response-property-default-value-added

    • ○

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

      response-property-default-value-added

    • ○

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

      response-property-default-value-added

    • ○

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

      response-property-default-value-added

    • ○

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

      response-property-default-value-added

    • ○

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

      response-property-default-value-added

    • ○

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

      response-property-default-value-added

    • ○

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

      response-property-default-value-added

    • ○

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

      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

  • 2c77aeaee5fb37See the full diff
    • ▲

      the request property allOf[KafkaLogPluginConfig]/config became required

      request-property-became-required

    • ▲

      the request property allOf[KafkaLogPluginConfig]/config/topic became required

      request-property-became-required

    • ▲

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

      response-property-became-nullable

    • ○

      added the new optional request property allOf[KafkaLogPluginConfig]/config/key_query_arg

      new-optional-request-property

    • ○

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

      new-optional-request-property

    • ○

      the request property allOf[PluginBase]/tags became nullable

      request-property-became-nullable

    • ○

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

      response-optional-property-added

    • ○

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

      response-optional-property-added

    • ○

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

      response-property-became-required

    • ○

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

      response-property-became-required

  • c308b7426a7c2See the full diff
    • ▲

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

      request-property-type-changed

    • ▲

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

      response-property-type-changed