Custom Plugin Schemas
Custom Plugin Schemas
List Custom Plugin Schemas
Returns an array of custom plugins schemas associated with a control plane.
Query Parameters
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
Request the next page of data, starting with the item after this parameter.
Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ
Path Parameters
The UUID of your control plane. This variable is available in the Konnect manager.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Response
application/json
Response
A paginated list response for a collection of custom plugin schemas.
Show Child Parameters
Show Child Parameters
Authentication
Path Parameters
Query Parameters
Upload custom plugin schema
Upload a custom plugin schema associated with a control plane.
Path Parameters
The UUID of your control plane. This variable is available in the Konnect manager.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Body
application/json
Body
The custom plugin schema; jq -Rs '.' schema.lua.
Example:return { name = "myplugin", fields = { { config = { type = "record", fields = { } } } } }
Arbitrary JSON data for client responsible for managing the entity. Konnect only field, not synced to the Gateway.
Response
application/json
Response
A response for a single custom plugin schema.
Show Child Parameters
Authentication
Path Parameters
Body
Create or update a custom plugin schema
Create or update an individual custom plugin schema.
Path Parameters
The UUID of your control plane. This variable is available in the Konnect manager.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
The custom plugin name
Example:myplugin
Body
application/json
Body
The custom plugin schema; jq -Rs '.' schema.lua.
Example:return { name = "myplugin", fields = { { config = { type = "record", fields = { } } } } }
Arbitrary JSON data for client responsible for managing the entity. Konnect only field, not synced to the Gateway.
Response
application/json
Response
A response for a single custom plugin schema.
Show Child Parameters
Authentication
Path Parameters
Body
List Custom Plugin Schemas in a workspace
Returns an array of custom plugin schemas associated with a workspace.
Query Parameters
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
Request the next page of data, starting with the item after this parameter.
Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ
Path Parameters
The name of the workspace
Example:team-payments
The UUID of your control plane. This variable is available in the Konnect manager.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Response
application/json
Response
A paginated list response for a collection of custom plugin schemas.