documentation.cpanel.netDeveloper Documentation Home - Developer Documentation - cPanel Documentation

Skip to content Skip to breadcrumbs Skip to header menu Skip to action menu Skip to quick search 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. Spaces Hit enter to search Help Online Help Keyboard Shortcuts Feed Builder What’s new Available Gadgets About Confluence Log in Developer Documentation Pages Child pages Pages Developer Documentation Home Guide to API Authentication Guide to API Privilege Escalation Guide to cPanel API 1 Guide to cPanel API 2 Guide to cPanel Plugins Guide to cPanel Variables Guide to Custom dnsadmin Plugins Guide to Integration Links Guide to Locales Guide to Package Extensions Guide to Perl Guide to Standardized Hooks Guide to Template Toolkit Guide to Testing Custom Code Guide to the LiveAPI System Guide to the Manage2 API Guide to UAPI Guide to WHM API 0 Guide to WHM API 1 Guide to WHM Plugins Quickstart Development Guide Guide to cPanel Interface Customization and Branding Guide to External Authentication Guide to Site Publisher Templates Guide to cPanel Market Provider Modules Guide to Third-Party AutoSSL Provider Modules Guide to WHM dynamicui Files Guide to Transfer and Restore API Functions Guide to Report Receiver APIs for the ModSecurity Rule Reports Guide to Custom Service Notifications Guide to the Feature Showcase Guide to Replacing cPanel API 1 Functions with UAPI Equivalents 29 more child pages Browse pages Configure Space tools A t tachments (0) Page History Page Information Resolved comments View in Hierarchy View Source Export to PDF Export to Word Dashboard Skip to end of banner Jira links Go to start of banner Developer Documentation Home Skip to end of metadata Created by Jennifer , last modified by Documentation on Mar 27, 2020 Go to start of metadata Developer Documentation Search New to developing for cPanel & WHM? Our Quickstart Development Guide will guide you in the right direction for your project. API Documentation Reference Libraries: UAPI — Access and modify cPanel account data and settings. cPanel API 2 — Use UAPI when available. WHM API 1 — Perform server administration tasks. Manage2 API — Automate cPanel license management. Deprecated Libraries: cPanel API 1 — Use UAPI instead. WHM API 0 — Use WHM API 1 instead. Developer Resources XML-API PHP Class PublicAPI Perl Repository cPanel API Call Tracer PublicAPI PHP Repository Third-Party Libraries cPanel Developers Forum Development Guides 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 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 Variables — The LiveAPI system and dynamicui files can access cPanel's global variables. 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 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 Transfer and Restore API Functions — The system uses several WHM API 1 functions during the transfer and restore process. 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. Tutorials 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 — Error rendering macro 'excerpt-include' No link could be created for 'SDK:Tutorial - Call UAPI's SSL::install_ssl Function in Custom Code'. Use UAPI's Fileman::upload_files Function in Custom Code — Error rendering macro 'excerpt-include' No link could be created for 'SDK:Tutorial - Use UAPI's Fileman::upload_files Function in Custom Code'. 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. Replace a cPanel API 1 Function With a UAPI Function — This tutorial shows how to replace a deprecated cPanel API 1 function with a UAPI function in a cPanel integration or plugin . If you have questions or need help with your customization project, join the conversation on our cPanel Developers Forum , or reach out to us in Discord . We encourage anyone who develops for cPanel products to read the cPanel Blog , and join our Plugin Developers mailing list. -- No labels Overview Content Tools Powered by Atlassian Confluence 6.15.2 Printed by Atlassian Confluence 6.15.2 Report a bug Atlassian News Atlassian cPanel, WebHost Manager, and WHM are registered trademarks of cPanel, L.L.C. for providing its computer software that facilitates the management and configuration of Internet web servers. ®2020 All rights reserved. {"serverDuration": 303, "requestCorrelationId": "8649dc7c1458dd16"}...