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 Functions

This reference outlines the function calls you can make from within our APIs.

• XML & JSON API Functions — Our XML API allows you to issue commands to cPanel and WHM using the XML language, while our JSON API allows you to submit requests to the system and receive a JSON response.
• cPanel API1 & API2 Functions — Our cPanel APIs let you add, modify, or delete data on the server (API1) or return data from the server (API2).
  Note: We're in the process of updating this information; in the meantime, you may find the Legacy API2 Functions Document helpful.
• 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 commands let you 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.