Plugins

Get a VaultAuth plugin

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

Response

VaultAuth 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'vault-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 set of strings representing HTTP protocols.

Changes

Changed in 12 of the 52 revisions of this API.1636

Jun 11, 202662c54f1094bb1See the full diff
- ○
  the response property allOf[PluginBase]/partials/items/path became required for the status 200
  response-property-became-required
Apr 24, 20267d6a643707d91See the full diff
- ○
  added the optional property allOf[PluginBase]/condition to the response with the 200 status
  response-optional-property-added
Oct 29, 202519e869275e2861See the full diff
- ▲
  the response property allOf[VaultAuthPluginConfig]/config became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[VaultAuthPluginConfig]/config/vault became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[VaultAuthPluginConfig]/config became optional for the status 200
  response-property-became-optional
- ▲
  the response property allOf[VaultAuthPluginConfig]/config/vault became optional for the status 200
  response-property-became-optional
- ▲
  the allOf[VaultAuthPluginConfig]/config/vault response's property type/format changed from string/ to object/ for status 200
  response-property-type-changed
- ▲
  the allOf[VaultAuthPluginConfig]/name response's property type/format changed from string/ to / for status 200
  response-property-type-changed
- ○
  added the optional property allOf[VaultAuthPluginConfig]/config/vault/id 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
Aug 22, 202596118a9cd7f437See the full diff
- ▲
  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 response property allOf[VaultAuthPluginConfig]/config/anonymous became nullable for the status 200
  response-property-became-nullable
- ○
  the access_token_name response's property default value access_token was added for the status 200
  response-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 protocols response's property default value grpc grpcs http https 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
- ○
  the secret_token_name response's property default value secret_token was added for the status 200
  response-property-default-value-added
- ○
  the tokens_in_body response's property default value false 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
Jul 22, 20252c77aeaee5fb12See the full diff
- ▲
  the response property allOf[PluginBase]/tags became nullable for the status 200
  response-property-became-nullable
- ○
  the response property allOf[VaultAuthPluginConfig]/config became required for the status 200
  response-property-became-required
- ○
  the response property allOf[VaultAuthPluginConfig]/config/vault became required for the status 200
  response-property-became-required
Jun 17, 2025c308b7426a7c1See the full diff
- ▲
  the allOf[VaultAuthPluginConfig]/protocols response's property type/format changed from array/ to array/set for status 200
  response-property-type-changed
May 21, 202569704304ad5f1See the full diff
- ○
  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
Apr 15, 2025fc6abbc537f322See the full diff
- ▲
  the response property allOf[PluginBase]/created_at became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[PluginBase]/updated_at became nullable for the status 200
  response-property-became-nullable
- ○
  the response optional property allOf[PluginBase]/created_at became not read-only for the status 200
  response-optional-property-became-not-read-only
- ○
  the response optional property allOf[PluginBase]/updated_at became not read-only for the status 200
  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
Mar 5, 2025ceb0484689542See the full diff
- ▲
  the response property allOf[VaultAuthPluginConfig]/route became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[VaultAuthPluginConfig]/service became nullable for the status 200
  response-property-became-nullable
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Feb 10, 2025d833d4dbb1fa5See the full diff
- ○
  added PluginBase to the response body allOf list for the response status 200
  response-body-all-of-added
- ○
  removed Plugin from the response body allOf list for the response status 200
  response-body-all-of-removed
- ○
  added the optional property allOf[VaultAuthPluginConfig]/protocols to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property allOf[VaultAuthPluginConfig]/route to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property allOf[VaultAuthPluginConfig]/service to the response with the 200 status
  response-optional-property-added

Full history (12 revisions)