Enable rate limiting on a service with Kong Gateway

Prerequisites

Kong Konnect

This is a Konnect tutorial. If you don’t have a Konnect account, you can get started quickly with our onboarding wizard.

The following Konnect items are required to complete this tutorial:

Personal access token (PAT): Create a new personal access token by opening the Konnect PAT page and selecting Generate Token.
Control plane: You can use an existing control plane or create a new one to use for this tutorial.
Control plane ID: You can see your control plane ID by selecting a control plane from the Gateway Manager in Konnect.

Kong Gateway running

This tutorial requires Kong Gateway. If you don’t have it set up yet, you can use the quickstart script to get an instance of Kong Gateway running almost instantly:

curl -Ls https://get.konghq.com/quickstart | bash -s

Once Kong Gateway is ready, you will see the following message:

Kong Gateway Ready

decK

decK is a CLI tool for managing Kong Gateway declaratively with state files. To complete this tutorial you will first need to:

Install decK
Create a deck_files directory and a kong.yaml file in the directory:
```
 mkdir deck_files  && touch deck_files/kong.yaml
```

Pre-configured entities

For this tutorial, you’ll need Kong Gateway entities, like services and routes, pre-configured. These entities are essential for Kong Gateway to function but installing them isn’t the focus of this guide. Follow these steps to pre-configure them:

Create a prereqs.yaml file within your deck_files directory, and add the following content to it:

_format_version: '3.0'
services:
  - name: example-service
    url: http://httpbin.org/anything
routes:
  - name: example-route
    paths:
    - "/anything"
    service:
      name: example-service

Sync your changes.

deck gateway sync deck_files

Make sure to substitute your Konnect Personal Access Token for konnect_token and the control plane name for KONNECT_CP_NAME in the command:

deck gateway sync deck_files \
  --konnect-token $KONNECT_TOKEN \
  --konnect-control-plane-name $KONNECT_CP_NAME

To learn more about entities, you can read our entities documentation.

1. Enable rate limiting

Enable the Rate Limiting plugin for the service. In this example, the limit is 5 requests per second and 1000 requests per hour.

_format_version: '3.0'
plugins:
  - name: rate-limiting
    service: example-service
    config:
      second: 5
      hour: 1000

2. Validate

After configuring the Rate Limiting plugin, you can verify that it was configured correctly and is working, by sending more requests than allowed in the configured time limit.

for _ in {1..6}
do
  curl http://localhost:8000/example-route/anything/
done

After the 5th request, you should receive the following 429 error:

{ "message": "API rate limit exceeded" }

Cleanup

Clean up Konnect environment

If you created a new control plane and want to conserve your free trial credits or avoid unnecessary charges, delete the new control plane used in this tutorial.

Destroy the Kong Gateway container

curl -Ls https://get.konghq.com/quickstart | bash -s -- -d