Create or update a custom plugin schema
Create or update an individual custom plugin schema.
Path Parameters
The ID of your runtime group. 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 = { } } } } }
Response
application/json
Response
A response for a single custom plugin schema.
Show Child Parameters
Authentication
Path Parameters
Body
CA-Certificate
objectA 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.
PEM-encoded public certificate of the CA.
Example:-----BEGIN CERTIFICATE-----...
SHA256 hex digest of the public certificate.
Example:c641e28d77e93544f2fa87b2cf3f3d51...
Unix epoch when the resource was created.
Example:1422386534
Unix epoch when the resouce was updated.
Example:1422386534
Example:04fbeacf-a9f1-4a5d-ae4a-b0407445db3f
An optional set of strings associated with the Certificate for grouping and filtering.
Example:[user-level, low-priority]
Certificate
objectA 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.
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-----
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-----...
Unix epoch when the resource was created.
Example:1422386534
Unix epoch when the resouce was updated.
Example:1422386534
The UUID representation of the certificate object.
Example:7fca84d6-7d37-4a74-a7b0-93e576089a41
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-----...
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-----...
An optional set of strings associated with the Certificate for grouping and filtering.
Example:user-level
Key
objectA Key object holds a representation of asymmetric keys in various formats. When Kong or a Kong plugin requires a specific public or private key to perform certain operations, it can use this entity.
Unix epoch when the resource was created.
Example:1422386534
The unique identifier or the prefix of the Vault to delete.
Example:24D0DBDA-671C-11ED-BA0B-EF1DCCD3725F
A JSON Web Key represented as a string.
Example:{\alg\:\RSA\, \kid\: \42\, ...}
A unique identifier for a key.
Example:42
Unix epoch when the resouce was updated.
Example:1422386534
A keypair in PEM format.
Show Child Parameters
The id (an UUID) of the key-set with which to associate the key.
Show Child Parameters
An optional set of strings associated with the Key for grouping and filtering.
Plugin
objectA Plugin entity represents a plugin configuration that will be executed during the HTTP request/response lifecycle.
The configuration properties for the Plugin which can be found on the plugins documentation page in the Kong Hub.
If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
Show Child Parameters
Unix epoch when the resource was created.
Whether the plugin is applied.
Default:true
The name of the Plugin that’s going to be added. Currently, the Plugin must be installed in every Kong instance separately.
A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls.
Default:grpc, grpcs, http, https
If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
Show Child Parameters
If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified service. Leave unset for the plugin to activate regardless of the service being matched.
Show Child Parameters
An optional set of strings associated with the Plugin for grouping and filtering.