---
title: "List all Plugins in a workspace"
url: "https://nov18-dev.movespot.fyi/apis/konnect-control-planes-configuration-dev-3/versions/76e259e8-9e78-4c0e-ab4a-3df25bddc4f1/operations/list-plugin-in-workspace"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-control-planes-configuration-dev-3/versions/76e259e8-9e78-4c0e-ab4a-3df25bddc4f1.md

# List all Plugins in a workspace

`GET` `/control-planes/{controlPlaneId}/core-entities/{workspace}/plugins`

Operation ID: `list-plugin-in-workspace`

List all Plugins in a workspace

## Path parameters

- `controlPlaneId` (string, uuid, required) - The UUID of your control plane. This variable is available in the Konnect manager.
- `workspace` (string, string, required) - The name of the workspace

## Query parameters

- `size` (integer, optional) - Number of resources to be returned.
- `offset` (string, optional) - Offset from which to return the next set of resources. Use the value of the 'offset' field from the response of a list operation as input here to paginate through all the resources
- `tags` (string, optional) - A list of tags to filter the list of resources on. Multiple tags can be concatenated using ',' to mean AND or using '/' to mean OR.

## Responses

- `200` - A successful response listing Plugins
- `401` - Unauthorized

## OpenAPI definition

```yaml
openapi: 3.1.0
info:
  title: Konnect Control Planes Configuration
  version: 3.14.0
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
paths:
  /control-planes/{controlPlaneId}/core-entities/{workspace}/plugins:
    parameters:
      - $ref: "#/components/parameters/controlPlaneId"
    get:
      operationId: list-plugin-in-workspace
      summary: List all Plugins in a workspace
      description: List all Plugins in a workspace
      parameters:
        - $ref: "#/components/parameters/PaginationSize"
        - $ref: "#/components/parameters/PaginationOffset"
        - $ref: "#/components/parameters/PaginationTagsFilter"
        - $ref: "#/components/parameters/Workspace"
      responses:
        "200":
          description: A successful response listing Plugins
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: "#/components/schemas/Plugin"
                  next:
                    $ref: "#/components/schemas/PaginationNextResponse"
                  offset:
                    $ref: "#/components/schemas/PaginationOffsetResponse"
        "401":
          $ref: "#/components/responses/HTTP401Error"
      tags:
        - Plugins
security:
  - konnectAccessToken: []
  - personalAccessToken: []
components:
  parameters:
    controlPlaneId:
      name: controlPlaneId
      in: path
      required: true
      schema:
        type: string
        format: uuid
        example: 9524ec7d-36d9-465d-a8c5-83a3c9390458
      description: The UUID of your control plane. This variable is available in the
        Konnect manager.
    PaginationSize:
      description: Number of resources to be returned.
      in: query
      name: size
      schema:
        type: integer
        default: 100
        maximum: 1000
        minimum: 1
    PaginationOffset:
      allowEmptyValue: true
      description: Offset from which to return the next set of resources. Use the
        value of the 'offset' field from the response of a list operation as
        input here to paginate through all the resources
      in: query
      name: offset
      schema:
        type: string
    PaginationTagsFilter:
      allowEmptyValue: true
      description: A list of tags to filter the list of resources on. Multiple tags
        can be concatenated using ',' to mean AND or using '/' to mean OR.
      example: tag1,tag2
      in: query
      name: tags
      schema:
        type: string
    Workspace:
      description: The name of the workspace
      in: path
      name: workspace
      required: true
      schema:
        type: string
        format: string
        example: team-payments
  schemas:
    Plugin:
      description: A Plugin entity represents a plugin configuration that will be
        executed during the HTTP request/response lifecycle. It is how you can
        add functionalities to Services that run behind Kong, like
        Authentication or Rate Limiting for example. You can find more
        information about how to install and what values each plugin takes by
        visiting the [Kong Hub](https://docs.konghq.com/hub/). When adding a
        Plugin Configuration to a Service, every request made by a client to
        that Service will run said Plugin. If a Plugin needs to be tuned to
        different values for some specific Consumers, you can do so by creating
        a separate plugin instance that specifies both the Service and the
        Consumer, through the `service` and `consumer` fields.
      type: object
      properties:
        __ui_data:
          description: Arbitrary JSON data for UI configuration. Konnect only field, not
            synced to the Gateway.
          type: object
          additionalProperties: true
          nullable: true
          x-go-name: UIData
        condition:
          description: 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.
          type: string
          maxLength: 1024
          nullable: true
        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
          additionalProperties: true
          nullable: true
        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
          nullable: true
          properties:
            id:
              type: string
          x-foreign: true
        consumer_group:
          description: If set, the plugin will activate only for requests where the
            specified group has been authenticated
          type: object
          nullable: true
          properties:
            id:
              type: string
          x-foreign: true
        created_at:
          description: Unix epoch when the resource was created.
          type: integer
          nullable: true
        description:
          description: User-defined entity description. Konnect only field, not synced to
            the Gateway.
          type: string
          nullable: true
        enabled:
          description: Whether the plugin is applied.
          type: boolean
          default: true
          nullable: true
        id:
          description: A string representing a UUID (universally unique identifier).
          type: string
          minLength: 1
          nullable: true
        instance_name:
          description: A unique string representing a UTF-8 encoded name.
          type: string
          nullable: true
        managed_by:
          description: Arbitrary JSON data for client responsible for managing the entity.
            Konnect only field, not synced to the Gateway.
          type: object
          additionalProperties: true
          nullable: true
        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
          minLength: 1
        ordering:
          type: object
          nullable: true
          properties:
            after:
              type: object
              properties:
                access:
                  type: array
                  items:
                    type: string
            before:
              type: object
              properties:
                access:
                  type: array
                  items:
                    type: string
        partials:
          description: A list of partials to be used by the plugin.
          type: array
          items:
            properties:
              id:
                description: A string representing a UUID (universally unique identifier).
                type: string
                minLength: 1
              name:
                description: A unique string representing a UTF-8 encoded name.
                type: string
              path:
                type: string
            type: object
          nullable: true
        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:
            description: A string representing a protocol, such as HTTP or HTTPS.
            enum:
              - grpc
              - grpcs
              - http
              - https
              - tcp
              - tls
              - tls_passthrough
              - udp
              - ws
              - wss
            type: string
          default:
            - grpc
            - grpcs
            - http
            - https
          nullable: true
        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
          nullable: true
          properties:
            id:
              type: string
          x-foreign: true
        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
          nullable: true
          properties:
            id:
              type: string
          x-foreign: true
        tags:
          description: An optional set of strings associated with the Plugin for grouping
            and filtering.
          type: array
          items:
            description: A string representing a tag.
            type: string
          nullable: true
        updated_at:
          description: Unix epoch when the resource was last updated.
          type: integer
          nullable: true
      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
        partials:
          - id: cff1230a-00f7-4ae8-b376-c370f0eb4dae
            name: foo-partial
            path: config.redis
          - id: 129ee345-cba8-4e55-9d6d-93c223ff91ae
            name: bar-partial
            path: config.redis
        protocols:
          - grpc
          - grpcs
          - http
          - https
      additionalProperties: false
      required:
        - name
    PaginationNextResponse:
      description: URI to the next page (may be null)
      type: string
    PaginationOffsetResponse:
      description: Offset is used to paginate through the API. Provide this value to
        the next list operation to fetch the next page
      type: string
    GatewayUnauthorizedError:
      type: object
      properties:
        message:
          type: string
        status:
          type: integer
      required:
        - message
        - status
  responses:
    HTTP401Error:
      description: Unauthorized
      content:
        application/json:
          examples:
            DuplicateApiKey:
              summary: Duplicate API key found
              value:
                message: Duplicate API key found
                status: 401
            InvalidAuthCred:
              summary: Invalid authentication credentials
              value:
                message: Unauthorized
                status: 401
            NoAPIKey:
              summary: No API key found
              value:
                message: No API key found in request
                status: 401
          schema:
            $ref: "#/components/schemas/GatewayUnauthorizedError"
  securitySchemes:
    konnectAccessToken:
      type: http
      scheme: bearer
      description: The Konnect access token is meant to be used by the Konnect
        dashboard and the decK CLI to authenticate with.
    personalAccessToken:
      type: http
      scheme: bearer
      description: The personal access token is meant to be used as an alternative to
        basic-auth when accessing Konnect via APIs. You can generate a Personal
        Access Token (PAT) from the personal access token page in the Konnect
        dashboard.
```
