Request Size Limiting

For example, configure this plugin on a service by making the following request:

curl -X POST http://{HOST}:8001/services/{SERVICE}/plugins \
    --data "name=request-size-limiting"  \
    --data "config.allowed_payload_size=128" \
    --data "config.size_unit=megabytes" \
    --data "config.require_content_length=false"

SERVICE is the id or name of the service that this plugin configuration will target.

First, create a KongPlugin resource:

apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
  name: <request-size-limiting-example>
config: 
  allowed_payload_size: 128
  size_unit: megabytes
  require_content_length: false
plugin: request-size-limiting

Next, apply the KongPlugin resource to a Service by annotating the Service as follows:

apiVersion: v1
kind: Service
metadata:
  name: {SERVICE}
  labels:
    app: {SERVICE}
  annotations:
    konghq.com/plugins: <request-size-limiting-example>
spec:
  ports:
  - port: 80
    targetPort: 80
    protocol: TCP
    name: {SERVICE}
  selector:
    app: {SERVICE}

{SERVICE} is the id or name of the service that this plugin configuration will target.

For example, configure this plugin on a service by adding this section to your declarative configuration file:

plugins:
- name: request-size-limiting
  service: {SERVICE}
  config: 
    allowed_payload_size: 128
    size_unit: megabytes
    require_content_length: false

SERVICE is the id or name of the service that this plugin configuration will target.

Configure this plugin on a service:

1. In Kong Manager, select the workspace.
2. From the Dashboard, scroll down to Services and click View for the service row.
3. Scroll down to plugins and click Add Plugin.

4. Find and select the Request Size Limiting plugin.

   Note: If the plugin is greyed out, then it is not available for your product tier. See Kong Gateway tiers.
5. If the option is available, select Scoped.
6. Add the service name and ID to the Service field if it is not already prefilled.

7. Enter the following parameters, updating the default or sample values as needed:

   • Config.Allowed Payload Size: 128
   • Config.Size Unit: megabytes
   • Config.Require Content Length: clear checkbox
8. Click Create.

For example, configure this plugin on a route with:

$ curl -X POST http://{HOST}:8001/routes/{ROUTE}/plugins \
    --data "name=request-size-limiting"  \
    --data "config.allowed_payload_size=128" \
    --data "config.size_unit=megabytes" \
    --data "config.require_content_length=false"

ROUTE is the id or name of the route that this plugin configuration will target.

First, create a KongPlugin resource:

apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
  name: <request-size-limiting-example>
config: 
  allowed_payload_size: 128
  size_unit: megabytes
  require_content_length: false
plugin: request-size-limiting

Then, apply it to an ingress (Route or Routes) by annotating the ingress as follows:

apiVersion: networking/v1beta1
kind: Ingress
metadata:
  name: {ROUTE}
  annotations:
    kubernetes.io/ingress.class: kong
    konghq.com/plugins: <request-size-limiting-example>
spec:
  rules:
  - host: examplehostname.com
    http:
      paths:
      - path: /bar
        backend:
          serviceName: echo
          servicePort: 80

ROUTE is the id or name of the route that this plugin configuration will target.

For example, configure this plugin on a route by adding this section to your declarative configuration file:

plugins:
- name: request-size-limiting
  route: <route>
  config: 
    allowed_payload_size: 128
    size_unit: megabytes
    require_content_length: false

ROUTE is the id or name of the route that this plugin configuration will target.

Configure this plugin on a route:

1. In Kong Manager, select the workspace.
2. From the Dashboard, select Routes in the left navigation.
3. Click View for the route row.
4. Scroll down to plugins and click Add Plugin.

5. Find and select the Request Size Limiting plugin.

   Note: If the plugin is greyed out, then it is not available for your product tier. See Kong Gateway tiers.
6. If the option is available, select Scoped.
7. Add the Route ID if it is not already prefilled.

8. Enter the following parameters, updating the default or sample values as needed:

   • Config.Allowed Payload Size: 128
   • Config.Size Unit: megabytes
   • Config.Require Content Length: clear checkbox
9. Click Create.

For example, configure this plugin on a consumer with:

$ curl -X POST http://{HOST}:8001/consumers/{CONSUMER}/plugins \
    --data "name=request-size-limiting"  \
    --data "config.allowed_payload_size=128" \
    --data "config.size_unit=megabytes" \
    --data "config.require_content_length=false"

CONSUMER is the id or username of the consumer that this plugin configuration will target.

You can combine consumer.id, service.id, or route.id in the same request, to further narrow the scope of the plugin.

First, create a KongPlugin resource:

apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
  name: <request-size-limiting-example>
config: 
  allowed_payload_size: 128
  size_unit: megabytes
  require_content_length: false
plugin: request-size-limiting

Then, apply it to a consumer by annotating the KongConsumer resource as follows:

apiVersion: configuration.konghq.com/v1
kind: KongConsumer
metadata:
  name: {CONSUMER}
  annotations:
    konghq.com/plugins: <request-size-limiting-example>
    kubernetes.io/ingress.class: kong

CONSUMER is the id or username of the consumer that this plugin configuration will target.

For example, configure this plugin on a consumer by adding this section to your declarative configuration file:

plugins:
- name: request-size-limiting
  consumer: {CONSUMER}
  config: 
    allowed_payload_size: 128
    size_unit: megabytes
    require_content_length: false

CONSUMER is the id or username of the consumer that this plugin configuration will target.

Configure this plugin on a consumer:

1. In Kong Manager, select the workspace.
2. From the Dashboard, scroll down to Consumers and click View for the consumer row.
3. Select the Plugins tab.
4. Click Add Plugin.

5. Find and select the Request Size Limiting plugin.

   Note: If the plugin is greyed out, then it is not available for your product tier. See Kong Gateway tiers.
6. If the option is available, select Global.

7. Enter the following parameters, updating the default or sample values as needed:

   • Config.Allowed Payload Size: 128
   • Config.Size Unit: megabytes
   • Config.Require Content Length: clear checkbox
8. Click Create.

For example, configure this plugin globally with:

$ curl -X POST http://{HOST}:8001/plugins/ \
    --data "name=request-size-limiting"  \
    --data "config.allowed_payload_size=128" \
    --data "config.size_unit=megabytes" \
    --data "config.require_content_length=false"

Create a KongClusterPlugin resource and label it as global:

apiVersion: configuration.konghq.com/v1
kind: KongClusterPlugin
metadata:
  name: <global-request-size-limiting>
  annotations:
    kubernetes.io/ingress.class: kong
  labels:
    global: \"true\"
config: 
  allowed_payload_size: 128
  size_unit: megabytes
  require_content_length: false
plugin: request-size-limiting

For example, configure this plugin using the plugins: entry in the declarative configuration file:

plugins:
- name: request-size-limiting
  config: 
    allowed_payload_size: 128
    size_unit: megabytes
    require_content_length: false

Configure this plugin globally:

1. In Kong Manager, select the workspace.
2. From the Dashboard, select Plugins in the left navigation.
3. Click New Plugin.

4. Find and select the Request Size Limiting plugin.

   Note: If the plugin is greyed out, then it is not available for your product tier. See Kong Gateway tiers.
5. If the option is available, set the plugin scope to Global.

6. Enter the following parameters, updating the default/sample values as needed:

   • Config.Allowed Payload Size: 128
   • Config.Size Unit: megabytes
   • Config.Require Content Length: clear checkbox
7. Click Create.