Sign in
CustomPlugins

List all CustomPlugins

Pre-release Endpoint This endpoint is currently in beta and is subject to change.

List all CustomPlugins

get/v2/control-planes/{controlPlaneId}/core-entities/custom-plugins

Query parameters

sizeinteger

Number of resources to be returned.

offsetstring

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

tagsstring

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.

Response

A successful response listing CustomPlugins

nextstring

URI to the next page (may be null)

offsetstring

Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page

Example response

{
  "data": [
    {
      "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 } } } } } } }"
    }
  ]
}

Changes

Changed in 2 of the 75 revisions of this API.2