ACLs3

Add-Ons4

API4

API Documentation4

API Implementation3

API Product Documentation4

API Product Version Specification4

API Product Versions4

API Products4

API Publication3

API Specification4

API Version4

API-keys3

App Auth Strategies4

Application Registrations4

Applications4

Assets4

Audit Logs7

Auth Server4

Auth Server Claims4

Auth Server Clients8

Auth Server Scopes4

Auth Settings9

Basic-auth credentials3

CA Certificates4

Catalog Services4

Centrally Managed Consumers4

Centrally Managed Keys3

Certificates4

Cloned Plugins4

CMEK3

Config Store Secrets4

Config Stores4

Consumer Groups6

Consumers4

Control Plane Groups2

Control Planes6

Custom Domains3

Custom Plugin Schemas4

CustomPlugins4

Data-Plane Group Configurations2

DCR Providers4

DP Certificates4

Event Gateway Backend Clusters4

Event Gateway DataPlane Certificates4

Event Gateway Listener Policies8

Event Gateway Listeners4

Event Gateway Schema Registries4

Event Gateway Static Keys3

Event Gateway TLS Trust Bundles4

Event Gateway Virtual Cluster Consume Policies20

Event Gateway Virtual Cluster Policies4

Event Gateway Virtual Cluster Produce Policies16

Event Gateway Virtual Clusters4

Event Gateways4

GraphQL Cost Decorations1

HMAC-auth credentials3

Integration Instance Auth Config3

Integration Instance Auth Credentials3

Integration Instances4

JWTs3

Keys4

KeySets4

Mesh5

MTLS-auth credentials3

Networks5

Pages4

Partials4

Personal Access Tokens2

Platform IPs1

Plugins449

Portal Appearance2

Portal Audit Logs3

Portal Auth Settings9

Portal Custom Domains4

Portal Customization2

Portal Developers4

Portal Product Versions3

Portal Team Roles2

Portal Teams4

Portals10

Portals IP Allow List4

Private DNS3

Provider Accounts1

Realms4

Roles6

Routes8

Serverless Cloud Gateways3

Services4

Snippets4

SNIs4

System Accounts5

System Accounts - Access Tokens4

System Accounts - Roles3

System Accounts - Team Membership2

Targets3

Team Membership2

Teams5

Transit Gateways4

Upstreams4

Vaults4

patchReset Auth Settings

Custom Plugin Schemas

Create or update a custom plugin schema

Create or update an individual custom plugin schema.

put/v2/control-planes/{controlPlaneId}/core-entities/plugin-schemas/{name}

Request body

lua_schemastring required

The custom plugin schema; jq -Rs '.' schema.lua.

Example request

{
  "lua_schema": "return { name = \"myplugin\", fields = { { config = { type = \"record\", fields = { } } } } }"
}

Response

A response for a single custom plugin schema.

Example response

{
  "item": {
    "lua_schema": "return { name = \\\"myplugin\\\", fields = { { config = { type = \\\"record\\\", fields = { } } } } }",
    "name": "myplugin",
    "created_at": 1422386534,
    "updated_at": 1422412345
  }
}

Changes

Changed in 3 of the 52 revisions of this API.71910

Aug 22, 202596118a9cd7f43See the full diff
- ▲
  the response property item became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property item/lua_schema became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property item/name became nullable for the status 200
  response-property-became-nullable
This revision also has 7 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jun 27, 20259f695af251021See the full diff
- ○
  added the non-success response with the status 400
  response-non-success-status-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jun 19, 202560ce7598bbd04199See the full diff
- ▲
  the response's body type/format changed from object/ to / for status 401
  response-body-type-changed
- ▲
  media type application/problem+json was changed to a more general media type application/json for the response status 401
  response-media-type-name-generalized
- ▲
  media type application/problem+json was changed to a more general media type application/json for the response status 403
  response-media-type-name-generalized
- ▲
  media type application/problem+json was changed to a more general media type application/json for the response status 404
  response-media-type-name-generalized
- ●
  removed the optional property allOf[subschema #2]/detail from the response with the 401 status
  response-optional-property-removed
- ●
  removed the optional property allOf[subschema #2]/detail from the response with the 403 status
  response-optional-property-removed
- ●
  removed the optional property allOf[subschema #2]/detail from the response with the 404 status
  response-optional-property-removed
- ●
  removed the optional property allOf[subschema #2]/instance from the response with the 401 status
  response-optional-property-removed
- ●
  removed the optional property allOf[subschema #2]/instance from the response with the 403 status
  response-optional-property-removed
- ●
  removed the optional property allOf[subschema #2]/instance from the response with the 404 status
  response-optional-property-removed
- ●
  removed the optional property allOf[subschema #2]/status from the response with the 401 status
  response-optional-property-removed
- ●
  removed the optional property allOf[subschema #2]/status from the response with the 403 status
  response-optional-property-removed
- ●
  removed the optional property allOf[subschema #2]/status from the response with the 404 status
  response-optional-property-removed
- ●
  removed the optional property allOf[subschema #2]/title from the response with the 401 status
  response-optional-property-removed
- ●
  removed the optional property allOf[subschema #2]/title from the response with the 403 status
  response-optional-property-removed
- ●
  removed the optional property allOf[subschema #2]/title from the response with the 404 status
  response-optional-property-removed
- ●
  removed the optional property allOf[subschema #2]/type from the response with the 401 status
  response-optional-property-removed
- ●
  removed the optional property allOf[subschema #2]/type from the response with the 403 status
  response-optional-property-removed
- ●
  removed the optional property allOf[subschema #2]/type from the response with the 404 status
  response-optional-property-removed
- ●
  removed the optional property detail from the response with the 401 status
  response-optional-property-removed
- ●
  removed the optional property instance from the response with the 401 status
  response-optional-property-removed
- ●
  removed the optional property status from the response with the 401 status
  response-optional-property-removed
- ●
  removed the optional property title from the response with the 401 status
  response-optional-property-removed
- ○
  added KonnectCPLegacyBaseError to the response body allOf list for the response status 401
  response-body-all-of-added
- ○
  added KonnectCPLegacyBaseError to the response body allOf list for the response status 403
  response-body-all-of-added
- ○
  added KonnectCPLegacyBaseError to the response body allOf list for the response status 404
  response-body-all-of-added
- ○
  removed BaseError from the response body allOf list for the response status 401
  response-body-all-of-removed
- ○
  removed BaseError from the response body allOf list for the response status 403
  response-body-all-of-removed
- ○
  removed BaseError from the response body allOf list for the response status 404
  response-body-all-of-removed
- ○
  added the optional property allOf[subschema #2]/message to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property allOf[subschema #2]/message to the response with the 403 status
  response-optional-property-added
- ○
  added the optional property allOf[subschema #2]/message to the response with the 404 status
  response-optional-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history