RESTful API IP allowlist

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. From the sidebar, select RTC Services.

3. Find Chat and click Open chat console.

4. From the side panel, select Security Setting.

5. On the Security Setting page, click Create and enter the IP address.

   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.

6. Click Save to complete the configuration.

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.

1. Follow the same steps as Add an IP address to open the Security Setting page.

2. In the IP Whitelist, select and delete the IP address.