---
title: "Get a CustomPlugin"
url: "https://nov18-dev.movespot.fyi/apis/konnect-control-planes-configuration-3/versions/4a9ee72f-47ac-4061-9b08-3290c8d0ce93/operations/get-custom-plugin"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-control-planes-configuration-3/versions/4a9ee72f-47ac-4061-9b08-3290c8d0ce93.md

# Get a CustomPlugin

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

Operation ID: `get-custom-plugin`

**Pre-release Endpoint** This endpoint is currently in beta and is subject to change. Get a CustomPlugin using ID or name.

## Path parameters

- `CustomPluginId` (string, required) - ID of the CustomPlugin to lookup
- `controlPlaneId` (string, uuid, required) - The UUID of your control plane. This variable is available in the Konnect manager.

## Responses

- `200` - Successfully fetched CustomPlugin
- `401` - Unauthorized
- `404` - Resource does not exist

## 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/custom-plugins/{CustomPluginId}:
    parameters:
      - $ref: "#/components/parameters/CustomPluginId"
      - $ref: "#/components/parameters/controlPlaneId"
    get:
      operationId: get-custom-plugin
      summary: Get a CustomPlugin
      description: |-
        **Pre-release Endpoint**
        This endpoint is currently in beta and is subject to change.

        Get a CustomPlugin using ID or name.
      responses:
        "200":
          description: Successfully fetched CustomPlugin
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CustomPlugin"
        "401":
          $ref: "#/components/responses/HTTP401Error"
        "404":
          description: Resource does not exist
      tags:
        - CustomPlugins
security:
  - konnectAccessToken: []
  - personalAccessToken: []
components:
  parameters:
    CustomPluginId:
      description: ID of the CustomPlugin to lookup
      example: ""
      in: path
      name: CustomPluginId
      required: true
      schema:
        type: string
    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.
  schemas:
    CustomPlugin:
      type: object
      properties:
        created_at:
          description: Unix epoch when the resource was created.
          type: integer
          nullable: true
        handler:
          description: The handler for the given custom plugin.
          type: string
        id:
          description: A string representing a UUID (universally unique identifier).
          type: string
          nullable: true
        name:
          description: The name to associate with the given custom plugin.
          type: string
        schema:
          description: The schema for the given custom plugin.
          type: string
        tags:
          description: A set of strings representing tags.
          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:
        handler: return { VERSION = '1.0,0', PRIORITY = 500, access = function(self,
          config) kong.service.request.set_header(config.name, config.value) end
          }
        id: 868346aa-1105-4b77-8346-aa1105fb77c4
        name: set-header
        schema: return { name = 'set-header', fields = { { protocols =
          require('kong.db.schema.typedefs').protocols_http }, { config = { type
          = 'record', fields = { { name = { description = 'The name of the
          header to set.', type = 'string', required = true } }, { value = {
          description = 'The value for the header.', type = 'string', required =
          true } } } } } } }
      additionalProperties: false
      required:
        - handler
        - name
        - schema
    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.
```
