API check failed – how to troubleshoot

In the new version of Epos (14.1.0.0), we introduced many useful features that can improve your work efficiency and user experience (see Epos updates).

One of the features is Dashboard. It is a fully customizable cloud service, where you can organize your files: pin your documents, notes, meeting recordings, etc., as well as use ChatGPT and implemented microservices (document editing and others).

To be able to use Dashboard, your server has to undergo an API check during the upgrade. It is necessary to ensure that your server is reachable from outside. When the API check starts, it opens two simultaneous sessions between the client’s server and Dashboard microservice in the Cloud.

1. In the first session, the client’s server contacts Dashboard and requests access. Dashboard asks for the Smart Discover settings that the client specified previously in Remote Management Console -> System -> Services -> SmartDiscover tab.

   Note: Remote Management Console is designed for Windows. If your server is on Linux or Docker, you will have to run a Windows virtual machine.

   

2. In the second session, Dashboard tries to contact the client’s server using the Smart Discover settings. If this attempt is successful, the client’s server receives the answer through the first session that it has access to Dashboard.

A successful API check procedure ensures that the server is accessible for other network services.

We created a detailed description of the IceWarp server upgrade process for Windows, Linux, and Docker.

Troubleshooting

In case the upgrade installation was not successful due to the API check error, please follow the steps.

1. Check if ports 443 and 80 are open for two-way communication (see – IceWarp ports. Ports related to Dashboard microservice have to be open).

   Note: To complete the API check, no other service can run at port 443 besides the IceWarp server.

2. Check if you can telnet into api.icewarp.com, webui.icewarp.com, and login.icewarp.com over ports 443 and 80 and receive the response from those servers.

3. Check if your hostname is resolvable from outside of your network, i.e. your server allows external connections. For example, access your server from mobile internet.
4. Check your network and firewall settings to verify that ports 443 and 80 are not blocked and incoming connections are allowed. Adjust the firewall rules to permit HTTPS.
5. Check your DNS records.
   • In Remote Management Console: Domains & Accounts -> Management -> {domain} -> Information tab
   • In WebAdmin: -> Users & domains -> {domain} -> Properties ->

     If you need more details on DNS records, see DNS in IceWarp Cloud. It is also relevant for on-premise users with one difference: change myaccount.onice.io for your hostname.

6. Check your SmarDiscover settings.

   Remote Management Console -> System -> Services -> SmartDiscover

   Make sure that your Public Hostname is indicated in all Services and URL fields. The SMTP and POP3 fields can contain either the hostname or IP addresses of the server where the SMTP and POP3 services run. Addresses have to be public for SmartDiscover to work properly. (see How to set up Autodiscover).
7. Check if you have an active SSL certificate for your host server and autodiscover server.

   Remote Management Console -> System -> Certificates

   You can add a Let's Encrypt Certificate to the server (see Let's Encrypt certificate).

8. If all essential ports are open and you can telnet into api.icewarp.com, webui.icewarp.com, and login.icewarp.com it is likely that Dashboard will work. If the API check still gives an error, you can skip it.

   Command to skip the API check:

   • .\install.exe /skipapicheck – for Windows
   • ./install.sh --skip-api-check – for Linux
   • ./install.sh --skip-api-check – for Docker

   If after the upgrade, Dashboard is not available, contact our Support Team to troubleshoot it.