Sign in
Plugins

Update a KeyAuth plugin

Update a KeyAuth plugin

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

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'key-auth' 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

KeyAuth 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'key-auth' 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.28277

  • 06734a9c491f2See the full diff
    • ○

      the scope request property default value cp was added

      request-property-default-value-added

    • ○

      the scope response's property default value cp was added for the status 200

      response-property-default-value-added

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

  • 36da5cb9a6742See the full diff
    • ○

      added the new optional request property allOf[KeyAuthPluginConfig]/config/principals

      new-optional-request-property

    • ○

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

  • 19e869275e282See the full diff
    • ▲

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

      request-property-type-changed

    • ▲

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

      response-property-type-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

  • 96118a9cd7f4622See the full diff
    • ▲

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

      response-property-became-nullable

    • ▲

      the response property allOf[KeyAuthPluginConfig]/config/anonymous became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[KeyAuthPluginConfig]/config/identity_realms/items/region became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[KeyAuthPluginConfig]/config/realm 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[KeyAuthPluginConfig]/config became nullable

      request-property-became-nullable

    • ○

      the request property allOf[KeyAuthPluginConfig]/config/anonymous became nullable

      request-property-became-nullable

    • ○

      the request property allOf[KeyAuthPluginConfig]/config/identity_realms/items/region became nullable

      request-property-became-nullable

    • ○

      the request property allOf[KeyAuthPluginConfig]/config/realm 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 hide_credentials request property default value false was added

      request-property-default-value-added

    • ○

      the key_in_body request property default value false was added

      request-property-default-value-added

    • ○

      the key_in_header request property default value true was added

      request-property-default-value-added

    • ○

      the key_in_query request property default value true was added

      request-property-default-value-added

    • ○

      the key_names request property default value apikey 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 run_on_preflight request property default value true was added

      request-property-default-value-added

    • ○

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

      response-property-default-value-added

    • ○

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

      response-property-default-value-added

    • ○

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

      response-property-default-value-added

    • ○

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

      response-property-default-value-added

    • ○

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

      response-property-default-value-added

    • ○

      the key_names response's property default value apikey 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 run_on_preflight response's property default value true 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

  • 2c77aeaee5fb11See the full diff
    • ▲

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

      response-property-became-nullable

    • ○

      the request property allOf[PluginBase]/tags became nullable

      request-property-became-nullable

  • c308b7426a7c2See the full diff
    • ▲

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

      request-property-type-changed

    • ▲

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

      response-property-type-changed

  • 69704304ad5f2See the full diff
    • ○

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

      new-optional-request-property

    • ○

      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