Upsert a plugin associated with a service

Create or Update a Plugin associated with a service using ID.

put

Path Parameters

service_idstringrequired

ID or name of the service to lookup

Example:7fca84d6-7d37-4a74-a7b0-93e576089a41

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

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.

put/runtime-groups/{runtimeGroupId}/core-entities/services/{service_id}/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

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.

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

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

New consumer created response

created_atinteger

Unix epoch when the resource was created.

Example:1684424758

custom_idstring

Field for the unique consumer ID

idstring

The unique id of the consumer.

Example:c1a1f6f-2aa4-4e58-93ff-b56368f19b27

tagsarray[string]

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

updated_atinteger

Unix epoch when the resource was updated.

Example:1684424758

usernamestring

The unique username of the consumer.

get/runtime-groups/{runtimeGroupId}/core-entities/consumers
 
200 application/json

Create a new Consumer

Create a new Consumer

post

Path Parameters

runtimeGroupIdstringrequired

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

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

Body

application/json

Consumer request body

usernamestringrequired

The unique username of the Consumer. You must send either this field or custom_id with the request.

custom_idstringrequired

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.

tagsarray[string]

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

Response

application/json

New consumer created response

created_atinteger

Unix epoch when the resource was created.

Example:1684424758

custom_idstring

Field for the unique consumer ID

idstring

The unique id of the consumer.

Example:c1a1f6f-2aa4-4e58-93ff-b56368f19b27

tagsarray[string]

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

updated_atinteger

Unix epoch when the resource was updated.

Example:1684424758

usernamestring

The unique username of the consumer.

post/runtime-groups/{runtimeGroupId}/core-entities/consumers

Body

{ "username": "username", "custom_id": "custom_id" }
 
application/json

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.

delete

Path Parameters

consumer_idstringrequired

The unique identifier or the username of the Consumer 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

204

Successfully deleted Consumer or the resource didn’t exist

delete/runtime-groups/{runtimeGroupId}/core-entities/consumers/{consumer_id}
 
204