Handling Error Return Codes in HestiaCP Plugin

Overview

When using the HestiaCP Plugin for ClientExec, you may occasionally encounter error return codes that indicate an issue with the API call. One common example is return code 9, which signifies “Wrong / Invalid password.” To assist you in troubleshooting and resolving these issues, this article explains how to interpret return codes and provides a link to HestiaCP’s official return codes documentation.

What Are Return Codes?

Return codes are numerical values returned by the HestiaCP API when an error or issue occurs. These codes provide information on the nature of the problem, allowing you to take the appropriate corrective actions.

For example:

• Return Code 9: Indicates that the wrong or invalid password was provided during the API call.

Common Return Codes

Here are some frequently encountered return codes when using the HestiaCP plugin:

• 0: Success – The API call was successful.
• 4: Object already exists – The requested object (e.g., user, domain) already exists.
• 9: Wrong / Invalid password – The password supplied is incorrect or invalid.

Example: Error Code 9 – Invalid Password

If you receive return code 9, this indicates an invalid password was supplied during the API request. To resolve this issue:

1. Verify that the correct username and password are being used for the HestiaCP API.
2. Ensure that there are no typos or incorrect formatting (e.g., extra spaces).
3. If the password is still rejected, reset it via the HestiaCP control panel and update the credentials in ClientExec.

Full List of HestiaCP Return Codes

For a complete list of HestiaCP return codes and their explanations, you can visit the official documentation using the link below:

HestiaCP Return Codes Documentation

This resource provides detailed descriptions for all return codes and their meanings, helping you troubleshoot various issues encountered with the API.

Troubleshooting Tips

• Double-check credentials: Ensure that the username and password for the API are correct and up-to-date.
• API Permissions: Ensure that the API user has the correct permissions for the requested operation.
• Missing Arguments: If you encounter a “Missing arguments” error, verify that all required parameters are being passed in the API call.

By referencing the error codes and their meanings, you can quickly identify and resolve issues with HestiaCP integration, ensuring smooth communication between ClientExec and your hosting control panel.