---
id: "rate-limiter"
type: "component"
kind: "rate-limiter"
provider: "default"
category: "edge"
url: "https://localhost:3000/catalogue/components/rate-limiter"
---

# Generic rate limiter

Vendor-neutral rate limiter. Use when the real product is not in the catalogue; every rule for this kind still applies.

| | |
|---|---|
| Provider | [default](https://localhost:3000/catalogue?provider=default) |
| Kind | [Rate limiter](https://localhost:3000/catalogue/kinds/rate-limiter) |
| Category | Edge |
| Official docs | not recorded |
| Generic? | Vendor-neutral: the kind itself |

## Properties

| property | type | values | required | default |
|---|---|---|---|---|
| `algorithm` | enum | `token-bucket`, `leaky-bucket`, `sliding-window`, `fixed-window`, `adaptive` | no | "token-bucket" |
| `atomicOps` (advanced) | boolean | — | no | true |
| `distributed` | boolean | — | no | false |
| `failMode` | enum | `open`, `closed` | no | "open" |
| `managed` | boolean | — | no | false |
| `placement` | enum | `edge`, `gateway`, `sidecar`, `in-process` | no | "gateway" |
| `scope` | enum | `global`, `user`, `ip`, `api-key`, `concurrency` | no | "user" |

## Rules that apply · 0

No rule selects this kind or its category.

## Other products of the same kind · 6

- [Cloudflare Rate Limiting](https://localhost:3000/catalogue/components/cloudflare-rate-limiting.md) `cloudflare-rate-limiting` — cloudflare
- [Cloudflare Waiting Room](https://localhost:3000/catalogue/components/cloudflare-waiting-room.md) `cloudflare-waiting-room` — cloudflare
- [Envoy rate limit service](https://localhost:3000/catalogue/components/envoy-ratelimit.md) `envoy-ratelimit` — default
- [In-process rate limiter](https://localhost:3000/catalogue/components/in-process-limiter.md) `in-process-limiter` — default
- [NGINX limit_req](https://localhost:3000/catalogue/components/nginx-limit-req.md) `nginx-limit-req` — default
- [Redis rate limiter](https://localhost:3000/catalogue/components/redis-rate-limiter.md) `redis-rate-limiter` — default

## Use it in a design

```yaml
nodes:
  - { id: "rate-limiter", component: "rate-limiter" }
```

## Source (`component` YAML, verbatim)

```yaml
# yaml-language-server: $schema=../../schema/component.schema.json
# The vendor-neutral rate limiter: the kind itself, with no product behind it. It sets no
# defaults and adds no properties, so every required kind property stays required on the node.
schemaVersion: "1"
type: "component"
id: "rate-limiter"
kind: "rate-limiter"
provider: "default"
```

Human page: https://localhost:3000/catalogue/components/rate-limiter