Skip to content
2023 API Summit Hackathon: Experiment with AI for APIs (August 28 - September 27) Learn More →
Kong Logo | Kong Docs Logo
search
  • We're Hiring!
  • Docs
    • Kong Gateway
      Lightweight, fast, and flexible cloud-native API gateway
      Kong Konnect
      Single platform for SaaS end-to-end connectivity
      Kong Mesh
      Enterprise service mesh based on Kuma and Envoy
      decK
      Helps manage Kong’s configuration in a declarative fashion
      Kong Ingress Controller
      Works inside a Kubernetes cluster and configures Kong to proxy traffic
      Insomnia
      Collaborative API development platform
      Kuma
      Open-source distributed control plane with a bundled Envoy Proxy integration
      Docs Contribution Guidelines
      Want to help out, or found an issue in the docs and want to let us know?
  • API Specs
  • Plugin Hub
    • Explore the Plugin Hub
      View all plugins View all plugins View all plugins arrow image
    • Functionality View all View all arrow image
      View all plugins
      Authentication's icon
      Authentication
      Protect your services with an authentication layer
      Security's icon
      Security
      Protect your services with additional security layer
      Traffic Control's icon
      Traffic Control
      Manage, throttle and restrict inbound and outbound API traffic
      Serverless's icon
      Serverless
      Invoke serverless functions in combination with other plugins
      Analytics & Monitoring's icon
      Analytics & Monitoring
      Visualize, inspect and monitor APIs and microservices traffic
      Transformations's icon
      Transformations
      Transform request and responses on the fly on Kong
      Logging's icon
      Logging
      Log request and response data using the best transport for your infrastructure
  • Support
  • Community
  • Kong Academy
Get a Demo Start Free Trial
Kong Gateway
2.8.x
  • Home icon
  • Kong Gateway
  • Get Started
  • Comprehensive
  • Protect your Services
github-edit-pageEdit this page
report-issueReport an issue
  • Kong Gateway
  • Kong Konnect
  • Kong Mesh
  • Plugin Hub
  • decK
  • Kong Ingress Controller
  • Insomnia
  • Kuma

  • Docs contribution guidelines
  • 3.4.x (latest)
  • 3.3.x
  • 3.2.x
  • 3.1.x
  • 3.0.x
  • 2.8.x
  • 2.7.x
  • 2.6.x
  • Archive (pre-2.6)
enterprise-switcher-icon Switch to OSS
On this pageOn this page
  • What is Rate Limiting?
  • Why Use Rate Limiting?
  • Set up Rate Limiting
  • Validate Rate Limiting
  • Summary and next steps
You are browsing documentation for an outdated version. See the latest documentation here.

Protect your Services

In this topic, you’ll learn how to enforce rate limiting using the Rate Limiting plugin.

If you are following the getting started workflow, make sure you have completed Exposing Your Services before moving on.

What is Rate Limiting?

Kong’s Rate Limiting plugin lets you restrict how many requests your upstream services receive from your API consumers, or how often each user can call the API.

The Rate Limiting Advanced plugin provides support for the sliding window algorithm to prevent the API from being overloaded near the window boundaries, and adds Redis support for greater performance.

Why Use Rate Limiting?

Rate limiting protects the APIs from accidental or malicious overuse. Without rate limiting, each user may request as often as they like, which can lead to spikes of requests that starve other consumers. After rate limiting is enabled, API calls are limited to a fixed number of requests per second.

Set up Rate Limiting

Using Kong Manager
Using the Admin API
Using decK (YAML)
  1. Access your Kong Manager instance and your default workspace.

  2. Go to API Gateway > Plugins.

  3. Click New Plugin.

  4. Scroll down to Traffic Control and find the Rate Limiting Advanced plugin. Click Enable.

  5. Apply the plugin as Global, which means the rate limiting applies to all requests, including every Service and Route in the Workspace.

    If you switched it to Scoped, the rate limiting would apply the plugin to only one Service, Route, or Consumer.

    Note: By default, the plugin is automatically enabled when the form is submitted. You can also toggle the This plugin is Enabled button at the top of the form to configure the plugin without enabling it. For this example, keep the plugin enabled.

  6. Scroll down and complete only the following fields with the following parameters.
    1. config.limit: 5
    2. config.sync_rate: -1
    3. config.window_size: 30

    Besides the above fields, there may be others populated with default values. For this example, leave the rest of the fields as they are.

  7. Click Create.

Note: This section sets up the basic Rate Limiting plugin. If you have a Kong Gateway instance, see instructions for Using Kong Manager to set up Rate Limiting Advanced with sliding window support instead.

Call the Admin API on port 8001 and configure plugins to enable a limit of five (5) requests per minute, stored locally and in-memory, on the node.

cURL
HTTPie
curl -i -X POST http://<admin-hostname>:8001/plugins \
  --data name=rate-limiting \
  --data config.minute=5 \
  --data config.policy=local
http -f post :8001/plugins \
  name=rate-limiting \
  config.minute=5 \
  config.policy=local

Note: This section sets up the basic Rate Limiting plugin. If you have a Kong Gateway instance, see instructions for Using Kong Manager to set up Rate Limiting Advanced with sliding window support instead.

  1. Add a new plugins section to the bottom of your kong.yaml file. Enable rate-limiting with a limit of five (5) requests per minute, stored locally and in-memory, on the node:

     plugins:
     - name: rate-limiting
       config:
         minute: 5
         policy: local
    

    Your file should now look like this:

     _format_version: "1.1"
     services:
     - host: mockbin.org
       name: example_service
       port: 80
       protocol: http
       routes:
       - name: mocking
         paths:
         - /mock
         strip_path: true
     plugins:
     - name: rate-limiting
       config:
         minute: 5
         policy: local
    

    This plugin will be applied globally, which means the rate limiting applies to all requests, including every Service and Route in the Workspace.

    If you pasted the plugin section under an existing Service, Route, or Consumer, the rate limiting would only apply to that specific entity.

    Note: By default, enabled is set to true for the plugin. You can disable the plugin at any time by setting enabled: false.

  2. Sync the configuration:

     deck sync
    

Validate Rate Limiting

Using a Web Browser
Using the Admin API
  1. Enter <admin-hostname>:8000/mock and refresh your browser six times. After the 6th request, you’ll receive an error message.
  2. Wait at least 30 seconds and try again. The service will be accessible until the sixth (6th) access attempt within a 30-second window.

To validate rate limiting, access the API six (6) times from the CLI to confirm the requests are rate limited.

cURL
HTTPie
curl -i -X GET http://<admin-hostname>:8000/mock/request
http :8000/mock/request

After the 6th request, you should receive a 429 “API rate limit exceeded” error:

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

Summary and next steps

In this section:

  • If using the Admin API or decK, you enabled the Rate Limiting plugin, setting the rate limit to 5 times per minute.
  • If using Kong Manager, you enabled the Rate Limiting Advanced plugin, setting the rate limit to 5 times for every 30 seconds.

Next, head on to learn about proxy caching.

Thank you for your feedback.
Was this page useful?
Too much on your plate? close cta icon
More features, less infrastructure with Kong Konnect. 1M requests per month for free.
Try it for Free
  • Kong
    THE CLOUD CONNECTIVITY COMPANY

    Kong powers reliable digital connections across APIs, hybrid and multi-cloud environments.

    • Company
    • Customers
    • Events
    • Investors
    • Careers Hiring!
    • Partners
    • Press
    • Contact
  • Products
    • Kong Konnect
    • Kong Gateway
    • Kong Mesh
    • Get Started
    • Pricing
  • Resources
    • eBooks
    • Webinars
    • Briefs
    • Blog
    • API Gateway
    • Microservices
  • Open Source
    • Install Kong Gateway
    • Kong Community
    • Kubernetes Ingress
    • Kuma
    • Insomnia
  • Solutions
    • Decentralize
    • Secure & Govern
    • Create a Dev Platform
    • API Gateway
    • Kubernetes
    • Service Mesh
Star
  • Terms•Privacy
© Kong Inc. 2023