Create a new CustomPlugin

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

Create a new CustomPlugin

post

Path Parameters

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

Description of the new CustomPlugin for creation

CustomPlugin

* Additional properties are NOT allowed.
created_atinteger

Unix epoch when the resource was created.

handlerstringrequired

The handler for the given custom plugin.

idstring

A string representing a UUID (universally unique identifier).

namestringrequired

The name to associate with the given custom plugin.

schemastringrequired

The schema for the given custom plugin.

tagsarray[string]

A string representing a tag.

updated_atinteger

Unix epoch when the resource was last updated.

Response

application/json

Successfully created CustomPlugin

CustomPlugin

* Additional properties are NOT allowed.
created_atinteger

Unix epoch when the resource was created.

handlerstringrequired

The handler for the given custom plugin.

idstring

A string representing a UUID (universally unique identifier).

namestringrequired

The name to associate with the given custom plugin.

schemastringrequired

The schema for the given custom plugin.

tagsarray[string]

A string representing a tag.

updated_atinteger

Unix epoch when the resource was last updated.

post/control-planes/{controlPlaneId}/core-entities/custom-plugins

Body

{ "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 } } } } } } }" }
 
application/json

Delete a CustomPlugin

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

Delete a CustomPlugin

delete

Path Parameters

CustomPluginIdstringrequired

ID of the CustomPlugin to lookup

controlPlaneIdstring(uuid)required

The UUID of your control plane. This variable is available in the Konnect manager.

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

Response

Successfully deleted CustomPlugin or the resource didn’t exist

delete/control-planes/{controlPlaneId}/core-entities/custom-plugins/{CustomPluginId}
 

Get a CustomPlugin

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

Get a CustomPlugin using ID or name.

get

Path Parameters

CustomPluginIdstringrequired

ID of the CustomPlugin to lookup

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

Successfully fetched CustomPlugin

CustomPlugin

* Additional properties are NOT allowed.
created_atinteger

Unix epoch when the resource was created.

handlerstringrequired

The handler for the given custom plugin.

idstring

A string representing a UUID (universally unique identifier).

namestringrequired

The name to associate with the given custom plugin.

schemastringrequired

The schema for the given custom plugin.

tagsarray[string]

A string representing a tag.

updated_atinteger

Unix epoch when the resource was last updated.

get/control-planes/{controlPlaneId}/core-entities/custom-plugins/{CustomPluginId}
 
application/json

Upsert a CustomPlugin

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

Create or Update CustomPlugin using ID or name.

put

Path Parameters

CustomPluginIdstringrequired

ID of the CustomPlugin to lookup

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

Description of the CustomPlugin

CustomPlugin

* Additional properties are NOT allowed.
created_atinteger

Unix epoch when the resource was created.

handlerstringrequired

The handler for the given custom plugin.

idstring

A string representing a UUID (universally unique identifier).

namestringrequired

The name to associate with the given custom plugin.

schemastringrequired

The schema for the given custom plugin.

tagsarray[string]

A string representing a tag.

updated_atinteger

Unix epoch when the resource was last updated.

Response

application/json

Successfully upserted CustomPlugin

CustomPlugin

* Additional properties are NOT allowed.
created_atinteger

Unix epoch when the resource was created.

handlerstringrequired

The handler for the given custom plugin.

idstring

A string representing a UUID (universally unique identifier).

namestringrequired

The name to associate with the given custom plugin.

schemastringrequired

The schema for the given custom plugin.

tagsarray[string]

A string representing a tag.

updated_atinteger

Unix epoch when the resource was last updated.

put/control-planes/{controlPlaneId}/core-entities/custom-plugins/{CustomPluginId}

Body

{ "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 } } } } } } }" }
 
application/json

Degraphql_routes