Get a custom plugin schema

Returns information about a custom plugin from a given name.

get

Path Parameters

runtimeGroupIdstringrequired

The ID of your runtime group. 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/runtime-groups/{runtimeGroupId}/core-entities/plugin-schemas/{name}
 
application/json

Delete custom plugin schema

Delete an individual custom plugin schema.

delete

Path Parameters

runtimeGroupIdstringrequired

The ID of your runtime group. This variable is available in the Konnect manager

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

namestringrequired

The custom plugin name

Example:myplugin

Response

No Content

delete/runtime-groups/{runtimeGroupId}/core-entities/plugin-schemas/{name}
 

Create or update a custom plugin schema

Create or update an individual custom plugin schema.

put

Path Parameters

runtimeGroupIdstringrequired

The ID of your runtime group. 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 = { } } } } }

Response

application/json

A response for a single custom plugin schema.

itemobject
Show Child Parameters
put/runtime-groups/{runtimeGroupId}/core-entities/plugin-schemas/{name}

Body

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

CA-Certificate

object

A CA certificate object represents a trusted CA. These objects are used by Kong to verify the validity of a client or server certificate. CA Certificates can be both tagged and filtered by tags.

certstring

PEM-encoded public certificate of the CA.

Example:-----BEGIN CERTIFICATE-----...

cert_digeststring

SHA256 hex digest of the public certificate.

Example:c641e28d77e93544f2fa87b2cf3f3d51...

created_atinteger

Unix epoch when the resource was created.

Example:1422386534

updated_atinteger

Unix epoch when the resouce was updated.

Example:1422386534

idstring(uuid)

Example:04fbeacf-a9f1-4a5d-ae4a-b0407445db3f

tagsarray[string]

An optional set of strings associated with the Certificate for grouping and filtering.

Example:[user-level, low-priority]

Example

Certificate

object

A certificate object represents a public certificate. These fields are referenceable, and can be stored as secrets in a vault. References must follow a specific format.

certstring

PEM-encoded public certificate chain of the SSL key This field is referenceable and can be stored in a vault. References must follow a specific format.

Example:-----BEGIN CERTIFICATE-----\ncertificate-content\n-----END CERTIFICATE-----

cert_altstring

PEM-encoded public certificate chain of the alternate SSL key pair. This should only be set if you have both RSA and ECDSA types of certificate available and would like Kong to prefer serving using ECDSA certs.

Example:-----BEGIN CERTIFICATE-----...

created_atinteger

Unix epoch when the resource was created.

Example:1422386534

updated_atinteger

Unix epoch when the resouce was updated.

Example:1422386534

idstring(uuid)

The UUID representation of the certificate object.

Example:7fca84d6-7d37-4a74-a7b0-93e576089a41

keystring

PEM-encoded private key of the SSL key pair. This field is referenceable, which means it can be securely stored as a secret in a vault. References must follow a specific format.

Example: -----BEGIN RSA PRIVATE KEY-----...

key_altstring

PEM-encoded private key of the alternate SSL key pair. This should only be set if you have both RSA and ECDSA types of certificate available and would like Kong to prefer serving using ECDSA certs when client advertises support for it. This field is referenceable, which means it can be securely stored as a secret in a vault. References must follow a specific format.

Example:-----BEGIN EC PRIVATE KEY-----...

tagsarray[string]

An optional set of strings associated with the Certificate for grouping and filtering.

Example:user-level

Example