Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace AddressRateLimiting

The IP rate limiting configuration. Defines the amount of allowed requests from a unique IP address and the resulting block response code when that threshold is exceeded.

Properties

Optional allowedRatePerAddress

allowedRatePerAddress: undefined | number

The number of allowed requests per second from one IP address. If unspecified, defaults to {@code 1}. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional blockResponseCode

blockResponseCode: undefined | number

The response status code returned when a request is blocked. If unspecified, defaults to {@code 503}. The list of available response codes: {@code 400}, {@code 401}, {@code 403}, {@code 404}, {@code 405}, {@code 408}, {@code 409}, {@code 411}, {@code 412}, {@code 413}, {@code 414}, {@code 415}, {@code 416}, {@code 422}, {@code 494}, {@code 495}, {@code 496}, {@code 497}, {@code 499}, {@code 500}, {@code 501}, {@code 502}, {@code 503}, {@code 504}, {@code 507}. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

isEnabled

isEnabled: boolean

Enables or disables the address rate limiting Web Application Firewall feature.

Optional maxDelayedCountPerAddress

maxDelayedCountPerAddress: undefined | number

The maximum number of requests allowed to be queued before subsequent requests are dropped. If unspecified, defaults to {@code 10}. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Functions

getDeserializedJsonObj

getJsonObj