Plugins

Get a Plugin

Get a Plugin using ID.

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

Query parameters

expand_partialsboolean

Expand partials for the plugin.

Response

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

configobject nullable

The configuration properties for the Plugin which can be found on the plugins documentation page in the Kong Hub.

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.

namestring required

The name of the Plugin that's going to be added. Currently, the Plugin must be installed in every Kong instance separately.

protocolsstring[] nullable

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

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.

Example response

{
  "config": {
    "anonymous": null,
    "hide_credentials": false,
    "key_in_body": false,
    "key_in_header": true,
    "key_in_query": true,
    "key_names": [
      "apikey"
    ],
    "run_on_preflight": true
  },
  "enabled": true,
  "id": "3fd1eea1-885a-4011-b986-289943ff8177",
  "name": "key-auth",
  "protocols": [
    "grpc",
    "grpcs",
    "http",
    "https"
  ]
}

Changes

Changed in 8 of the 52 revisions of this API.1022

Apr 24, 20267d6a643707d91See the full diff
- ○
  added the optional property condition to the response with the 200 status
  response-optional-property-added
Dec 16, 202546e7fcea23561See the full diff
- ○
  added the new optional query request parameter expand_partials
  new-optional-request-parameter
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 22, 202596118a9cd7f441See the full diff
- ▲
  the response property ordering/after became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property ordering/after/access became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property ordering/before became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property ordering/before/access became nullable for the status 200
  response-property-became-nullable
- ○
  the enabled 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
Jul 22, 20252c77aeaee5fb1See the full diff
- ▲
  the response property tags became nullable for the status 200
  response-property-became-nullable
Apr 22, 20258b14ad5a46771See the full diff
- ○
  the protocols response's property default value grpc grpcs http https was added for the status 200
  response-property-default-value-added
Apr 15, 2025fc6abbc537f342See the full diff
- ▲
  the response property config became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property created_at became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property updated_at became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property config became optional for the status 200
  response-property-became-optional
- ○
  the response optional property created_at became not read-only for the status 200
  response-optional-property-became-not-read-only
- ○
  the response optional property 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
Nov 11, 202408ead66e9ebb115See the full diff
- ▲
  the response's body type/format changed from / to object/ for status 200
  response-body-type-changed
- ○
  removed PluginWithoutParents subschema #2 from the response body allOf list for the response status 200
  response-body-all-of-removed
- ○
  added the optional property consumer to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property consumer_group to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property created_at to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property enabled to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property id to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property instance_name to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property ordering to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property protocols to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property route to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property service to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property tags to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property updated_at to the response with the 200 status
  response-optional-property-added
- ○
  added the required property config to the response with the 200 status
  response-required-property-added
- ○
  added the required property name to the response with the 200 status
  response-required-property-added
This revision also has 88 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Sep 11, 2024be7c36317ba61See the full diff
- ○
  endpoint added
  endpoint-added
This revision also has 27 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history