Page History
Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
The IP Blocklist Policy blocks access to an API’s resource based on the IP address of the client. The user must specify the IP address ranges to be excluded from being able to access the API. Any addresses that are not explicitly excluded are able to access the API. It is possible to use wildcard characters to specify the IP addresses to be blocked. It is also possible to define the return error code sent in the response to the client in case a request fails due to the violation of this policy.
Multiexcerpt include SpaceWithExcerpt INTERNAL MultiExcerptName note_allowlist_blocklist PageWithExcerpt INTERNAL:_api_excerpts
Configuration Options
Basic Configuration
Option | Description | Possible Values | Default | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Failure Response | Select how the gateway should respond to a client if the request fails due to a violation of this policy. |
| Server Error (500) | ||||||||
IP Address Rule | The IP address(es), and/or ranges of addresses that will be blocked from accessing the API. IPv4 and IPv6 are supported. | valid IP formats such as:
| - | ||||||||
|
Advanced Configuration
Option | Description | Possible Values | Default | ||
---|---|---|---|---|---|
IP Address HTTP Header | Optional. The header can be used to identify the original IP address of the client.
| a string | - |
Panel | ||
---|---|---|
| ||
|
Panel | ||
---|---|---|
|
Otp | ||
---|---|---|
|