Upload custom plugin schema

Upload a custom plugin schema associated with a control plane.

post

Path Parameters

controlPlaneIdstring(uuid)required

The UUID of your control plane. This variable is available in the Konnect manager.

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

Body

application/json
lua_schemastringrequired

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

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

managed_byobject

Arbitrary JSON data for client responsible for managing the entity. Konnect only field, not synced to the Gateway.

* Additional properties are allowed.

Response

application/json

A response for a single custom plugin schema.

itemobject
Show Child Parameters
post/control-planes/{controlPlaneId}/core-entities/plugin-schemas

Body

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

Create or update a custom plugin schema

Create or update an individual custom plugin schema.

put

Path Parameters

controlPlaneIdstring(uuid)required

The UUID of your control plane. This variable is available in the Konnect manager.

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

namestringrequired

The custom plugin name

Example:myplugin

Body

application/json
lua_schemastringrequired

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

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

managed_byobject

Arbitrary JSON data for client responsible for managing the entity. Konnect only field, not synced to the Gateway.

* Additional properties are allowed.

Response

application/json

A response for a single custom plugin schema.

itemobject
Show Child Parameters
put/control-planes/{controlPlaneId}/core-entities/plugin-schemas/{name}

Body

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

List Custom Plugin Schemas in a workspace

Returns an array of custom plugin schemas associated with a workspace.

get

Query Parameters

page[size]integer

The maximum number of items to include per page. The last page of a collection may include fewer items.

Example:10

page[after]string

Request the next page of data, starting with the item after this parameter.

Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ

Path Parameters

workspacestring(string)required

The name of the workspace

Example:team-payments

controlPlaneIdstring(uuid)required

The UUID of your control plane. This variable is available in the Konnect manager.

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

Response

application/json

A paginated list response for a collection of custom plugin schemas.

itemsarray[object]
Show Child Parameters
pageobject
Show Child Parameters
get/control-planes/{controlPlaneId}/core-entities/{workspace}/plugin-schemas
 
application/json

Upload custom plugin schema in a workspace

Upload a custom plugin schema associated with a workspace.

post

Path Parameters

workspacestring(string)required

The name of the workspace

Example:team-payments

controlPlaneIdstring(uuid)required

The UUID of your control plane. This variable is available in the Konnect manager.

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

Body

application/json
lua_schemastringrequired

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

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

managed_byobject

Arbitrary JSON data for client responsible for managing the entity. Konnect only field, not synced to the Gateway.

* Additional properties are allowed.

Response

application/json

A response for a single custom plugin schema.

itemobject
Show Child Parameters
post/control-planes/{controlPlaneId}/core-entities/{workspace}/plugin-schemas

Body

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

Get a custom plugin schema in a workspace

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

get

Path Parameters

workspacestring(string)required

The name of the workspace

Example:team-payments

controlPlaneIdstring(uuid)required

The UUID of your control plane. This variable is available in the Konnect manager.

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

namestringrequired

The custom plugin name

Example:myplugin

Response

application/json

A response for a single custom plugin schema.

itemobject
Show Child Parameters
get/control-planes/{controlPlaneId}/core-entities/{workspace}/plugin-schemas/{name}
 
application/json