# Rate limit¶

This extension may be referenced by the qualified name envoy.filters.thrift.ratelimit

Note

This extension is functional but has not had substantial production burn time, use only with this caveat.

This extension is not hardened and should only be used in deployments where both the downstream and upstream are trusted.

Rate limit configuration overview.

## config.filter.thrift.rate_limit.v2alpha1.RateLimit¶

[config.filter.thrift.rate_limit.v2alpha1.RateLimit proto]

{
"domain": "...",
"stage": "...",
"timeout": "{...}",
"failure_mode_deny": "...",
"rate_limit_service": "{...}"
}

domain

(string, REQUIRED) The rate limit domain to use in the rate limit service request.

stage

(uint32) Specifies the rate limit configuration stage. Each configured rate limit filter performs a rate limit check using descriptors configured in the config.filter.network.thrift_proxy.v2alpha1.RouteAction for the request. Only those entries with a matching stage number are used for a given filter. If not set, the default stage number is 0.

Note

The filter supports a range of 0 - 10 inclusively for stage numbers.

timeout

(Duration) The timeout in milliseconds for the rate limit service RPC. If not set, this defaults to 20ms.

failure_mode_deny

(bool) The filter’s behaviour in case the rate limiting service does not respond back. When it is set to true, Envoy will not allow traffic in case of communication failure between rate limiting service and the proxy. Defaults to false.

rate_limit_service

(config.ratelimit.v2.RateLimitServiceConfig, REQUIRED) Configuration for an external rate limit service provider. If not specified, any calls to the rate limit service will immediately return success.