API – IP Whitelisting Customization

Administrators can increase the security of external APIs for each site (subdomain) by whitelisting single IP addresses or IP address ranges. External API requests that come from an IP that isn’t on the whitelist will receive an Authorization has been denied for this request error message.

           

TIP

When no IP ranges are enabled, all IPs can access external APIs. Once one or more IP ranges are enabled, access to external APIs is restricted to those whitelisted IP addresses.

           

IP-API-whitelisting-June-20-2021-768x84.png

Add or Edit an IP Range Restriction

           

TIP

If you use a proxy server that does not truthfully report the original host’s IP address, you will need to add your proxy IP to the whitelisted range manually.

           

To add or edit a whitelisted IP range restriction:

  1. Go to Settings SettingsNew.png > Customization > Integrations.
  2. Click API – IP Whitelisting.
  3. To add or edit:
    1. Add:
      1. Click + New.
    2. Edit:
      1. Click to select the IP range restriction.
        Or:
        Select Edit from the Actions menu (three dots).
        IP-API-whitelisting-actions-June-20-2021.png
  4. Type the lower IP in the range in From. (Mandatory field.)
    • The IP address in the From field must be lower than the IP address in the To field.
  5. Type the higher IP in the range in To. (Mandatory field.)

               

    TIP

     

    The To IP can be the same as the From IP if you only want to whitelist a single IP address

               

  6. Type a Description.
  7. Click the Enable toggle switch until it is blue and ON.
  8. Click Save & Close.

Disable an IP Range Restriction

To disable a whitelisted IP range restriction:

  1. Click to select the IP range restriction.
    Or:
  2. Select Edit from the Actions menu.
  1. Click the Enable toggle switch until it is gray and OFF.
  2. Click Save & Close.

Delete an IP Range Restriction

To delete a whitelisted IP range restriction:

  1. Either:
    1. Select Delete from the Actions menu.
      Or:
    2. Click to select the IP range restriction to be deleted.
    3. Click Delete.
  2. Click Yes to confirm.