Delete a Plugin

Delete a Plugin

delete

Path Parameters

plugin_id_or_instance_namestringrequired

The unique identifier of the Plugin to create or update.

Example:response-ratelimiting

runtimeGroupIdstringrequired

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

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

Response

204

Successfully deleted Plugin or the resource didn’t exist

delete/runtime-groups/{runtimeGroupId}/core-entities/plugins/{plugin_id_or_instance_name}
 
204

Get a Plugin

Get a Plugin using ID.

get

Query Parameters

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

sizeinteger

Number of resources to be returned.

Default:100

>= 1<= 1000

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.

Example:tag1,tag2

Path Parameters

plugin_id_or_instance_namestringrequired

The unique identifier of the Plugin to create or update.

Example:response-ratelimiting

runtimeGroupIdstringrequired

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

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

Response

application/json

Successfully fetched Plugin

Plugin

A Plugin entity represents a plugin configuration that will be executed during the HTTP request/response lifecycle.

configobject

The configuration properties for the Plugin which can be found on the plugins documentation page in the Kong Hub.

consumerobject

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.

* Additional properties are NOT allowed.
Show Child Parameters
created_atinteger

Unix epoch when the resource was created.

enabledboolean

Whether the plugin is applied.

Default:true

idstring
instance_namestring
namestring

The name of the Plugin that’s going to be added. Currently, the Plugin must be installed in every Kong instance separately.

orderingobject
protocolsarray[string]

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

routeobject

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.

* Additional properties are NOT allowed.
Show Child Parameters
serviceobject

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.

* Additional properties are NOT allowed.
Show Child Parameters
tagsarray[string]

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

get/runtime-groups/{runtimeGroupId}/core-entities/plugins/{plugin_id_or_instance_name}
 
application/json

Upsert a Plugin

Create or Update Plugin using ID.

put

Path Parameters

plugin_id_or_instance_namestringrequired

The unique identifier of the Plugin to create or update.

Example:response-ratelimiting

runtimeGroupIdstringrequired

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

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

Body

application/json

Plugin request body

namestring | null

The name of the Plugin that’s going to be added. Currently, the Plugin must be installed in every Kong instance separately.

Example:rate-limiting

routeobject

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. Default: null.With form-encoded, the notation is route.id=<route id> or route.name=<route name>. With JSON, use route:{id:<route id>} or route:{name:<route name>}.

Show Child Parameters
serviceobject | null

If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified service.

Show Child Parameters
instance_namestring

The Plugin instance name.

Example:rate-limiting-foo

configobject

The configuration properties for the Plugin

Show Child Parameters
protocolsarray[string]

A list of the request protocols that will trigger this plugin.

Allowed values:httpgrpcgrpcstlstcp

Default:http

enabledboolean

Whether the plugin is applied. Default: true.

Default:true

tagsarray[string]

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

Response

application/json

Successfully upserted Plugin

Plugin

A Plugin entity represents a plugin configuration that will be executed during the HTTP request/response lifecycle.

configobject

The configuration properties for the Plugin which can be found on the plugins documentation page in the Kong Hub.

consumerobject

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.

* Additional properties are NOT allowed.
Show Child Parameters
created_atinteger

Unix epoch when the resource was created.

enabledboolean

Whether the plugin is applied.

Default:true

idstring
instance_namestring
namestring

The name of the Plugin that’s going to be added. Currently, the Plugin must be installed in every Kong instance separately.

orderingobject
protocolsarray[string]

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

routeobject

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.

* Additional properties are NOT allowed.
Show Child Parameters
serviceobject

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.

* Additional properties are NOT allowed.
Show Child Parameters
tagsarray[string]

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

put/runtime-groups/{runtimeGroupId}/core-entities/plugins/{plugin_id_or_instance_name}

Body

{ "name": "rate-limiting", "consumer": "string", "instance_name": "rate-limiting-foo", "config": { "hour": 500, "minute": 500 }, "protocols": [ "http" ], "enabled": true, "tags": [ "string" ] }
 
application/json

List all Plugins associated with a route

List all Plugins associated with a a route

get

Query Parameters

sizeinteger

Number of resources to be returned.

Default:100

>= 1<= 1000

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.

Example:tag1,tag2

Path Parameters

route_idstringrequired

The unique identifier or the name of the route to retrieve.

Example:e94215b0-9198-42ce-bf0b-98afff31b2a7

runtimeGroupIdstringrequired

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

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

Response

200 application/json

A successful response listing Plugins

dataarray[object]

A Plugin entity represents a plugin configuration that will be executed during the HTTP request/response lifecycle.

Example:{"config":{"anonymous":null,"hide_credentials":false,"key_in_body":false,"key_in_header":true,"key_in_query":true,"key_names":["apikey"],"run_on_preflight":true},"enabled":true,"id":"3fd1eea1-885a-4011-b986-289943ff8177","name":"key-auth","protocols":["grpc","grpcs","http","https"]}

Show Child Parameters
offsetstring

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

get/runtime-groups/{runtimeGroupId}/core-entities/routes/{route_id}/plugins
 
200 application/json

Create a new Plugin associated with a route

Create a new Plugin associated with a route

post

Path Parameters

route_idstringrequired

The unique identifier or the name of the route to retrieve.

Example:e94215b0-9198-42ce-bf0b-98afff31b2a7

runtimeGroupIdstringrequired

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

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

Body

application/json

Plugin request body

namestring | null

The name of the Plugin that’s going to be added. Currently, the Plugin must be installed in every Kong instance separately.

Example:rate-limiting

routeobject

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. Default: null.With form-encoded, the notation is route.id=<route id> or route.name=<route name>. With JSON, use route:{id:<route id>} or route:{name:<route name>}.

Show Child Parameters
serviceobject | null

If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified service.

Show Child Parameters
instance_namestring

The Plugin instance name.

Example:rate-limiting-foo

configobject

The configuration properties for the Plugin

Show Child Parameters
protocolsarray[string]

A list of the request protocols that will trigger this plugin.

Allowed values:httpgrpcgrpcstlstcp

Default:http

enabledboolean

Whether the plugin is applied. Default: true.

Default:true

tagsarray[string]

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

Response

application/json

Example response

idstring
namestring

The name of the Plugin that’s going to be added. Currently, the Plugin must be installed in every Kong instance separately.

Example:rate-limiting

created_atinteger

Unix epoch when the resource was created.

routestring | null

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. Default: null.With form-encoded, the notation is route.id=<route id> or route.name=<route name>. With JSON, use route:{id:<route id>} or route:{name:<route name>}.

servicestring | null

If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified service.

consumerstring | null

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.)

instance_namestring

The Plugin instance name.

Example:rate-limiting-foo

configobject

The configuration properties for the Plugin

Show Child Parameters
protocolsarray[string]

A list of the request protocols that will trigger this plugin.

Allowed values:httpgrpcgrpcstlstcp

Default:http

enabledboolean

Whether the plugin is applied. Default: true.

Default:true

tagsarray[string]

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

post/runtime-groups/{runtimeGroupId}/core-entities/routes/{route_id}/plugins

Body

{ "name": "rate-limiting", "consumer": "string", "instance_name": "rate-limiting-foo", "config": { "hour": 500, "minute": 500 }, "protocols": [ "http" ], "enabled": true, "tags": [ "string" ] }
 
application/json