Upsert a Plugin associated with a Service

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

put

Path Parameters

ServiceIdstringrequired

ID of the Service to lookup

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

PluginIdstringrequired

ID of the Plugin to lookup

Example:3473c251-5b6c-4f45-b1ff-7ede735a366d

controlPlaneIdstring(uuid)required

The UUID of your control plane. This variable is available in the Konnect manager.

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

Body

application/json

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.

* Additional properties are NOT allowed.
__ui_dataobject

Arbitrary JSON data for UI configuration. Konnect only field, not synced to the Gateway.

* Additional properties are allowed.
conditionstring

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

configobject

The configuration properties for the Plugin which can be found on the plugins documentation page in the Kong Hub.

* Additional properties are allowed.
consumerobject

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
consumer_groupobject

If set, the plugin will activate only for requests where the specified group has been authenticated

Show Child Parameters
created_atinteger

Unix epoch when the resource was created.

descriptionstring

User-defined entity description. Konnect only field, not synced to the Gateway.

enabledboolean

Whether the plugin is applied.

Default:true

idstring

A string representing a UUID (universally unique identifier).

>= 1 characters

instance_namestring

A unique string representing a UTF-8 encoded name.

managed_byobject

Arbitrary JSON data for client responsible for managing the entity. Konnect only field, not synced to the Gateway.

* Additional properties are allowed.
namestringrequired

The name of the Plugin that’s going to be added. Currently, the Plugin must be installed in every Kong instance separately.

>= 1 characters

orderingobject
Show Child Parameters
partialsarray[object]

A list of partials to be used by the plugin.

Show Child Parameters
protocolsarray[string]

A string representing a protocol, such as HTTP or HTTPS.

Allowed values:grpcgrpcshttphttpstcptlstls_passthroughudpwswss

Default:grpc, grpcs, http, https

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.

Show Child Parameters
serviceobject

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
tagsarray[string]

A string representing a tag.

updated_atinteger

Unix epoch when the resource was last updated.

Response

200 application/json

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.

* Additional properties are NOT allowed.
__ui_dataobject

Arbitrary JSON data for UI configuration. Konnect only field, not synced to the Gateway.

* Additional properties are allowed.
conditionstring

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

configobject

The configuration properties for the Plugin which can be found on the plugins documentation page in the Kong Hub.

* Additional properties are allowed.
consumerobject

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
consumer_groupobject

If set, the plugin will activate only for requests where the specified group has been authenticated

Show Child Parameters
created_atinteger

Unix epoch when the resource was created.

descriptionstring

User-defined entity description. Konnect only field, not synced to the Gateway.

enabledboolean

Whether the plugin is applied.

Default:true

idstring

A string representing a UUID (universally unique identifier).

>= 1 characters

instance_namestring

A unique string representing a UTF-8 encoded name.

managed_byobject

Arbitrary JSON data for client responsible for managing the entity. Konnect only field, not synced to the Gateway.

* Additional properties are allowed.
namestringrequired

The name of the Plugin that’s going to be added. Currently, the Plugin must be installed in every Kong instance separately.

>= 1 characters

orderingobject
Show Child Parameters
partialsarray[object]

A list of partials to be used by the plugin.

Show Child Parameters
protocolsarray[string]

A string representing a protocol, such as HTTP or HTTPS.

Allowed values:grpcgrpcshttphttpstcptlstls_passthroughudpwswss

Default:grpc, grpcs, http, https

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.

Show Child Parameters
serviceobject

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
tagsarray[string]

A string representing a tag.

updated_atinteger

Unix epoch when the resource was last updated.

put/control-planes/{controlPlaneId}/core-entities/services/{ServiceId}/plugins/{PluginId}

Body

{ "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" ] }
 
200 application/json

Routes

Route entities define rules to match client requests. Each route is associated with a service, and a service may have multiple routes associated to it. Every request matching a given route will be proxied to the associated service. You need at least one matching rule that applies to the protocol being matched by the route.



The combination of routes and services, and the separation of concerns between them, offers a powerful routing mechanism with which it is possible to define fine-grained entrypoints in Kong Gateway leading to different upstream services of your infrastructure.



Depending on the protocol, one of the following attributes must be set:

  • http: At least one of methods, hosts, headers, or paths
  • https: At least one of methods, hosts, headers, paths, or snis
  • tcp: At least one of sources or destinations
  • tls: at least one of sources, destinations, or snis
  • tls_passthrough: set snis
  • grpc: At least one of hosts, headers, or paths
  • grpcs: At least one of hosts, headers, paths, or snis
  • ws: At least one of hosts, headers, or paths
  • wss: At least one of hosts, headers, paths, or snis


    A route can’t have both tls and tls_passthrough protocols at same time.



    Learn more about the router:
  • Configure routes using expressions

List all Routes in a workspace

List all Routes in a workspace

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

workspacestring(string)required

The name of the workspace

Example:team-payments

controlPlaneIdstring(uuid)required

The UUID of your control plane. This variable is available in the Konnect manager.

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

Response

application/json

A successful response listing Routes

dataOne Of
array
RouteJsonobject

Route entities define rules to match client requests. Each Route is associated with a Service, and a Service may have multiple Routes associated to it. Every request matching a given Route will be proxied to its associated Service. The combination of Routes and Services (and the separation of concerns between them) offers a powerful routing mechanism with which it is possible to define fine-grained entry-points in Kong leading to different upstream services of your infrastructure. You need at least one matching rule that applies to the protocol being matched by the Route.

Example:{"hosts":["foo.example.com","foo.example.us"],"id":"56c4566c-14cc-4132-9011-4139fcbbe50a","name":"example-route","paths":["/v1","/v2"],"service":{"id":"bd380f99-659d-415e-b0e7-72ea05df3218"}}

* Additional properties are NOT allowed.
Show Child Parameters
nextstring

URI to the next page (may be null)

offsetstring

Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page

get/control-planes/{controlPlaneId}/core-entities/{workspace}/routes
 
application/json

Create a new Route in a workspace

Create a new Route in a workspace

post

Path Parameters

workspacestring(string)required

The name of the workspace

Example:team-payments

controlPlaneIdstring(uuid)required

The UUID of your control plane. This variable is available in the Konnect manager.

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

Body

application/json

Description of the new Route for creation

Route

Route
One Of
created_atinteger

Unix epoch when the resource was created.

descriptionstring

User-defined entity description. Konnect only field, not synced to the Gateway.

destinationsarray[object]

A list of IP destinations of incoming connections that match this Route when using stream routing. Each entry is an object with fields “ip” (optionally in CIDR range notation) and/or “port”.

Show Child Parameters
headersobject

One or more lists of values indexed by header name that will cause this Route to match if present in the request. The Host header cannot be used with this attribute: hosts should be specified using the hosts attribute. When headers contains only one value and that value starts with the special prefix ~*, the value is interpreted as a regular expression.

hostsarray[string]

A list of domain names that match this Route. Note that the hosts value is case sensitive.

https_redirect_status_codeinteger

The status code Kong responds with when all properties of a Route match except the protocol i.e. if the protocol of the request is HTTP instead of HTTPS. Location header is injected by Kong if the field is set to 301, 302, 307 or 308. Note: This config applies only if the Route is configured to only accept the https protocol.

Allowed values:301302307308426

Default:426

idstring

A string representing a UUID (universally unique identifier).

managed_byobject

Arbitrary JSON data for client responsible for managing the entity. Konnect only field, not synced to the Gateway.

* Additional properties are allowed.
methodsarray[string]

A string representing an HTTP method, such as GET, POST, PUT, or DELETE. The string must contain only uppercase letters.

namestring

The name of the Route. Route names must be unique, and they are case sensitive. For example, there can be two different Routes named “test” and “Test”.

path_handlingstring

Controls how the Service path, Route path and requested path are combined when sending a request to the upstream. See above for a detailed description of each behavior.

Allowed values:v0v1

Default:v0

pathsarray[string]

A string representing a router path. It must start with a forward slash (‘/’) for a fixed path, or the sequence ‘~/’ for a regex path. It must not have empty segments.

preserve_hostboolean

When matching a Route via one of the hosts domain names, use the request Host header in the upstream request headers. If set to false, the upstream Host header will be that of the Service’s host.

Default:false

protocolsarray[string]

A string representing a protocol, such as HTTP or HTTPS.

Allowed values:grpcgrpcshttphttpstcptlstls_passthroughudpwswss

Default:https

>= 1 characters

regex_priorityinteger

A number used to choose which route resolves a given request when several routes match it using regexes simultaneously. When two routes match the path and have the same regex_priority, the older one (lowest created_at) is used. Note that the priority for non-regex routes is different (longer non-regex routes are matched before shorter ones).

Default:0

request_bufferingboolean

Whether to enable request body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that receive data with chunked transfer encoding.

Default:true

response_bufferingboolean

Whether to enable response body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that send data with chunked transfer encoding.

Default:true

serviceobject

The Service this Route is associated to. This is where the Route proxies traffic to.

Show Child Parameters
snisarray[string]

A string representing a wildcard host name, such as *.example.com.

sourcesarray[object]

A list of IP sources of incoming connections that match this Route when using stream routing. Each entry is an object with fields “ip” (optionally in CIDR range notation) and/or “port”.

Show Child Parameters
strip_pathboolean

When matching a Route via one of the paths, strip the matching prefix from the upstream request URL.

Default:true

tagsarray[string]

A string representing a tag.

updated_atinteger

Unix epoch when the resource was last updated.

Response

application/json

Successfully created Route

Route

Route
One Of
created_atinteger

Unix epoch when the resource was created.

descriptionstring

User-defined entity description. Konnect only field, not synced to the Gateway.

destinationsarray[object]

A list of IP destinations of incoming connections that match this Route when using stream routing. Each entry is an object with fields “ip” (optionally in CIDR range notation) and/or “port”.

Show Child Parameters
headersobject

One or more lists of values indexed by header name that will cause this Route to match if present in the request. The Host header cannot be used with this attribute: hosts should be specified using the hosts attribute. When headers contains only one value and that value starts with the special prefix ~*, the value is interpreted as a regular expression.

hostsarray[string]

A list of domain names that match this Route. Note that the hosts value is case sensitive.

https_redirect_status_codeinteger

The status code Kong responds with when all properties of a Route match except the protocol i.e. if the protocol of the request is HTTP instead of HTTPS. Location header is injected by Kong if the field is set to 301, 302, 307 or 308. Note: This config applies only if the Route is configured to only accept the https protocol.

Allowed values:301302307308426

Default:426

idstring

A string representing a UUID (universally unique identifier).

managed_byobject

Arbitrary JSON data for client responsible for managing the entity. Konnect only field, not synced to the Gateway.

* Additional properties are allowed.
methodsarray[string]

A string representing an HTTP method, such as GET, POST, PUT, or DELETE. The string must contain only uppercase letters.

namestring

The name of the Route. Route names must be unique, and they are case sensitive. For example, there can be two different Routes named “test” and “Test”.

path_handlingstring

Controls how the Service path, Route path and requested path are combined when sending a request to the upstream. See above for a detailed description of each behavior.

Allowed values:v0v1

Default:v0

pathsarray[string]

A string representing a router path. It must start with a forward slash (‘/’) for a fixed path, or the sequence ‘~/’ for a regex path. It must not have empty segments.

preserve_hostboolean

When matching a Route via one of the hosts domain names, use the request Host header in the upstream request headers. If set to false, the upstream Host header will be that of the Service’s host.

Default:false

protocolsarray[string]

A string representing a protocol, such as HTTP or HTTPS.

Allowed values:grpcgrpcshttphttpstcptlstls_passthroughudpwswss

Default:https

>= 1 characters

regex_priorityinteger

A number used to choose which route resolves a given request when several routes match it using regexes simultaneously. When two routes match the path and have the same regex_priority, the older one (lowest created_at) is used. Note that the priority for non-regex routes is different (longer non-regex routes are matched before shorter ones).

Default:0

request_bufferingboolean

Whether to enable request body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that receive data with chunked transfer encoding.

Default:true

response_bufferingboolean

Whether to enable response body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that send data with chunked transfer encoding.

Default:true

serviceobject

The Service this Route is associated to. This is where the Route proxies traffic to.

Show Child Parameters
snisarray[string]

A string representing a wildcard host name, such as *.example.com.

sourcesarray[object]

A list of IP sources of incoming connections that match this Route when using stream routing. Each entry is an object with fields “ip” (optionally in CIDR range notation) and/or “port”.

Show Child Parameters
strip_pathboolean

When matching a Route via one of the paths, strip the matching prefix from the upstream request URL.

Default:true

tagsarray[string]

A string representing a tag.

updated_atinteger

Unix epoch when the resource was last updated.

post/control-planes/{controlPlaneId}/core-entities/{workspace}/routes

Body

{}
 
application/json

Delete a Route in a workspace

Delete a Route in a workspace

delete

Path Parameters

RouteIdstringrequired

ID of the Route to lookup

Example:a4326a41-aa12-44e3-93e4-6b6e58bfb9d7

workspacestring(string)required

The name of the workspace

Example:team-payments

controlPlaneIdstring(uuid)required

The UUID of your control plane. This variable is available in the Konnect manager.

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

Response

Successfully deleted Route or the resource didn’t exist

delete/control-planes/{controlPlaneId}/core-entities/{workspace}/routes/{RouteId}