Rate limit service

This documentation is for the Envoy v3 API.

As of Envoy v1.18 the v2 API has been removed and is no longer supported.

If you are upgrading from v2 API config you may wish to view the v2 API documentation:

config/ratelimit/v2/rls.proto

config.ratelimit.v3.RateLimitServiceConfig

[config.ratelimit.v3.RateLimitServiceConfig proto]

Rate limit configuration overview.

  1. {
  2.   "grpc_service": "{...}",
  3.   "transport_api_version": "..."
  4. }

grpc_service

(config.core.v3.GrpcService, REQUIRED) Specifies the gRPC service that hosts the rate limit service. The client will connect to this cluster when it needs to make rate limit service requests.

transport_api_version

(config.core.v3.ApiVersion) API version for rate limit transport protocol. This describes the rate limit gRPC endpoint and version of messages used on the wire.