We have a new documentation site for cPanel & WHM! You can find our new documentation site at docs.cpanel.net.
We will continue to maintain our API documentation on this server.
New to developing for cPanel & WHM? Our Quickstart Development Guide will guide you in the right direction for your project.
Guide to Testing Custom Code — This guide explains the basics of how to test your custom code.
Guide to cPanel Interface Customization and Branding — 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 WHM dynamicui Files — WHM themes use
dynamicui files to display icons and groups.
Guide to Template Toolkit — Template Toolkit is the main template system for the cPanel and WHM interfaces.
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 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 pluggable wrapper.
Guide to External Authentication — External Authentication modules allow users to log in through OpenID Connect-compliant identity providers.
Guide to cPanel Market Provider Modules — This document explains how to create a third-party custom cPanel Market provider module with basic functionality.
Guide to Report Receiver APIs for the ModSecurity Rule Reports — This document describes report receiver API endpoints for the ModSecurity™ Rule Reports.
Guide to Replacing cPanel API 1 Functions with UAPI Equivalents — This document lists the UAPI functions which replace previously-deprecated cPanel API 1 functions.
Guide to Integration Links — Integration links create a link in a user's cPanel interface using WHM API 1.
Create a Custom cPanel Style — This tutorial creates a custom cPanel style and applies it to the cPanel or Webmail interfaces.
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
Use UAPI's Fileman::upload_files Function in Custom Code — This tutorial explains the process to upload files with UAPI's
Create a Standardized Hook — This tutorial adds custom hooks to preserve a customized configuration file.
Create a ModSecurity Vendor — This tutorial describes how to create a custom ModSecurity™ vendor.