Create a new Partial
Create a new Partial
Path Parameters
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 new Partial for creation
Partial
One OfShow Child Parameters
Unix epoch when the resource was created.
A string representing a UUID (universally unique identifier).
A unique string representing a UTF-8 encoded name.
A string representing a tag.
Allowed values:redis-ce
Unix epoch when the resource was last updated.
Response
application/json
Response
Successfully created Partial
Partial
One OfShow Child Parameters
Unix epoch when the resource was created.
A string representing a UUID (universally unique identifier).
A unique string representing a UTF-8 encoded name.
A string representing a tag.
Allowed values:redis-ce
Unix epoch when the resource was last updated.
Authentication
Path Parameters
Body
Get a Partial
Get a Partial using ID.
Path Parameters
ID of the Partial to lookup
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 Partial
Partial
One OfShow Child Parameters
Unix epoch when the resource was created.
A string representing a UUID (universally unique identifier).
A unique string representing a UTF-8 encoded name.
A string representing a tag.
Allowed values:redis-ce
Unix epoch when the resource was last updated.
Authentication
Path Parameters
Upsert a Partial
Create or Update Partial using ID.
Path Parameters
ID of the Partial 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 the Partial
Partial
One OfShow Child Parameters
Unix epoch when the resource was created.
A string representing a UUID (universally unique identifier).
A unique string representing a UTF-8 encoded name.
A string representing a tag.
Allowed values:redis-ce
Unix epoch when the resource was last updated.
Response
application/json
Response
Successfully upserted Partial
Partial
One OfShow Child Parameters
Unix epoch when the resource was created.
A string representing a UUID (universally unique identifier).
A unique string representing a UTF-8 encoded name.
A string representing a tag.
Allowed values:redis-ce
Unix epoch when the resource was last updated.
Authentication
Path Parameters
Body
Plugins
A plugin entity represents a plugin configuration that will be executed during the HTTP request/response lifecycle. Plugins let you add functionality to services that run behind a Kong Gateway instance, like authentication or rate limiting.
You can find more information about available plugins and which values each plugin accepts at the Plugin Hub.
When adding a plugin configuration to a service, the plugin will run on every request made by a client to that service. 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.
List all Plugins associated with a Consumer Group in a workspace
List all Plugins associated with a Consumer Group in a workspace
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 name of the workspace
Example:team-payments
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