Skip to main content

  • Core Products

  • Add-Ons

  • Extensions Marketplace

IP whitelist

For added security, Agora Chat provides the IP whitelist function. If only certain IP addresses are allowed to call the RESTful APIs to send messages, you can add these IP addresses to the IP whitelist on the Agora console. IP addresses outside the IP whitelist cannot call the RESTful API to send messages.

Add an IP address to the IP whitelist​

  1. Log in to Agora Console.

  2. In the left navigation bar of the Agora console, choose Chat > Features > IP Whitelist to open the Security Setting page.

  3. On the Security Setting page, click Add and enter the IP address in the Add IP Address dialog box that is displayed.

  • You can add at most eight IP addresses, with only one each time.
  • The new IP addresses take effect 10 minutes after addition.
  • When the IP whitelist is empty, all IP addresses can send messages via the RESTful APIs.

    1. Click OK to complete the configuration.

      IP_whitelist_add_IP

    Remove an IP address from the IP whitelist​

    If you no longer allow an IP address to send messages via the RESTful APIs, you can remove it from the IP whitelist. If you delete all IP addresses in the IP whitelist, that is, the whitelist is empty, all IP addresses can send messages via the RESTful APIs by default.

    1. Log in to Agora Console.

    2. In the left navigation bar of the Agora console, choose Chat > Features > IP Whitelist to open the Security Setting page.

    3. In the IP Whitelist list, click Delete to the right of an IP address.

      IP_whitelist_delete_IP

    4. Click OK to delete the IP address.