Plugins

Create a MtlsAuth plugin

Create a MtlsAuth plugin

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

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'mtls-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

Created MtlsAuth 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'mtls-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 16 of the 52 revisions of this API.33488

Jun 11, 202662c54f1094bb11See 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
Apr 24, 20267d6a643707d9128See the full diff
- ▲
  the request property allOf[MtlsAuthPluginConfig]/config/ssl_verify became not nullable
  request-property-became-not-nullable
- ●
  added the new ws enum value to the allOf[MtlsAuthPluginConfig]/protocols/items/ response property for the response status 201
  response-property-enum-value-added
- ●
  added the new wss enum value to the allOf[MtlsAuthPluginConfig]/protocols/items/ response property for the response status 201
  response-property-enum-value-added
- ○
  added the new optional request property allOf[MtlsAuthPluginConfig]/config/san_dirname_matcher
  new-optional-request-property
- ○
  added the new optional request property allOf[PluginBase]/condition
  new-optional-request-property
- ○
  the ssl_verify request property default value false was added
  request-property-default-value-added
- ○
  added the new ws enum value to the request property allOf[MtlsAuthPluginConfig]/protocols/items/
  request-property-enum-value-added
- ○
  added the new wss enum value to the request property allOf[MtlsAuthPluginConfig]/protocols/items/
  request-property-enum-value-added
- ○
  added the optional property allOf[MtlsAuthPluginConfig]/config/san_dirname_matcher to the response with the 201 status
  response-optional-property-added
- ○
  added the optional property allOf[PluginBase]/condition to the response with the 201 status
  response-optional-property-added
- ○
  the ssl_verify response's property default value false was added for the status 201
  response-property-default-value-added
Jan 13, 2026ad02b4e24eb22See the full diff
- ○
  added the new optional request property allOf[MtlsAuthPluginConfig]/config/ssl_verify
  new-optional-request-property
- ○
  added the optional property allOf[MtlsAuthPluginConfig]/config/ssl_verify to the response with the 201 status
  response-optional-property-added
Oct 29, 202519e869275e282See the full diff
- ▲
  the allOf[MtlsAuthPluginConfig]/name request property type/format changed from string/ to /
  request-property-type-changed
- ▲
  the allOf[MtlsAuthPluginConfig]/name response's property type/format changed from string/ to / for status 201
  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
Sep 16, 2025f030590166225See 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
Aug 22, 202596118a9cd7f4830See the full diff
- ▲
  the response property allOf[MtlsAuthPluginConfig]/config/anonymous became nullable for the status 201
  response-property-became-nullable
- ▲
  the response property allOf[MtlsAuthPluginConfig]/config/default_consumer became nullable for the status 201
  response-property-became-nullable
- ▲
  the response property allOf[MtlsAuthPluginConfig]/config/http_proxy_host became nullable for the status 201
  response-property-became-nullable
- ▲
  the response property allOf[MtlsAuthPluginConfig]/config/http_proxy_port became nullable for the status 201
  response-property-became-nullable
- ▲
  the response property allOf[MtlsAuthPluginConfig]/config/https_proxy_host became nullable for the status 201
  response-property-became-nullable
- ▲
  the response property allOf[MtlsAuthPluginConfig]/config/https_proxy_port 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[MtlsAuthPluginConfig]/config/anonymous became nullable
  request-property-became-nullable
- ○
  the request property allOf[MtlsAuthPluginConfig]/config/default_consumer became nullable
  request-property-became-nullable
- ○
  the request property allOf[MtlsAuthPluginConfig]/config/http_proxy_host became nullable
  request-property-became-nullable
- ○
  the request property allOf[MtlsAuthPluginConfig]/config/http_proxy_port became nullable
  request-property-became-nullable
- ○
  the request property allOf[MtlsAuthPluginConfig]/config/https_proxy_host became nullable
  request-property-became-nullable
- ○
  the request property allOf[MtlsAuthPluginConfig]/config/https_proxy_port 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 allow_partial_chain request property default value false was added
  request-property-default-value-added
- ○
  the authenticated_group_by request property default value CN was added
  request-property-default-value-added
- ○
  the cache_ttl request property default value 60 was added
  request-property-default-value-added
- ○
  the cert_cache_ttl request property default value 60000 was added
  request-property-default-value-added
- ○
  the consumer_by request property default value custom_id username was added
  request-property-default-value-added
- ○
  the enabled request property default value true was added
  request-property-default-value-added
- ○
  the http_timeout request property default value 30000 was added
  request-property-default-value-added
- ○
  the protocols request property default value grpc grpcs http https was added
  request-property-default-value-added
- ○
  the revocation_check_mode request property default value IGNORE_CA_ERROR was added
  request-property-default-value-added
- ○
  the send_ca_dn request property default value false was added
  request-property-default-value-added
- ○
  the skip_consumer_lookup request property default value false was added
  request-property-default-value-added
- ○
  the allow_partial_chain response's property default value false was added for the status 201
  response-property-default-value-added
- ○
  the authenticated_group_by response's property default value CN was added for the status 201
  response-property-default-value-added
- ○
  the cache_ttl response's property default value 60 was added for the status 201
  response-property-default-value-added
- ○
  the cert_cache_ttl response's property default value 60000 was added for the status 201
  response-property-default-value-added
- ○
  the consumer_by response's property default value custom_id username was added for the status 201
  response-property-default-value-added
- ○
  the enabled response's property default value true was added for the status 201
  response-property-default-value-added
- ○
  the http_timeout response's property default value 30000 was added for the status 201
  response-property-default-value-added
- ○
  the protocols response's property default value grpc grpcs http https was added for the status 201
  response-property-default-value-added
- ○
  the revocation_check_mode response's property default value IGNORE_CA_ERROR was added for the status 201
  response-property-default-value-added
- ○
  the send_ca_dn response's property default value false was added for the status 201
  response-property-default-value-added
- ○
  the skip_consumer_lookup response's property default value false 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
Jul 22, 20252c77aeaee5fb33See the full diff
- ▲
  the request property allOf[MtlsAuthPluginConfig]/config became required
  request-property-became-required
- ▲
  the request property allOf[MtlsAuthPluginConfig]/config/ca_certificates became required
  request-property-became-required
- ▲
  the response property allOf[PluginBase]/tags became nullable for the status 201
  response-property-became-nullable
- ○
  the request property allOf[PluginBase]/tags became nullable
  request-property-became-nullable
- ○
  the response property allOf[MtlsAuthPluginConfig]/config became required for the status 201
  response-property-became-required
- ○
  the response property allOf[MtlsAuthPluginConfig]/config/ca_certificates became required for the status 201
  response-property-became-required
Jun 17, 2025c308b7426a7c2See the full diff
- ▲
  the allOf[MtlsAuthPluginConfig]/protocols request property type/format changed from array/ to array/set
  request-property-type-changed
- ▲
  the allOf[MtlsAuthPluginConfig]/protocols response's property type/format changed from array/ to array/set for status 201
  response-property-type-changed
May 21, 202569704304ad5f2See 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 201 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
Apr 15, 2025fc6abbc537f326See the full diff
- ▲
  the response property allOf[PluginBase]/created_at became nullable for the status 201
  response-property-became-nullable
- ▲
  the response property allOf[PluginBase]/updated_at became nullable for the status 201
  response-property-became-nullable
- ○
  the request optional property allOf[PluginBase]/created_at became not read-only
  request-optional-property-became-not-read-only
- ○
  the request optional property allOf[PluginBase]/updated_at became not read-only
  request-optional-property-became-not-read-only
- ○
  the request property allOf[PluginBase]/created_at became nullable
  request-property-became-nullable
- ○
  the request property allOf[PluginBase]/updated_at became nullable
  request-property-became-nullable
- ○
  the response optional property allOf[PluginBase]/created_at became not read-only for the status 201
  response-optional-property-became-not-read-only
- ○
  the response optional property allOf[PluginBase]/updated_at became not read-only for the status 201
  response-optional-property-became-not-read-only
This revision also has 7 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history (16 revisions)