17.5. Rate Limiting

Rate Limiting with Token Bucket algorithm is used to suspend the processing of requests from an IP address when a maximum number of processing failures (unauthorized access or processing errors) has been reached within a given time period. Rate Limiting events are reported in the Admin Web App Dashboard as Real-time Activity and in the server.log.

Configuration propertyDescription

system.ratelimiting.enable

Set to Y (default) or N to enable/disable Rate Limiting.

system.ratelimiting.user-auth.enable

Set to Y (default) or N to enable/disable Rate Limiting for User Authentication in Web Apps and the User Client Desktop Application.

See Section 3.1, “Login” and Chapter 11, User Client.

system.ratelimiting.user-auth.failures-per-min

The maximum number of User Authentication failures in Web Apps per IP address per minute. The processing of any attempt that exceeds this maximum will be suspended until there is room again within the one minute time frame. Default: 5.

system.ratelimiting.api.enable

Set to Y (default) or N to enable/disable API Rate Limiting.

See Section C.2, “Web Services”, Section C.3, “Atom Feed Service” and Section N.4.1, “SavaPage as Sync Source in PaperCut”.

system.ratelimiting.api.failures-per-min

The maximum number of API failures per IP address per minute. The processing of any attempt that exceeds this maximum will be suspended until there is room again within the one minute time frame. Default: 5.

system.ratelimiting.print-in.enable

Set to Y (default) or N to enable/disable Print-in Rate Limiting.

See Section 4.7, “Queues”.

system.ratelimiting.print-in.failures-per-min

The maximum number of Print-in failures per IP address per minute. The processing of any attempt that exceeds this maximum will be suspended until there is room again within the one minute time frame. Default: 5.

print-in.ipp.default.wait-after-failure-msec

A wait time in milliseconds before returning after an IPP Print-in failure. This causes a next request, which may result in the same failure, to be delayed. Default: 5000.

Note: the wait time is only applied if system.ratelimiting.print-in.enable = N.

Table 17.8. Rate Limiting Configuration Properties


See Section 4.11.14, “Config Editor” on how to change these properties.