add-response-headers
Use the add-response-headers configuration entry to add rate limiting
policy information to the HTTP response.
Syntax
add-response-headers = <yes|no>Description
This configuration entry controls whether the rate limiting response headers are added to the
response or not. The following HTTP headers are added to the HTTP response for requests that match a
rate limiting policy.
- X-Rate-Limit-Policy
- The name of the rate limiting policy that is closest to being exceeded. The policy name is obtained from the name configuration entry within the policy YAML file.
- X-Rate-Limit-Remaining
- The number of requests that are left for the rate limiting policy in the current rate-limit window.
- X-Rate-Limit-Reset
- The time (Coordinated Universal Time Epoch time) at which the rate limiting policy resets.
Options
- yes
- The rate limiting headers are added to HTTP responses.
- no
- The rate limiting headers are not added to HTTP responses.
Usage
This stanza entry is optional.
Default Value
no
Example
add-response-headers = yes