Get an Expected Config Version

Retrieve the expected config version for this control plane. The expected config version can be used to verify if the config version of a data plane node is up to date with the control plane. The config version will be the same if they are in sync.

get

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

Response

200 application/json

Response body for retrieving the expected config version of the control plane.

expected_config_versionstringrequired

The expected configuration version.

created_atinteger

Date the control plane configuration version was created.

get/control-planes/{controlPlaneId}/expected-config-version
 
200 application/json

Custom Plugin Schemas

Custom Plugin Schemas

List Custom Plugin Schemas

Returns an array of custom plugins schemas associated with a control plane.

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

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/plugin-schemas
 
application/json

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