List all Plugins associated with a Service in a workspace

List all Plugins associated with a Service 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

ServiceIdstringrequired

ID of the Service to lookup

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

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

200 application/json

A successful response listing Plugins

dataarray[object]

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"]}

* 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}/services/{ServiceId}/plugins
 
200 application/json

Create a new Plugin associated with a Service in a workspace

Create a new Plugin associated with a Service in a workspace

post

Path Parameters

ServiceIdstringrequired

ID of the Service to lookup

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

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 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.

* 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

201 application/json

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.

* 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.

post/control-planes/{controlPlaneId}/core-entities/{workspace}/services/{ServiceId}/plugins

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

Delete a a Plugin associated with a Service in a workspace

Delete a a Plugin associated with a Service using ID in a workspace.

delete

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

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

204

Successfully deleted Plugin or the resource didn’t exist

delete/control-planes/{controlPlaneId}/core-entities/{workspace}/services/{ServiceId}/plugins/{PluginId}
 
204

Get a Plugin associated with a Service in a workspace

Get a Plugin associated with a Service using ID in a workspace.

get

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

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

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.

* 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.

get/control-planes/{controlPlaneId}/core-entities/{workspace}/services/{ServiceId}/plugins/{PluginId}
 
application/json

Upsert a Plugin associated with a Service in a workspace

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

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

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 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/{workspace}/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