Inquiry: Integrating Console/VNC Access via API for WHMCS Module

  • Hi there,

    I’m currently integrating your services into my WHMCS platform using a custom-built module. As part of this integration, I aimed to provide a Console feature (VNC/KVM access) for clients, since it is a critical function for server management tasks such as OS installation, recovery, and network troubleshooting.

    After reviewing the available API documentation, I was unable to find any endpoints related to retrieving a VNC console URL or generating a NoVNC session/token.

    I would appreciate your clarification on the following:

    • Is there any available (public or private) API endpoint to retrieve a temporary VNC/console access URL for a VPS?
    • Do you offer a console proxy or any embeddable solution that allows integration with external systems like WHMCS?
    • If direct API access is not supported, what would be the recommended approach to provide clients with out-of-band console access without redirecting them to your main control panel?

    Additionally, I would like to suggest considering the implementation of a VNC/NoVNC console API in future updates, as this feature is highly valuable for service providers who rely on external billing systems like WHMCS.

    Technical Context:

    • Platform: WHMCS (custom module)
    • Requirement: Remote Console Access (VNC/KVM)

    Looking forward to your guidance and any possible solutions or roadmap updates regarding this feature.

    Best Regards,

    Mohamed Elsayed

  • Hi WebCraker

    thanks for your questions! :)

    Please note that access to our VNC console is not documented, as we reserve the right to replace the underlying technology at any time if required.
    Consequently, we do not guarantee backward compatibility. An integration with external system is therefore not supported or intended.
    You can find all API operations supported by us documented in this Help center article.

    However, we'd like to inform you that we'll launch a new beta version of the Server Control Panel UI on May 18 – this release includes a noVNC-based console. If you are interested, please feel free to inspect und reverse-engineer it, using your browser's developer tools, as we do not provide official documentation.

    Further information on this will be posted in the ‘SCP’ section of the forum from the date mentioned above.

    We hope you have a good day! :)

    Kind regards
    Sarah & the netcup team