CustomPlugins
List all CustomPlugins in a workspace
List all CustomPlugins in a workspace
Query Parameters
Number of resources to be returned.
Default:100
>= 1<= 1000
Offset from which to return the next set of resources. Use the value of the ‘offset’ field from the response of a list operation as input here to paginate through all the resources
A list of tags to filter the list of resources on. Multiple tags can be concatenated using ‘,’ to mean AND or using ‘/’ to mean OR.
Example:tag1,tag2
Path Parameters
The name of the workspace
Example:team-payments
The UUID of your control plane. This variable is available in the Konnect manager.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Response
application/json
Response
A successful response listing CustomPlugins
Example:{"handler":"return { VERSION = '1.0,0', PRIORITY = 500, access = function(self, config) kong.service.request.set_header(config.name, config.value) end }","id":"868346aa-1105-4b77-8346-aa1105fb77c4","name":"set-header","schema":"return { name = 'set-header', fields = { { protocols = require('kong.db.schema.typedefs').protocols_http }, { config = { type = 'record', fields = { { name = { description = 'The name of the header to set.', type = 'string', required = true } }, { value = { description = 'The value for the header.', type = 'string', required = true } } } } } } }"}
Show Child Parameters
URI to the next page (may be null)
Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page
Authentication
Path Parameters
Query Parameters
Create a new CustomPlugin in a workspace
Create a new CustomPlugin in a workspace
Path Parameters
The name of the workspace
Example:team-payments
The UUID of your control plane. This variable is available in the Konnect manager.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Body
application/json
Body
Description of the new CustomPlugin for creation
CustomPlugin
Unix epoch when the resource was created.
User-defined entity description. Konnect only field, not synced to the Gateway.
The handler for the given custom plugin.
A string representing a UUID (universally unique identifier).
Arbitrary JSON data for client responsible for managing the entity. Konnect only field, not synced to the Gateway.
The name to associate with the given custom plugin.
The schema for the given custom plugin.
A string representing a tag.
Unix epoch when the resource was last updated.
Response
application/json
Response
Successfully created CustomPlugin
CustomPlugin
Unix epoch when the resource was created.
User-defined entity description. Konnect only field, not synced to the Gateway.
The handler for the given custom plugin.
A string representing a UUID (universally unique identifier).
Arbitrary JSON data for client responsible for managing the entity. Konnect only field, not synced to the Gateway.
The name to associate with the given custom plugin.
The schema for the given custom plugin.
A string representing a tag.
Unix epoch when the resource was last updated.
Authentication
Path Parameters
Body
Delete a CustomPlugin in a workspace
Delete a CustomPlugin in a workspace
Path Parameters
ID of the CustomPlugin to lookup
The name of the workspace
Example:team-payments
The UUID of your control plane. This variable is available in the Konnect manager.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Response
Response
Successfully deleted CustomPlugin or the resource didn’t exist
Authentication
Path Parameters
Get a CustomPlugin in a workspace
Get a CustomPlugin using ID or name in a workspace.
Path Parameters
The name of the workspace
Example:team-payments
ID of the CustomPlugin to lookup
The UUID of your control plane. This variable is available in the Konnect manager.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Response
application/json
Response
Successfully fetched CustomPlugin
CustomPlugin
Unix epoch when the resource was created.
User-defined entity description. Konnect only field, not synced to the Gateway.
The handler for the given custom plugin.
A string representing a UUID (universally unique identifier).
Arbitrary JSON data for client responsible for managing the entity. Konnect only field, not synced to the Gateway.
The name to associate with the given custom plugin.
The schema for the given custom plugin.
A string representing a tag.
Unix epoch when the resource was last updated.