Skip to end of metadata
Go to start of metadata

Software Development Kit


New to developing for cPanel & WHM? Our Quickstart Development Guide will guide you in the right direction for your project.







API Documentation


cPanel API 2


Manage2 API

Deprecated APIs

cPanel API 1


Development Guides

Guide to Testing Custom Code This guide explains the basics of how to test your custom code.

Guide to cPanel Interface Customization You can use several different methods to modify the appearance of the cPanel interface.

Guide to cPanel Plugins cPanel plugins add new functionality to the cPanel interface.

Guide to WHM Plugins WHM plugins add new functionality to the WHM interface.

Guide to Template Toolkit Template Toolkit is the main template system for the cPanel and WHM interfaces.

Guide to Site Publisher Templates You can create your own custom templates for cPanel's Site Publisher feature.

Guide to API Authentication cPanel & WHM supports several API authentication methods.

Guide to Standardized Hooks Standardized Hooks trigger applications when cPanel & WHM performs an action.

Guide to Package Extensions Package extensions add custom fields to packages and accounts.

Guide to Perl in cPanel & WHM cPanel & WHM ships with multiple Perl environments.

Guide to cPanel VariablesThe LiveAPI system and dynamicui files can access cPanel's global variables.

Guide to AppConfig The AppConfig system configures cPanel & WHM attributes and registers WHM plugins.

Guide to Locales The locale system localizes text in Perl, Template Toolkit, or JavaScript code.

Guide to the LiveAPI System The LiveAPI System provides environments for applications in the cPanel interface.

Guide to Custom dnsadmin Plugins Custom dnsadmin plugins can update DNS records on external systems.

Guide to API Privilege Escalation To run a function with escalated privileges, call a function through the Call method or use the send_cpwrapd_request pluggable wrapper.

Guide to External AuthenticationPluggable external authentication modules allow users to log in through OpenID Connect-compliant identity providers.


Create a Custom cPanel Style This tutorial creates a custom cPanel style, and applies it to the cPanel interface.

Create a New Paper Lantern Interface in Template Toolkit This tutorial uses Template Toolkit to create a new cPanel interface for the Paper Lantern theme.

Create a New Paper Lantern Interface in PHP This tutorial uses PHP to create a new cPanel interface for the Paper Lantern theme.

Add a Link to the cPanel Interface This tutorial adds an icon that links to an external location to the cPanel interface.

Call UAPI's SSL::install_ssl Function in Custom Code This tutorial creates custom code to call UAPI's SSL::install_ssl function.

Use UAPI's Fileman::upload_files Function in Custom Code This tutorial explains the process to upload files with UAPI's Fileman::upload_files function.

Create a Standardized Hook This tutorial adds custom hooks to preserve a customized configuration file.

Create an Integration LinkIntegration links allow you to create a link in a user's cPanel interface.



If you have questions or need help with your customization project, join the conversation on our cPanel Developers Forum, or send an email to

We encourage anyone who develops for cPanel products to read the cPanel Blog, and join our Plugin Developers mailing list.




  • No labels