List all Plugins associated with a Consumer Group
List all Plugins associated with a Consumer Group
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
ID of the Consumer Group to lookup
The UUID of your control plane. 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. It is how you can add functionalities to Services that run behind Kong, like Authentication or Rate Limiting for example. You can find more information about how to install and what values each plugin takes by visiting the Kong Hub. When adding a Plugin Configuration to a Service, every request made by a client to that Service will run said Plugin. If a Plugin needs to be tuned to different values for some specific Consumers, you can do so by creating a separate plugin instance that specifies both the Service and the Consumer, through the service and consumer fields.
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","partials":[{"id":"cff1230a-00f7-4ae8-b376-c370f0eb4dae","name":"foo-partial","path":"config.redis"},{"id":"129ee345-cba8-4e55-9d6d-93c223ff91ae","name":"bar-partial","path":"config.redis"}],"protocols":["grpc","grpcs","http","https"]}
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 Plugin associated with a Consumer Group
Create a new Plugin associated with a Consumer Group
Path Parameters
ID of the Consumer Group to lookup
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 new Plugin for creation
PluginWithoutParents
A Plugin entity represents a plugin configuration that will be executed during the HTTP request/response lifecycle. It is how you can add functionalities to Services that run behind Kong, like Authentication or Rate Limiting for example. You can find more information about how to install and what values each plugin takes by visiting the Kong Hub. When adding a Plugin Configuration to a Service, every request made by a client to that Service will run said Plugin. If a Plugin needs to be tuned to different values for some specific Consumers, you can do so by creating a separate plugin instance that specifies both the Service and the Consumer, through the service and consumer fields.
Arbitrary JSON data for UI configuration. Konnect only field, not synced to the Gateway.
An expression used for conditional control over plugin execution. If the expression evaluates to true during the request flow, the plugin is executed; otherwise, it is skipped.
<= 1024 characters
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
If set, the plugin will activate only for requests where the specified group has been authenticated
Show Child Parameters
Unix epoch when the resource was created.
User-defined entity description. Konnect only field, not synced to the Gateway.
Whether the plugin is applied.
Default:true
A string representing a UUID (universally unique identifier).
>= 1 characters
A unique string representing a UTF-8 encoded name.
Arbitrary JSON data for client responsible for managing the entity. Konnect only field, not synced to the Gateway.
The name of the Plugin that’s going to be added. Currently, the Plugin must be installed in every Kong instance separately.
>= 1 characters
Show Child Parameters
A list of partials to be used by the plugin.
Show Child Parameters
A string representing a protocol, such as HTTP or HTTPS.
Allowed values:grpcgrpcshttphttpstcptlstls_passthroughudpwswss
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
A string representing a tag.
Unix epoch when the resource was last updated.
Response
201 application/json
Response
Successfully created Plugin
Plugin
A Plugin entity represents a plugin configuration that will be executed during the HTTP request/response lifecycle. It is how you can add functionalities to Services that run behind Kong, like Authentication or Rate Limiting for example. You can find more information about how to install and what values each plugin takes by visiting the Kong Hub. When adding a Plugin Configuration to a Service, every request made by a client to that Service will run said Plugin. If a Plugin needs to be tuned to different values for some specific Consumers, you can do so by creating a separate plugin instance that specifies both the Service and the Consumer, through the service and consumer fields.
Arbitrary JSON data for UI configuration. Konnect only field, not synced to the Gateway.
An expression used for conditional control over plugin execution. If the expression evaluates to true during the request flow, the plugin is executed; otherwise, it is skipped.
<= 1024 characters
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
If set, the plugin will activate only for requests where the specified group has been authenticated
Show Child Parameters
Unix epoch when the resource was created.
User-defined entity description. Konnect only field, not synced to the Gateway.
Whether the plugin is applied.
Default:true
A string representing a UUID (universally unique identifier).
>= 1 characters
A unique string representing a UTF-8 encoded name.
Arbitrary JSON data for client responsible for managing the entity. Konnect only field, not synced to the Gateway.
The name of the Plugin that’s going to be added. Currently, the Plugin must be installed in every Kong instance separately.
>= 1 characters
Show Child Parameters
A list of partials to be used by the plugin.
Show Child Parameters
A string representing a protocol, such as HTTP or HTTPS.
Allowed values:grpcgrpcshttphttpstcptlstls_passthroughudpwswss
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
A string representing a tag.
Unix epoch when the resource was last updated.
Authentication
Path Parameters
Body
Get a Plugin associated with a Consumer Group
Get a Plugin associated with a Consumer Group using ID.
Query Parameters
Expand partials for the plugin.
Example:true
Path Parameters
ID of the Consumer Group to lookup
ID of the Plugin to lookup
Example:3473c251-5b6c-4f45-b1ff-7ede735a366d
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 Plugin
Plugin
A Plugin entity represents a plugin configuration that will be executed during the HTTP request/response lifecycle. It is how you can add functionalities to Services that run behind Kong, like Authentication or Rate Limiting for example. You can find more information about how to install and what values each plugin takes by visiting the Kong Hub. When adding a Plugin Configuration to a Service, every request made by a client to that Service will run said Plugin. If a Plugin needs to be tuned to different values for some specific Consumers, you can do so by creating a separate plugin instance that specifies both the Service and the Consumer, through the service and consumer fields.
Arbitrary JSON data for UI configuration. Konnect only field, not synced to the Gateway.
An expression used for conditional control over plugin execution. If the expression evaluates to true during the request flow, the plugin is executed; otherwise, it is skipped.
<= 1024 characters
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
If set, the plugin will activate only for requests where the specified group has been authenticated
Show Child Parameters
Unix epoch when the resource was created.
User-defined entity description. Konnect only field, not synced to the Gateway.
Whether the plugin is applied.
Default:true
A string representing a UUID (universally unique identifier).
>= 1 characters
A unique string representing a UTF-8 encoded name.
Arbitrary JSON data for client responsible for managing the entity. Konnect only field, not synced to the Gateway.
The name of the Plugin that’s going to be added. Currently, the Plugin must be installed in every Kong instance separately.
>= 1 characters
Show Child Parameters
A list of partials to be used by the plugin.
Show Child Parameters
A string representing a protocol, such as HTTP or HTTPS.
Allowed values:grpcgrpcshttphttpstcptlstls_passthroughudpwswss
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
A string representing a tag.
Unix epoch when the resource was last updated.
Authentication
Path Parameters
Query Parameters
Upsert a Plugin associated with a Consumer Group
Create or Update a Plugin associated with a Consumer Group using ID.
Path Parameters
ID of the Consumer Group to lookup
ID of the Plugin to lookup
Example:3473c251-5b6c-4f45-b1ff-7ede735a366d
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 Plugin
PluginWithoutParents
A Plugin entity represents a plugin configuration that will be executed during the HTTP request/response lifecycle. It is how you can add functionalities to Services that run behind Kong, like Authentication or Rate Limiting for example. You can find more information about how to install and what values each plugin takes by visiting the Kong Hub. When adding a Plugin Configuration to a Service, every request made by a client to that Service will run said Plugin. If a Plugin needs to be tuned to different values for some specific Consumers, you can do so by creating a separate plugin instance that specifies both the Service and the Consumer, through the service and consumer fields.
Arbitrary JSON data for UI configuration. Konnect only field, not synced to the Gateway.
An expression used for conditional control over plugin execution. If the expression evaluates to true during the request flow, the plugin is executed; otherwise, it is skipped.
<= 1024 characters
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
If set, the plugin will activate only for requests where the specified group has been authenticated
Show Child Parameters
Unix epoch when the resource was created.
User-defined entity description. Konnect only field, not synced to the Gateway.
Whether the plugin is applied.
Default:true
A string representing a UUID (universally unique identifier).
>= 1 characters
A unique string representing a UTF-8 encoded name.
Arbitrary JSON data for client responsible for managing the entity. Konnect only field, not synced to the Gateway.
The name of the Plugin that’s going to be added. Currently, the Plugin must be installed in every Kong instance separately.
>= 1 characters
Show Child Parameters
A list of partials to be used by the plugin.
Show Child Parameters
A string representing a protocol, such as HTTP or HTTPS.
Allowed values:grpcgrpcshttphttpstcptlstls_passthroughudpwswss
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
A string representing a tag.
Unix epoch when the resource was last updated.
Response
200 application/json
Response
Successfully upserted Plugin
Plugin
A Plugin entity represents a plugin configuration that will be executed during the HTTP request/response lifecycle. It is how you can add functionalities to Services that run behind Kong, like Authentication or Rate Limiting for example. You can find more information about how to install and what values each plugin takes by visiting the Kong Hub. When adding a Plugin Configuration to a Service, every request made by a client to that Service will run said Plugin. If a Plugin needs to be tuned to different values for some specific Consumers, you can do so by creating a separate plugin instance that specifies both the Service and the Consumer, through the service and consumer fields.
Arbitrary JSON data for UI configuration. Konnect only field, not synced to the Gateway.
An expression used for conditional control over plugin execution. If the expression evaluates to true during the request flow, the plugin is executed; otherwise, it is skipped.
<= 1024 characters
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
If set, the plugin will activate only for requests where the specified group has been authenticated
Show Child Parameters
Unix epoch when the resource was created.
User-defined entity description. Konnect only field, not synced to the Gateway.
Whether the plugin is applied.
Default:true
A string representing a UUID (universally unique identifier).
>= 1 characters
A unique string representing a UTF-8 encoded name.
Arbitrary JSON data for client responsible for managing the entity. Konnect only field, not synced to the Gateway.
The name of the Plugin that’s going to be added. Currently, the Plugin must be installed in every Kong instance separately.
>= 1 characters
Show Child Parameters
A list of partials to be used by the plugin.
Show Child Parameters
A string representing a protocol, such as HTTP or HTTPS.
Allowed values:grpcgrpcshttphttpstcptlstls_passthroughudpwswss
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
A string representing a tag.
Unix epoch when the resource was last updated.
Authentication
Path Parameters
Body
List all Plugins associated with a Consumer
List all Plugins associated with a Consumer
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
Consumer ID for nested entities
The UUID of your control plane. 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. It is how you can add functionalities to Services that run behind Kong, like Authentication or Rate Limiting for example. You can find more information about how to install and what values each plugin takes by visiting the Kong Hub. When adding a Plugin Configuration to a Service, every request made by a client to that Service will run said Plugin. If a Plugin needs to be tuned to different values for some specific Consumers, you can do so by creating a separate plugin instance that specifies both the Service and the Consumer, through the service and consumer fields.
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","partials":[{"id":"cff1230a-00f7-4ae8-b376-c370f0eb4dae","name":"foo-partial","path":"config.redis"},{"id":"129ee345-cba8-4e55-9d6d-93c223ff91ae","name":"bar-partial","path":"config.redis"}],"protocols":["grpc","grpcs","http","https"]}
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