---
title: "Plugin"
url: "https://nov18-dev.movespot.fyi/apis/konnect-runtime-groups-configuration-0/versions/af18902c-58f1-49d7-8ec2-9987b4e0d1bd/schemas/Plugin"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-runtime-groups-configuration-0/versions/af18902c-58f1-49d7-8ec2-9987b4e0d1bd.md

# Plugin

A Plugin entity represents a plugin configuration that will be executed during the HTTP request/response lifecycle.

## OpenAPI definition

```yaml
openapi: 3.0.0
info:
  title: Konnect Runtime Groups Configuration
  version: 0.0.1
servers:
  - url: https://us.api.konghq.com/v2
    description: United-States Production region
  - url: https://eu.api.konghq.com/v2
    description: Europe Production region
  - url: https://au.api.konghq.com/v2
    description: Australia Production region
  - url: https://me.api.konghq.com/v2
    description: Middle-East Production region
  - url: https://in.api.konghq.com/v2
    description: India Production region
  - url: https://sg.api.konghq.com/v2
    description: Singapore Production region
components:
  schemas:
    Plugin:
      description: A Plugin entity represents a plugin configuration that will be
        executed during the HTTP request/response lifecycle.
      type: object
      properties:
        config:
          description: The configuration properties for the Plugin which can be found on
            the plugins documentation page in the [Kong
            Hub](https://docs.konghq.com/hub/).
          type: object
        consumer:
          description: If set, the plugin will activate only for requests where the
            specified has been authenticated. (Note that some plugins can not be
            restricted to consumers this way.). Leave unset for the plugin to
            activate regardless of the authenticated Consumer.
          type: object
          additionalProperties: false
          properties:
            id:
              type: string
        created_at:
          description: Unix epoch when the resource was created.
          type: integer
        enabled:
          description: Whether the plugin is applied.
          type: boolean
          default: true
        id:
          type: string
        instance_name:
          type: string
        name:
          description: The name of the Plugin that's going to be added. Currently, the
            Plugin must be installed in every Kong instance separately.
          type: string
        ordering:
          type: object
        protocols:
          description: 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`.
          type: array
          items:
            type: string
          default:
            - grpc
            - grpcs
            - http
            - https
        route:
          description: If set, the plugin will only activate when receiving requests via
            the specified route. Leave unset for the plugin to activate
            regardless of the route being used.
          type: object
          additionalProperties: false
          properties:
            id:
              type: string
        service:
          description: If set, the plugin will only activate when receiving requests via
            one of the routes belonging to the specified service. Leave unset
            for the plugin to activate regardless of the service being matched.
          type: object
          additionalProperties: false
          properties:
            id:
              type: string
        tags:
          description: An optional set of strings associated with the Plugin for grouping
            and filtering.
          type: array
          items:
            type: string
      example:
        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
      title: Plugin
```
