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

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

# Get a custom plugin schema in a workspace

`GET` `/control-planes/{controlPlaneId}/core-entities/{workspace}/plugin-schemas/{name}`

Operation ID: `get-plugin-schema-in-workspace`

Returns information about a custom plugin schema from a given name in a workspace.

## Path parameters

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

## Responses

- `200` - A response for a single custom plugin schema.
- `401` - Unauthorized
- `403` - Forbidden
- `404` - Forbidden

## 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}/plugin-schemas/{name}:
    parameters:
      - $ref: "#/components/parameters/controlPlaneId"
      - name: name
        in: path
        description: The custom plugin name
        required: true
        schema:
          type: string
          example: myplugin
    get:
      operationId: get-plugin-schema-in-workspace
      summary: Get a custom plugin schema in a workspace
      description: Returns information about a custom plugin schema from a given name
        in a workspace.
      parameters:
        - $ref: "#/components/parameters/Workspace"
      responses:
        "200":
          $ref: "#/components/responses/plugin-schemas"
        "401":
          $ref: "#/components/responses/KonnectCPLegacyUnauthorized"
        "403":
          $ref: "#/components/responses/KonnectCPLegacyForbidden"
        "404":
          $ref: "#/components/responses/KonnectCPLegacyNotFound"
      tags:
        - Custom Plugin Schemas
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.
    Workspace:
      description: The name of the workspace
      in: path
      name: workspace
      required: true
      schema:
        type: string
        format: string
        example: team-payments
  responses:
    plugin-schemas:
      description: A response for a single custom plugin schema.
      content:
        application/json:
          schema:
            type: object
            properties:
              item:
                type: object
                properties:
                  lua_schema:
                    description: The custom plugin schema; `jq -Rs '.' schema.lua`.
                    type: string
                    example: return { name = \"myplugin\", fields = { { config = { type =
                      \"record\", fields = { } } } } }
                  name:
                    description: The custom plugin name determined by the custom plugin schema.
                    type: string
                    example: myplugin
                  created_at:
                    description: An ISO-8604 timestamp representation of custom plugin schema
                      creation date.
                    type: integer
                    example: 1422386534
                  updated_at:
                    description: An ISO-8604 timestamp representation of custom plugin schema update
                      date.
                    type: integer
                    example: 1422412345
    KonnectCPLegacyUnauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/KonnectCPLegacyUnauthorizedError"
          examples:
            UnauthorizedExample:
              $ref: "#/components/examples/KonnectCPLegacyUnauthorizedExample"
    KonnectCPLegacyForbidden:
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/KonnectCPLegacyForbiddenError"
          examples:
            UnauthorizedExample:
              $ref: "#/components/examples/KonnectCPLegacyForbiddenExample"
    KonnectCPLegacyNotFound:
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/KonnectCPLegacyNotFoundError"
          examples:
            UnauthorizedExample:
              $ref: "#/components/examples/KonnectCPLegacyNotFoundExample"
  schemas:
    KonnectCPLegacyUnauthorizedError:
      allOf:
        - $ref: "#/components/schemas/KonnectCPLegacyBaseError"
        - type: object
          properties:
            message:
              example: Unauthorized
    KonnectCPLegacyForbiddenError:
      allOf:
        - $ref: "#/components/schemas/KonnectCPLegacyBaseError"
        - type: object
          properties:
            message:
              example: Forbidden
    KonnectCPLegacyNotFoundError:
      allOf:
        - $ref: "#/components/schemas/KonnectCPLegacyBaseError"
        - type: object
          properties:
            message:
              example: Not Found
    KonnectCPLegacyBaseError:
      description: standard error
      type: object
      properties:
        message:
          description: |
            A short summary of the problem.
          type: string
          readOnly: true
      title: Error
  examples:
    KonnectCPLegacyUnauthorizedExample:
      value:
        message: Unauthorized
    KonnectCPLegacyForbiddenExample:
      value:
        message: Forbidden
    KonnectCPLegacyNotFoundExample:
      value:
        message: Not Found
  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.
```
