REST API IP-based restrictions


Want to allow API Access through a specific IP range? You can do it using IP-based restrictions.

Enabling the "Restrict Access to API by IP Address" effectively controls API access, permitting connections only from specified networks. By configuring this restriction, you enhance the security of your API by limiting access to trusted IP addresses, reducing the potential exposure to unauthorized entities. API access will only be allowed from the configured API networks.

When using IP-based restrictions in an environment where your instance is behind a reverse proxy, enabling "Reverse Proxy Compatibility" ensures that the client's real IP address is correctly detected. By specifying the appropriate header name, such as X-Forwarded-For, which the reverse proxy uses to forward the client's IP, you can ensure that IP-based restrictions are enforced based on the actual client IP rather than the proxy’s address.

miniOrange REST Restrict Access to Public API

Code API Response
403 {
  "error": {
  "status": "ERROR",
  "message": "Not valid IP address/Range"
  }
 }