Upsert a plugin associated with a service
Create or Update a Plugin associated with a service using ID.
Path Parameters
ID or name of the service to lookup
Example:7fca84d6-7d37-4a74-a7b0-93e576089a41
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
Example response
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
Unix epoch when the resource was created.
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>}.
If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified service.
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.)
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.
Authentication
Path Parameters
Body
Consumers
Consumers
List all Consumers
Retrieve a list of all consumers.You can use query parameters to filter the results by size or tags, for example /consumers?size=50&tags=enterprise.
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 ID of your runtime group. This variable is available in the Konnect manager
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Response
200 application/json
Response
New consumer created response
Unix epoch when the resource was created.
Example:1684424758
Field for the unique consumer ID
The unique id of the consumer.
Example:c1a1f6f-2aa4-4e58-93ff-b56368f19b27
An optional set of strings associated with the Consumer for grouping and filtering.
Unix epoch when the resource was updated.
Example:1684424758
The unique username of the consumer.
Authentication
Path Parameters
Query Parameters
Create a new Consumer
Create a new Consumer
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
Consumer request body
The unique username of the Consumer. You must send either this field or custom_id with the request.
Field for storing an existing unique ID for the Consumer - useful for mapping Kong with users in your existing database. You must send either this field or username with the request.
An optional set of strings associated with the Consumer for grouping and filtering.
Response
application/json
Response
New consumer created response
Unix epoch when the resource was created.
Example:1684424758
Field for the unique consumer ID
The unique id of the consumer.
Example:c1a1f6f-2aa4-4e58-93ff-b56368f19b27
An optional set of strings associated with the Consumer for grouping and filtering.
Unix epoch when the resource was updated.
Example:1684424758
The unique username of the consumer.
Authentication
Path Parameters
Body
Delete a Consumer
Delete a specific consumer from the system using either the consumer ID or the consumer username. This operation is irreversible and permanently removes all data associated with the specified consumer. If the consumer was deleted succesfully the endpoint will return a 204 response indicating that the resource did not exist.
Path Parameters
The unique identifier or the username of the Consumer 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
204
Response
Successfully deleted Consumer or the resource didn’t exist