In the IP Allowlist Policy only inbound API requests from clients, policies or APIs satisfying the policy are accepted. To use this policy, you have to specify the IP address ranges to be included to be able to access the API. Addresses that you do not explicitly include are not able to access the API.
An IP Blocklist policy overrides an IP Allowlist policy.
Before PAS 22.1.1 the name of this policy was IP Whitelist. Existing policy configuration will be shown with the old name.
Configuration Options
| Option | Type | Description | Possible Values | Default |
|---|---|---|---|---|
| IP Address HTTP Header | String | Optional. Tells the API Management to use the IP address found in the given HTTP request header instead of the one associated with the incoming TCP socket. In the default setup the gateway runs behind a proxy. In the default scenario there is no need to add the header X-Real-IP in the custom header field IP Address HTTP Header. | - | - |
| Failure Response | Enum | The server response code. | Authentication Failure (403) | None |
| Enter an IP address | Array[<ipList>] | The IP address(es), and/or ranges of addresses that will be allowed to access the API. IPv4 and IPv6 are supported. |
| - |
On this Page:
Related Pages:
Overview
Content Tools