Create a new Plugin
Create a new Plugin.
Path Parameters
The ID of your runtime group. This variable is available in the Konnect manager
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Body
application/json
Body
Plugin request body
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
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
If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified service.
Show Child Parameters
The Plugin instance name.
Example:rate-limiting-foo
The configuration properties for the Plugin
Show Child Parameters
A list of the request protocols that will trigger this plugin.
Allowed values:httpgrpcgrpcstlstcp
Default:http
Whether the plugin is applied. Default: true.
Default:true
An optional set of strings associated with the Plugin for grouping and filtering.
Response
application/json
Response
Successfully created Plugin
Plugin
A 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.
Authentication
Path Parameters
Body
Delete a Plugin
Delete a Plugin
Path Parameters
The unique identifier of the Plugin to create or update.
Example:response-ratelimiting
The ID of your runtime group. This variable is available in the Konnect manager
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Response
204
Response
Successfully deleted Plugin or the resource didn’t exist
Authentication
Path Parameters
Get a Plugin
Get a Plugin using ID.
Query Parameters
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
Number of resources to be returned.
Default:100
>= 1<= 1000
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 unique identifier of the Plugin to create or update.
Example:response-ratelimiting
The ID of your runtime group. This variable is available in the Konnect manager
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Response
application/json
Response
Successfully fetched Plugin
Plugin
A 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.
Authentication
Path Parameters
Query Parameters
Upsert a Plugin
Create or Update Plugin using ID.
Path Parameters
The unique identifier of the Plugin to create or update.
Example:response-ratelimiting
The ID of your runtime group. This variable is available in the Konnect manager
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Body
application/json
Body
Plugin request body
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
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
If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified service.
Show Child Parameters
The Plugin instance name.
Example:rate-limiting-foo
The configuration properties for the Plugin
Show Child Parameters
A list of the request protocols that will trigger this plugin.
Allowed values:httpgrpcgrpcstlstcp
Default:http
Whether the plugin is applied. Default: true.
Default:true
An optional set of strings associated with the Plugin for grouping and filtering.
Response
application/json
Response
Successfully upserted Plugin
Plugin
A 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.
Authentication
Path Parameters
Body
List all Plugins associated with a route
List all Plugins associated with a a route
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 unique identifier or the name of the route to retrieve.
Example:e94215b0-9198-42ce-bf0b-98afff31b2a7
The ID of your runtime group. This variable is available in the Konnect manager
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Response
200 application/json
Response
A successful response listing Plugins
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
Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page