Why cPanel API is unreachable? Let’s see some of the possible causes for the issue, along with the troubleshooting steps in this article. Bobcares, as a part of our cPanel & WHM Support Services offers solutions to every query that comes our way.

cPanel API Unreachable: Explanation

When trying to use WHMCS Single Sign-On, it returns the following error:

Action Failed Unable to auto-login. Please contact support.

The cPanel error_log returns the following error:

info [xml-api] You do not have permission to create sessions for the user “USER”. [create_user_session] version [1].

WHMCS is meant to manage the server’s root account and perform root tasks. However, if the API token used to control WHM does not have the “all” ACL, some operations may fail. WHMCS Single Sign-On expects the configured WHM Token to have root access.

cPanel API Unreachable: Causes

1. The firewall on the server or network may be preventing access to the cPanel API port.

2. In rare situations, the WHM/cPanel service itself may be down, rendering the API inaccessible.

3. The API connection code may contain a false server hostname, IP address, or port number.

4. The API keys (username and password) we’re using may be invalid or lack the needed permissions.

cPanel API Unreachable: Troubleshooting

1. First of all, we must check the WHM root API token being used in WHMCS has all privileges for root.

2. If telnet is available in the setup, use it to test connectivity to port 2087 on the server’s IP address. If the connection times out, it is most likely due to a firewall issue.

3. If server’s firewall setup is visible, we must check the rules for port 2087. Make sure it is open to receive connections from the IP address or the specified network range.

4. Check the web hosting provider’s status page to find if there have been any reported outages with WHM/cPanel services.

5. Check that the server hostname, IP address, and port number in the code match to the actual server setup.

6. Check that the API login and password we’re using are correct and have the necessary permissions to access the cPanel API functions we want to use.

7. Check the server’s error logs, especially the WHM/cPanel and system logs, for any cPanel API-related problem messages. It can provide more details about the source of the problem.

[Looking for a solution to another query? We are just a click away.]

Conclusion

This article offers the a brief explanation of the cPanel API unreachable issue, along with its causes and simple fixes from our Experts.