Sign in
Plugins

Update a KafkaConsume plugin

Update a KafkaConsume plugin

put/v2/control-planes/{controlPlaneId}/core-entities/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 12 of the 52 revisions of this API.46689

  • 36da5cb9a67417See the full diff
    • ●

      added the new OAUTHBEARER enum value to the ////// response property for the response status

      response-property-enum-value-added

    • ○

      added the new optional request property //////

      new-optional-request-property

    • ○

      added the new optional request property /////

      new-optional-request-property

    • ○

      added the new optional request property /////

      new-optional-request-property

    • ○

      added the new OAUTHBEARER enum value to the request property //////

      request-property-enum-value-added

    • ○

      added the optional property ////// to the response with the status

      response-optional-property-added

    • ○

      added the optional property ///// to the response with the status

      response-optional-property-added

    • ○

      added the optional property ///// to the response with the 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 ////// became required

      request-property-became-required

    • ○

      the response property ////// became required for the status

      response-property-became-required

  • 7d6a643707d92See the full diff
    • ○

      added the new optional request property ////

      new-optional-request-property

    • ○

      added the optional property //// to the response with the status

      response-optional-property-added

  • ad02b4e24eb24See the full diff
    • ○

      added the new optional request property /////

      new-optional-request-property

    • ○

      added the new optional request property //////

      new-optional-request-property

    • ○

      added the optional property ///// to the response with the status

      response-optional-property-added

    • ○

      added the optional property ////// to the response with the status

      response-optional-property-added

  • 28774c89f2cb44See the full diff
    • ▲

      the response property ///////// became nullable for the status

      response-property-became-nullable

    • ▲

      the response property ///////// became nullable for the status

      response-property-became-nullable

    • ▲

      the response property /////////// became nullable for the status

      response-property-became-nullable

    • ▲

      the response property /////////// became nullable for the status

      response-property-became-nullable

    • ○

      the request property ///////// became nullable

      request-property-became-nullable

    • ○

      the request property ///////// became nullable

      request-property-became-nullable

    • ○

      the request property /////////// became nullable

      request-property-became-nullable

    • ○

      the request property /////////// became nullable

      request-property-became-nullable

  • 19e869275e2810421See the full diff
    • ▲

      the request property ///// became not nullable

      request-property-became-not-nullable

    • ▲

      the request property ///// became not nullable

      request-property-became-not-nullable

    • ▲

      the request property ///// became not nullable

      request-property-became-not-nullable

    • ▲

      the //// request property type changed from string to no type

      request-property-type-changed

    • ▲

      the response property /////// became nullable for the status

      response-property-became-nullable

    • ▲

      the response property ///////// became nullable for the status

      response-property-became-nullable

    • ▲

      the response property /////// became optional for the status

      response-property-became-optional

    • ▲

      the response property /////// became optional for the status

      response-property-became-optional

    • ▲

      the response property ///////// became optional for the status

      response-property-became-optional

    • ▲

      the //// response's property type changed from string to no type for status

      response-property-type-changed

    • ●

      removed the request property ////

      request-property-removed

    • ●

      removed the optional property //// from the response with the status

      response-optional-property-removed

    • ●

      added the new oauth2 enum value to the //////// response property for the response status

      response-property-enum-value-added

    • ●

      added the new oauth2 enum value to the ////////// response property for the response status

      response-property-enum-value-added

    • ○

      added the new optional request property /////

      new-optional-request-property

    • ○

      added the new optional request property /////

      new-optional-request-property

    • ○

      added the new optional request property /////

      new-optional-request-property

    • ○

      added the new optional request property ////////

      new-optional-request-property

    • ○

      added the new optional request property ////////

      new-optional-request-property

    • ○

      added the new optional request property //////////

      new-optional-request-property

    • ○

      added the new optional request property //////////

      new-optional-request-property

    • ○

      the request property /////// became nullable

      request-property-became-nullable

    • ○

      the request property ///////// became nullable

      request-property-became-nullable

    • ○

      the request property /////// became optional

      request-property-became-optional

    • ○

      the request property /////// became optional

      request-property-became-optional

    • ○

      the request property ///////// became optional

      request-property-became-optional

    • ○

      added the new oauth2 enum value to the request property ////////

      request-property-enum-value-added

    • ○

      added the new oauth2 enum value to the request property //////////

      request-property-enum-value-added

    • ○

      added the optional property ///// to the response with the status

      response-optional-property-added

    • ○

      added the optional property ///// to the response with the status

      response-optional-property-added

    • ○

      added the optional property ///// to the response with the status

      response-optional-property-added

    • ○

      added the optional property //////// to the response with the status

      response-optional-property-added

    • ○

      added the optional property //////// to the response with the status

      response-optional-property-added

    • ○

      added the optional property ////////// to the response with the status

      response-optional-property-added

    • ○

      added the optional property ////////// to the response with the 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 ////// became not nullable

      request-property-became-not-nullable

    • ▲

      the request property ////// became not nullable

      request-property-became-not-nullable

    • ▲

      the //// request property's minLength was increased from 0 to 1

      request-property-min-length-increased

    • ▲

      the //// request property's minLength was increased from 0 to 1

      request-property-min-length-increased

    • ▲

      the ////// request property's minLength was increased from 0 to 1

      request-property-min-length-increased

  • 96118a9cd7f41939See the full diff
    • ▲

      the response property ///// became nullable for the status

      response-property-became-nullable

    • ▲

      the response property ////// became nullable for the status

      response-property-became-nullable

    • ▲

      the response property ////// became nullable for the status

      response-property-became-nullable

    • ▲

      the response property ////// became nullable for the status

      response-property-became-nullable

    • ▲

      the response property ///// became nullable for the status

      response-property-became-nullable

    • ▲

      the response property ///// became nullable for the status

      response-property-became-nullable

    • ▲

      the response property ////// became nullable for the status

      response-property-became-nullable

    • ▲

      the response property //////// became nullable for the status

      response-property-became-nullable

    • ▲

      the response property /////// became nullable for the status

      response-property-became-nullable

    • ▲

      the response property /////// became nullable for the status

      response-property-became-nullable

    • ▲

      the response property ///// became nullable for the status

      response-property-became-nullable

    • ▲

      the response property ////// became nullable for the status

      response-property-became-nullable

    • ▲

      the response property ////// became nullable for the status

      response-property-became-nullable

    • ▲

      the response property //////// became nullable for the status

      response-property-became-nullable

    • ▲

      the response property ////////// became nullable for the status

      response-property-became-nullable

    • ▲

      the response property ///////// became nullable for the status

      response-property-became-nullable

    • ▲

      the response property ///////// became nullable for the status

      response-property-became-nullable

    • ▲

      the response property ////// became nullable for the status

      response-property-became-nullable

    • ▲

      the response property ////// became nullable for the status

      response-property-became-nullable

    • ○

      the request property ///// became nullable

      request-property-became-nullable

    • ○

      the request property ////// became nullable

      request-property-became-nullable

    • ○

      the request property ////// became nullable

      request-property-became-nullable

    • ○

      the request property ////// became nullable

      request-property-became-nullable

    • ○

      the request property ///// became nullable

      request-property-became-nullable

    • ○

      the request property ///// became nullable

      request-property-became-nullable

    • ○

      the request property ////// became nullable

      request-property-became-nullable

    • ○

      the request property //////// became nullable

      request-property-became-nullable

    • ○

      the request property /////// became nullable

      request-property-became-nullable

    • ○

      the request property /////// became nullable

      request-property-became-nullable

    • ○

      the request property ///// became nullable

      request-property-became-nullable

    • ○

      the request property ////// became nullable

      request-property-became-nullable

    • ○

      the request property ////// became nullable

      request-property-became-nullable

    • ○

      the request property //////// became nullable

      request-property-became-nullable

    • ○

      the request property ////////// became nullable

      request-property-became-nullable

    • ○

      the request property ///////// became nullable

      request-property-became-nullable

    • ○

      the request property ///////// became nullable

      request-property-became-nullable

    • ○

      the request property ////// became nullable

      request-property-became-nullable

    • ○

      the request property ////// became nullable

      request-property-became-nullable

    • ○

      the request property default value latest was added

      request-property-default-value-added

    • ○

      the request property default value auto was added

      request-property-default-value-added

    • ○

      the request property default value true was added

      request-property-default-value-added

    • ○

      the request property default value noop was added

      request-property-default-value-added

    • ○

      the request property default value http-get was added

      request-property-default-value-added

    • ○

      the request property default value none was added

      request-property-default-value-added

    • ○

      the request property default value none was added

      request-property-default-value-added

    • ○

      the request property default value grpc grpcs http https ws wss was added

      request-property-default-value-added

    • ○

      the request property default value true was added

      request-property-default-value-added

    • ○

      the request property default value true was added

      request-property-default-value-added

    • ○

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

      response-property-default-value-added

    • ○

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

      response-property-default-value-added

    • ○

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

      response-property-default-value-added

    • ○

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

      response-property-default-value-added

    • ○

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

      response-property-default-value-added

    • ○

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

      response-property-default-value-added

    • ○

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

      response-property-default-value-added

    • ○

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

      response-property-default-value-added

    • ○

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

      response-property-default-value-added

    • ○

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

      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

  • 2c77aeaee5fb518See the full diff
    • ▲

      added the new required request property ///////

      new-required-request-property

    • ▲

      the request property //// became required

      request-property-became-required

    • ▲

      the request property ///// became required

      request-property-became-required

    • ▲

      the request property ///// became required

      request-property-became-required

    • ▲

      the response property //// became nullable for the status

      response-property-became-nullable

    • ●

      added the new websocket enum value to the ///// response property for the response status

      response-property-enum-value-added

    • ○

      added the new optional request property /////

      new-optional-request-property

    • ○

      the request property //// became nullable

      request-property-became-nullable

    • ○

      added the new websocket enum value to the request property /////

      request-property-enum-value-added

    • ○

      added the optional property ///// to the response with the status

      response-optional-property-added

    • ○

      the response property //// became required for the status

      response-property-became-required

    • ○

      the response property ///// became required for the status

      response-property-became-required

    • ○

      the response property ///// became required for the status

      response-property-became-required

    • ○

      added the required property /////// to the response with the status

      response-required-property-added

  • c308b7426a7c2See the full diff
    • ▲

      the //// request property format changed from no format to set

      request-property-type-changed

    • ▲

      the //// response's property format changed from no format to set for status

      response-property-type-changed