Developer Resources

If you’re a developer, the cPanel and WHM software makes a number of tools available to you, including APIs that let you incorporate cPanel and WHM functions into your own applications.

API References

These references outline available API calls within the cPanel/WHM and Manage2 systems.

• XML & JSON API Functions — This API allows for WHM-level access into your server. Account Management, Server Administration and Server Maintenance functions are included within the XML API. The XML API also has a call for accessing API1 and API2 functions.
• cPanel API1 & API2 Functions — API1 and API2 drive the cPanel interface, Email, FTP, MySQL, etc. Most user-level systems within cPanel are available through API1 and API2.
• Manage2 API Functions — This API allows you to automate procedures related to license management.

Front-End Development

This section provides basic background information about how to use our cPanel APIs.

• Calling API1 Functions
• Calling API2 Functions

Remote Interaction

These documents provide details about interacting with cPanel and WHM remotely, from your own custom applications.

• XML and JSON API — These API functions allow you to perform cPanel and WHM functions remotely, without having to access the user interface.
• cPanel Accounting — The cPanel::Accounting modules predate our XML API. We strongly recommend that you use the XML API rather than these modules. This documentation is provided for legacy purposes only.

Extending cPanel Functionality

This section provides useful information about how to tailor cPanel and WHM functions for your users.

• Writing cPanel Modules — This document outlines the most powerful way of integrating your custom applications with cPanel — by writing a Perl module.
• Installing cPanel Plugins — cPanel Plugins are custom applications you can make available from your users' cPanel interfaces. This document tells you how to integrate Plugins with cPanel.
• Creating cPAddon Scripts — cPAddons are additional services, such as blogs, message boards, and shopping carts, that you can allow your users to place on their websites. These pages explain how to integrate cPAddons with cPanel.
• Hooking into cPanel Functionality — There are 3 ways to hook into cPanel’s APIs:
  • cPanel function hooks — This method is preferred.
  • Script hooks — The best way to hook into cPanel's update or account provisioning systems.
  • The CustomEventHandler — This method is the most powerful.
• Creating WHM Plugins — This document describes the process of creating your own plugins to extend WHM's functionality.
• cPanel PHP — This document describes using PHP to extend functionality through the cPanel interface.

Downloads

Click here to find examples, samples, and reference code.