The IP Allowlist Policy allows access to an API’s resource based on the IP address of the client. The user must specify the IP address ranges to be included from being able to access the API. Any addresses that are not explicitly allowed are not able to access the API. It is possible to use wildcard characters to specify the allowed IP addresses. 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.
An IP Blocklist policy overrides an IP Allowlist policy.
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 allowed to access the API. IPv4 and IPv6 are supported.
| valid IP formats such as:
| - |
Click Add to create more rows in the table. Click Delete to remove selected rows. | |||
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. The PAS gateway runs behind a proxy. There is no need to add the header X-Real-IP in the custom header field IP Address HTTP Header. | a string | - |
Overview
Content Tools