Create or update a custom plugin schema in a workspace

Create or update an individual custom plugin schema in a workspace.

put

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

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/{workspace}/plugin-schemas/{name}

Body

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

Config Stores

Config Stores

List all Config Stores for a workspace

Returns a collection of all Config Stores 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

List of Config Stores

ListConfigStoresResponse

metaobjectrequired

Pagination metadata.

Show Child Parameters
dataarray[object]required
Show Child Parameters
get/control-planes/{controlPlaneId}/{workspace}/config-stores
 
application/json

Create Config Store in a workspace

Create a Config Store in 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

Create Config Store Request

The request schema to create a Config Store.

* Additional properties are NOT allowed.
namestring

>= 1 characters<= 100 characters

Example:Config Store

Response

application/json

Config Store

ConfigStore

idstring(uuid)read-only

The Config Store ID.

Example:b9e81174-b5bb-4638-a3c3-8afe61a0abf8

namestring

The name of the Config Store

Example:My Name

created_atstring(date-time)read-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)read-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

post/control-planes/{controlPlaneId}/{workspace}/config-stores

Body

{ "name": "Config Store" }
 
application/json

Get a Config Store in a workspace

Returns a Config Store 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

configStoreIdstring(uuid)required

Config Store identifier

Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

Response

application/json

Config Store

ConfigStore

idstring(uuid)read-only

The Config Store ID.

Example:b9e81174-b5bb-4638-a3c3-8afe61a0abf8

namestring

The name of the Config Store

Example:My Name

created_atstring(date-time)read-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)read-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

get/control-planes/{controlPlaneId}/{workspace}/config-stores/{configStoreId}
 
application/json