Difference: IndexInclude (1 vs. 44)

Revision 4407 Oct 2013 - Main.SarahHaney

Line: 1 to 1
 
META TOPICPARENT name="WebHome"

Standardized Hooks

Line: 121 to 121
 
Custom Event Handlers A custom event handler is a powerful tool that allows you to access operations triggered by the cPanel interface. You can create custom event handlers as pre and post event handlers—meaning that the action is taken before or after an API function executes.
The cPanel Logger Module You can use the Cpanel::Logger module to raise error messages in a custom event handler.
Universal Password Trap As a cPanel account password can be changed in a number of places, including both cPanel and WHM, we've created a universal hook that fires anytime an account password is changed.
Deleted:
<
<
Hooking into EasyApache  
 
EasyApache Hooks Using EasyApache, you can automatically perform actions before or after rebuilding Apache.
Added:
>
>
RPM::Versions Hooks RPM::Version hooks allow you to execute custom code whenever an RPM installs, updates, or uninstalls.
 

Developer Software

Revision 4319 Sep 2013 - Main.SarahHaney

Line: 1 to 1
 
META TOPICPARENT name="WebHome"

Standardized Hooks

Line: 76 to 76
 
The swapip Utility Though it does not reside in the /scripts directory, this tool allows you to update the IP address in a DNS zone record.
The cPanel Logger Module The Cpanel::Logger module can be used to raise error messages in a custom event handler. This module provides a common interface for logging to files, such as cPanel's error_log.
Pluggable dnsadmin Modules You can create pluggable dnsadmin modules that automate tasks in your DNS cluster. This set of documents describes how to create these modules.
Added:
>
>
Package Extensions You can create extensions to add to hosting packages, with editable variables that are visible in WHM.
 
EasyApache Modules  
Custom Modules You can add features to EasyApache by developing custom modules.
Deleted:
<
<
Package Extensions You can create extensions to add to hosting packages, with editable variables that are visible in WHM.
 

cPAddons (Site Software)

Revision 4218 Sep 2013 - Main.SarahHaney

Line: 1 to 1
 
META TOPICPARENT name="WebHome"

Standardized Hooks

Line: 78 to 78
 
Pluggable dnsadmin Modules You can create pluggable dnsadmin modules that automate tasks in your DNS cluster. This set of documents describes how to create these modules.
EasyApache Modules  
Custom Modules You can add features to EasyApache by developing custom modules.
Added:
>
>
Package Extensions You can create extensions to add to hosting packages, with editable variables that are visible in WHM.
 

cPAddons (Site Software)

Revision 4110 Sep 2013 - Main.JenniferDoubrava

Line: 1 to 1
 
META TOPICPARENT name="WebHome"

Standardized Hooks

Deleted:
<
<
For cPanel & WHM 11.32
  The Standardized Hooks System is useful for developers and administrators who want to automatically trigger a script or application when a specific action is performed in cPanel & WHM. It allows you to customize the way cPanel & WHM functions under generic or specific scenarios. Having this fine-grain control allows more flexibility when implementing cPanel & WHM systems and the end-user functionality therein.
Line: 20 to 19
 

AppConfig

Changed:
<
<
For cPanel & WHM 11.32
>
>
  This document describes a cPanel subsystem that can allow you to affect a PHP application served from within cPanel, WHM, or webmail.

Revision 4005 Jul 2013 - Main.LaurenceSimon

Line: 1 to 1
 
META TOPICPARENT name="WebHome"

Standardized Hooks

Line: 73 to 73
 
WHM Plugins  
Creating WHM Plugins You can create WHM plugins that extend WHM's functionality.
ACL Reference Table You can find our access control reference table here.
Added:
>
>
Pluggable WHM ACLs Information about pluggable WHM ACLs.
 
The swapip Utility Though it does not reside in the /scripts directory, this tool allows you to update the IP address in a DNS zone record.
The cPanel Logger Module The Cpanel::Logger module can be used to raise error messages in a custom event handler. This module provides a common interface for logging to files, such as cPanel's error_log.
Pluggable dnsadmin Modules You can create pluggable dnsadmin modules that automate tasks in your DNS cluster. This set of documents describes how to create these modules.

Revision 3923 Apr 2013 - Main.JenniferDoubrava

Line: 1 to 1
 
META TOPICPARENT name="WebHome"

Standardized Hooks

Line: 36 to 36
 
Authenticating API Function Calls 2 methods you can use to authenticate API function calls.
cPanel Template Toolkit cPanel Template Toolkit is a template-driven parser for API2 calls. This document describes how to use the cPanel Template Toolkit.
Internal API  
Added:
>
>
Calling Unified API (UAPI) Functions Learn how to call UAPI functions directly. If you plan to make your application compatible with all future versions of cPanel & WHM, you should use our LiveAPI system whenever possible.
 
Using API 1 Functions Learn how to call API 1 functions directly using cPanel tags. cPanel tags are supported but will eventually be phased out. If you plan to make your application compatible with all future versions of cPanel & WHM, you should use our LiveAPI system whenever possible.
Using API 2 Functions This document describes how to call API 2 functions in cPanel tags. cPanel tags are supported but will eventually be phased out. If you plan to make your application compatible with all future versions of cPanel & WHM, you should use our LiveAPI system whenever possible.
Using API 1 & 2 Functions via XML API You can call API 1 and API 2 functions using our XML API.
Added:
>
>
UAPI Functions A reference list of UAPI functions and modules.
 
API 1 Functions A reference list of API 1 functions and modules.
API 2 Functions A reference list of API 2 functions and modules. When coding for the cPanel interface, the API 2 system can utilize a custom templating system, based on Template Toolkit, to display data returned by the functions. API 2 is much more flexible than API 1, but requires more sophisticated coding. We recommend using API 2 whenever possible.
Whostmgr::XMLUI::cPanel Perl Module The Whostmgr::XMLUI::cPanel module allows you to execute cPanel API 1 and API 2 functions natively from within your Perl applications.

Revision 3826 Feb 2013 - Main.JenniferDoubrava

Line: 1 to 1
 
META TOPICPARENT name="WebHome"

Standardized Hooks

Line: 119 to 119
 
The cPanel Logger Module You can use the Cpanel::Logger module to raise error messages in a custom event handler.
Universal Password Trap As a cPanel account password can be changed in a number of places, including both cPanel and WHM, we've created a universal hook that fires anytime an account password is changed.
Hooking into EasyApache  
Changed:
<
<
EasyApache Hooks? Using EasyApache, you can automatically perform actions before or after rebuilding Apache.
>
>
EasyApache Hooks Using EasyApache, you can automatically perform actions before or after rebuilding Apache.
 

Developer Software

Revision 3718 Feb 2013 - Main.LaurenceSimon

Line: 1 to 1
 
META TOPICPARENT name="WebHome"

Standardized Hooks

Line: 53 to 53
 You can create cPanel modules and plugins to extend cPanel's functionality. WHM plulgins allow you to add new functionality to WHM. These documents explain how to create modules and plugins for cPanel & WHM.

cPanel Modules
Changed:
<
<
Installing Internal Perl Modules Instructions to install your own internal Perl modules.
>
>
Installing Perl Modules Instructions to install your own internal Perl modules.
 
Writing cPanel Modules Modules are software components that you can add to cPanel to extend cPanel's functionality.
The PHP Accounting Module Learn how to use access keys with cPanel's PHP accounting module.
The cPanel::Accounting Perl Module Learn how to use remote access keys with the cPanel::Accounting Perl module.

Revision 3630 Jan 2013 - Main.LaurenceSimon

Line: 1 to 1
 
META TOPICPARENT name="WebHome"

Standardized Hooks

Line: 75 to 75
 
The cPanel Logger Module The Cpanel::Logger module can be used to raise error messages in a custom event handler. This module provides a common interface for logging to files, such as cPanel's error_log.
Pluggable dnsadmin Modules You can create pluggable dnsadmin modules that automate tasks in your DNS cluster. This set of documents describes how to create these modules.
EasyApache Modules  
Changed:
<
<
Custom Modules? You can add features to EasyApache by developing custom modules.
>
>
Custom Modules You can add features to EasyApache by developing custom modules.
 

cPAddons (Site Software)

Revision 3524 Aug 2012 - Main.StacyWyatt

Line: 1 to 1
 
META TOPICPARENT name="WebHome"

Standardized Hooks

Line: 66 to 66
 
Installing cPanel Plugins cPanel plugins must be installed and used in a specific way. You can learn about installing cPanel plugins here.
Adding Icons and Groups Learn about adding icons and groups to the cPanel interface.
Plugin Installation File Generator You will need to generate an installation file for your plugins.
Changed:
<
<
Plugin Security Policy You can read cPanel's plugin security policy here.
>
>
Plugin Security Policy cPanel's plugin security policy: Information for implementing multi-layer authentication for WHM, cPanel, and Webmail.
 
Using PHP in a cPanel Plugin's Interface For cPanel & WHM 11.30 and older versions of cPanel & WHM — We have refactored this system so that it applies to an expanding list of scripting languages. You should review our LiveAPI documentation for the most recent information. cPanel allows for additional pages to be written in PHP rather than straight HTML. This document describes using PHP to generate a cPanel plugin's interface.
WHM Plugins  
Creating WHM Plugins You can create WHM plugins that extend WHM's functionality.

Revision 3412 Mar 2012 - Main.JustinSchaefer

Line: 1 to 1
 
META TOPICPARENT name="WebHome"

Standardized Hooks

For cPanel & WHM 11.32
Changed:
<
<
noteNote: The Standardized Hooks documentation is currently under revision. You should check back shortly for improvements to this information.

The Standardized Hooks system adds sanity checks to your custom module and function hooks.

This system also offers a series of insertion points you can use to perform tasks on your cPanel & WHM server.

>
>
The Standardized Hooks System is useful for developers and administrators who want to automatically trigger a script or application when a specific action is performed in cPanel & WHM. It allows you to customize the way cPanel & WHM functions under generic or specific scenarios. Having this fine-grain control allows more flexibility when implementing cPanel & WHM systems and the end-user functionality therein.
  This system is only available in cPanel & WHM versions 11.32 and later.

Document Description
Changed:
<
<
Abstract This document is a high-level description of the Standardized Hooks system.
Basic Usage You can find basic use information for the new system in this document.
Advanced Usage This document covers more advanced features of the Standardized Hooks system.
Insertion Points You can find the list of the Standardized Hooks system's insertion points and learn how to use them here.
Troubleshooting The Standardized Hooks system contains a wealth of robust troubleshooting features. You can learn about them here.
>
>
Introduction A brief introduction to standardized hooks.
Taxonomy An in-depth looking into the components of the Standardized Hooks System.
Getting Started Learn the key elements you will need to know to use cPanel's standardized hooks.
Hooks Management Interface The Standardized Hooks management utility allows you to maintain a registry of the Standardized Hooks associated with your cPanel &WHM system.
Hookable Events Hookable events are specific points in cPanel & WHM events where you are allowed execute custom code.
Advanced Usage You can do more than just execute code with standardized hooks. This document provides additional information about this system's advanced features.
Troubleshooting This document covers very basic information about troubleshooting Standardized Hooks. For more in-depth troubleshooting help, please visit forums.cpanel.net or open a support ticket.
 

AppConfig

Revision 3314 Feb 2012 - Main.JustinSchaefer

Line: 1 to 1
 
META TOPICPARENT name="WebHome"

Standardized Hooks

Line: 42 to 42
 
Using API 1 & 2 Functions via XML API You can call API 1 and API 2 functions using our XML API.
API 1 Functions A reference list of API 1 functions and modules.
API 2 Functions A reference list of API 2 functions and modules. When coding for the cPanel interface, the API 2 system can utilize a custom templating system, based on Template Toolkit, to display data returned by the functions. API 2 is much more flexible than API 1, but requires more sophisticated coding. We recommend using API 2 whenever possible.
Added:
>
>
Whostmgr::XMLUI::cPanel Perl Module The Whostmgr::XMLUI::cPanel module allows you to execute cPanel API 1 and API 2 functions natively from within your Perl applications.
 
External API  
XML and JSON API Our XML and JSON APIs allow you to interact with WHM.
Parsing XML Data Learn how to parse XML output.

Revision 3220 Jan 2012 - Main.JustinSchaefer

Line: 1 to 1
 
META TOPICPARENT name="WebHome"

Standardized Hooks

For cPanel & WHM 11.32
Added:
>
>
noteNote: The Standardized Hooks documentation is currently under revision. You should check back shortly for improvements to this information.
  The Standardized Hooks system adds sanity checks to your custom module and function hooks.

Revision 3113 Jan 2012 - Main.JustinSchaefer

Line: 1 to 1
 
META TOPICPARENT name="WebHome"

Standardized Hooks

Line: 57 to 57
 
The cPanel::Accounting Perl Module Learn how to use remote access keys with the cPanel::Accounting Perl module.
Writing cPanel Plugins  
cPanel Plugins cPanel Plugins allow you to integrate third-party applications with cPanel. You can use plugins to add links to your users' cPanel interfaces.
Changed:
<
<
LiveAPI This document covers some basic information about the LiveAPI system. The LiveAPI system is a growing body of work that will make creating software with cPanel & WHM's API and interpreted languages, such as Perl or PHP, much easier.
  • LiveAPI PHP Class — The LiveAPI PHP class is a PHP framework you can use within cPanel. This framework provides PHP scripts with a local socket to the cPanel binary, cpsrvd, allowing your script to make API1 and API2 calls to the local machine via the socket.
>
>
LiveAPI This document covers some basic information about the LiveAPI system. The LiveAPI system is a growing body of work that will make creating software with cPanel & WHM's API and interpreted languages, such as Perl or PHP, much easier.
  • LiveAPI PHP Class — The LiveAPI PHP class is a PHP framework you can use within cPanel. This framework provides PHP scripts with a local socket to the cPanel binary, cpsrvd, allowing your script to make API1 and API2 calls to the local machine via the socket.
  • LiveAPI Perl Module — The LiveAPI Perl Module provides Perl scripts with a local socket to the cPanel binary, cpsrvd.
 
cPanel CGI Scripts CGI scripts can be very useful when you need more flexibility than cPanel's other integration methods allow. This document describes where and how to create your CGI script.
Plugin Variables This page documents the variables available within cPanel's HTML logic and DynamicUI files.
DynamicUI Reference Charts You can use these charts as a reference guide whenever adding items to your cPanel interface.

Revision 3006 Jan 2012 - Main.JustinSchaefer

Line: 1 to 1
 
META TOPICPARENT name="WebHome"

Standardized Hooks

Line: 51 to 51
 You can create cPanel modules and plugins to extend cPanel's functionality. WHM plulgins allow you to add new functionality to WHM. These documents explain how to create modules and plugins for cPanel & WHM.

cPanel Modules
Added:
>
>
Installing Internal Perl Modules Instructions to install your own internal Perl modules.
 
Writing cPanel Modules Modules are software components that you can add to cPanel to extend cPanel's functionality.
The PHP Accounting Module Learn how to use access keys with cPanel's PHP accounting module.
The cPanel::Accounting Perl Module Learn how to use remote access keys with the cPanel::Accounting Perl module.

Revision 2905 Dec 2011 - Main.JustinSchaefer

Line: 1 to 1
 
META TOPICPARENT name="WebHome"

Standardized Hooks

Line: 35 to 35
 
Authenticating API Function Calls 2 methods you can use to authenticate API function calls.
cPanel Template Toolkit cPanel Template Toolkit is a template-driven parser for API2 calls. This document describes how to use the cPanel Template Toolkit.
Internal API  
Changed:
<
<
Calling API 1 Functions Learn how to call API 1 functions directly using cPanel tags. cPanel tags are supported but will eventually be phased out. If you plan to make your application compatible with all future versions of cPanel & WHM, you should use our LiveAPI system whenever possible.
Calling API 2 Functions This document describes how to call API 2 functions in cPanel tags. cPanel tags are supported but will eventually be phased out. If you plan to make your application compatible with all future versions of cPanel & WHM, you should use our LiveAPI system whenever possible.
Calling API 1 & 2 Functions via XML API You can call API 1 and API 2 functions using our XML API.
>
>
Using API 1 Functions Learn how to call API 1 functions directly using cPanel tags. cPanel tags are supported but will eventually be phased out. If you plan to make your application compatible with all future versions of cPanel & WHM, you should use our LiveAPI system whenever possible.
Using API 2 Functions This document describes how to call API 2 functions in cPanel tags. cPanel tags are supported but will eventually be phased out. If you plan to make your application compatible with all future versions of cPanel & WHM, you should use our LiveAPI system whenever possible.
Using API 1 & 2 Functions via XML API You can call API 1 and API 2 functions using our XML API.
 
API 1 Functions A reference list of API 1 functions and modules.
API 2 Functions A reference list of API 2 functions and modules. When coding for the cPanel interface, the API 2 system can utilize a custom templating system, based on Template Toolkit, to display data returned by the functions. API 2 is much more flexible than API 1, but requires more sophisticated coding. We recommend using API 2 whenever possible.
External API  

Revision 2805 Dec 2011 - Main.JustinSchaefer

Line: 1 to 1
 
META TOPICPARENT name="WebHome"

Standardized Hooks

Line: 35 to 35
 
Authenticating API Function Calls 2 methods you can use to authenticate API function calls.
cPanel Template Toolkit cPanel Template Toolkit is a template-driven parser for API2 calls. This document describes how to use the cPanel Template Toolkit.
Internal API  
Changed:
<
<
Calling API 1 Functions Learn how to call API 1 functions directly.
Calling API 2 Functions How to call API 2 functions directly. When coding for the cPanel interface, the API 2 system can utilize a custom templating system, based on Template Toolkit, to display data returned by the functions. API 2 is much more flexible than API 1, but requires more sophisticated coding. We recommend using API 2 whenever possible.
>
>
Calling API 1 Functions Learn how to call API 1 functions directly using cPanel tags. cPanel tags are supported but will eventually be phased out. If you plan to make your application compatible with all future versions of cPanel & WHM, you should use our LiveAPI system whenever possible.
Calling API 2 Functions This document describes how to call API 2 functions in cPanel tags. cPanel tags are supported but will eventually be phased out. If you plan to make your application compatible with all future versions of cPanel & WHM, you should use our LiveAPI system whenever possible.
 
Calling API 1 & 2 Functions via XML API You can call API 1 and API 2 functions using our XML API.
API 1 Functions A reference list of API 1 functions and modules.
API 2 Functions A reference list of API 2 functions and modules. When coding for the cPanel interface, the API 2 system can utilize a custom templating system, based on Template Toolkit, to display data returned by the functions. API 2 is much more flexible than API 1, but requires more sophisticated coding. We recommend using API 2 whenever possible.
Line: 55 to 55
 
The PHP Accounting Module Learn how to use access keys with cPanel's PHP accounting module.
The cPanel::Accounting Perl Module Learn how to use remote access keys with the cPanel::Accounting Perl module.
Writing cPanel Plugins  
Changed:
<
<
Writing cPanel Plugins cPanel Plugins allow you to integrate third-party applications with cPanel. You can use plugins to add links to your users' cPanel interfaces.
>
>
cPanel Plugins cPanel Plugins allow you to integrate third-party applications with cPanel. You can use plugins to add links to your users' cPanel interfaces.
 
LiveAPI This document covers some basic information about the LiveAPI system. The LiveAPI system is a growing body of work that will make creating software with cPanel & WHM's API and interpreted languages, such as Perl or PHP, much easier.
  • LiveAPI PHP Class — The LiveAPI PHP class is a PHP framework you can use within cPanel. This framework provides PHP scripts with a local socket to the cPanel binary, cpsrvd, allowing your script to make API1 and API2 calls to the local machine via the socket.
cPanel CGI Scripts CGI scripts can be very useful when you need more flexibility than cPanel's other integration methods allow. This document describes where and how to create your CGI script.
Plugin Variables This page documents the variables available within cPanel's HTML logic and DynamicUI files.

Revision 2701 Dec 2011 - Main.JustinSchaefer

Line: 1 to 1
 
META TOPICPARENT name="WebHome"

Standardized Hooks

Line: 24 to 24
 This document describes a cPanel subsystem that can allow you to affect a PHP application served from within cPanel, WHM, or webmail.

Document Description
Changed:
<
<
cPanel AppConfig In cPanel & WHM 11.32, we added the ability to specify two low-level PHP handling attributes when cPanel, WHM, or webmail serves a PHP application.
>
>
AppConfig In cPanel & WHM 11.32, we added the ability to specify two low-level PHP handling attributes when cPanel, WHM, or webmail serves a PHP application.
 

cPanel & WHM's API

Revision 2630 Nov 2011 - Main.JustinSchaefer

Line: 1 to 1
 
META TOPICPARENT name="WebHome"
Deleted:
<
<

Documentation for developers working with cPanel & WHM

This section of our site contains links to to our SDK documentation.

 

Standardized Hooks

For cPanel & WHM 11.32
Line: 20 to 15
 
Basic Usage You can find basic use information for the new system in this document.
Advanced Usage This document covers more advanced features of the Standardized Hooks system.
Insertion Points You can find the list of the Standardized Hooks system's insertion points and learn how to use them here.
Changed:
<
<
Troubleshooting The Standardized Hooks system contains a wealth of robust troubleshooting features. You can learn about them here.
>
>
Troubleshooting The Standardized Hooks system contains a wealth of robust troubleshooting features. You can learn about them here.

AppConfig

For cPanel & WHM 11.32

This document describes a cPanel subsystem that can allow you to affect a PHP application served from within cPanel, WHM, or webmail.

Document Description
cPanel AppConfig In cPanel & WHM 11.32, we added the ability to specify two low-level PHP handling attributes when cPanel, WHM, or webmail serves a PHP application.
 

cPanel & WHM's API

Line: 52 to 56
 
The cPanel::Accounting Perl Module Learn how to use remote access keys with the cPanel::Accounting Perl module.
Writing cPanel Plugins  
Writing cPanel Plugins cPanel Plugins allow you to integrate third-party applications with cPanel. You can use plugins to add links to your users' cPanel interfaces.
Changed:
<
<
Using PHP in a cPanel Plugin's Interface cPanel allows for additional pages to be written in PHP rather than straight HTML. This document describes using PHP to generate a cPanel plugin's interface.
>
>
LiveAPI This document covers some basic information about the LiveAPI system. The LiveAPI system is a growing body of work that will make creating software with cPanel & WHM's API and interpreted languages, such as Perl or PHP, much easier.
  • LiveAPI PHP Class — The LiveAPI PHP class is a PHP framework you can use within cPanel. This framework provides PHP scripts with a local socket to the cPanel binary, cpsrvd, allowing your script to make API1 and API2 calls to the local machine via the socket.
 
cPanel CGI Scripts CGI scripts can be very useful when you need more flexibility than cPanel's other integration methods allow. This document describes where and how to create your CGI script.
Deleted:
<
<
Live API This document covers some basic information about the LiveAPI system. The LiveAPI system is a growing body of work that will make creating software with cPanel & WHM's API and interpreted languages, such as Perl or PHP, much easier.
Using Live PHP in a cPanel Plugin LivePHP is a PHP framework you can use within cPanel. This framework provides PHP scripts with a local socket to the cPanel binary, cpsrvd, allowing your script to make API1 and API2 calls to the local machine via the socket.
 
Plugin Variables This page documents the variables available within cPanel's HTML logic and DynamicUI files.
DynamicUI Reference Charts You can use these charts as a reference guide whenever adding items to your cPanel interface.
Installing cPanel Plugins cPanel plugins must be installed and used in a specific way. You can learn about installing cPanel plugins here.
Adding Icons and Groups Learn about adding icons and groups to the cPanel interface.
Plugin Installation File Generator You will need to generate an installation file for your plugins.
Plugin Security Policy You can read cPanel's plugin security policy here.
Added:
>
>
Using PHP in a cPanel Plugin's Interface For cPanel & WHM 11.30 and older versions of cPanel & WHM — We have refactored this system so that it applies to an expanding list of scripting languages. You should review our LiveAPI documentation for the most recent information. cPanel allows for additional pages to be written in PHP rather than straight HTML. This document describes using PHP to generate a cPanel plugin's interface.
 
WHM Plugins  
Creating WHM Plugins You can create WHM plugins that extend WHM's functionality.
ACL Reference Table You can find our access control reference table here.
Line: 71 to 74
 
EasyApache Modules  
Custom Modules? You can add features to EasyApache by developing custom modules.
Deleted:
<
<

cPanel Hooks

These documents explain how to hook into cPanel's functionality. You can run hooks before and after API calls. This will allow you to automate recurring tasks on a cPanel & WHM server.

cPanel Hooks
Introduction This document will get you started on the various methods of hooking into cPanel's functionality.
Writing Function Hooks Function hooks allow you to automatically perform actions after an API 1 or API 2 function is executed. These scripts are placed in /usr/local/cpanel/hooks and receive XML via STDIN from parent cPanel processes.
Script Hooks cPanel & WHM script hooks allow for custom code to be executed for certain system-level operations such as account modifications, installation of server software, and backup runs.
Custom Event Handlers A custom event handler is a powerful tool that allows you to access operations triggered by the cPanel interface. You can create custom event handlers as pre and post event handlers—meaning that the action is taken before or after an API function executes.
The cPanel Logger Module You can use the Cpanel::Logger module to raise error messages in a custom event handler.
Universal Password Trap As a cPanel account password can be changed in a number of places, including both cPanel and WHM, we've created a universal hook that fires anytime an account password is changed.
Hooking into EasyApache  
EasyApache Hooks? Using EasyApache, you can automatically perform actions before or after rebuilding Apache.
 

cPAddons (Site Software)

cPAddons allow you to add functionality to the cPanel interface.

Line: 110 to 98
 
TailWatch TailWatch is a process that handles the tasks previously handled by three separate processes: eximstats, antirelayd, and cpbandwd.
Integrating Custom Webmail Applications You can add your favorite custom webmail applications to cPanel.
Troubleshooting Perl Here are some basic troubleshooting methods you can use when you encounter problems using Perl.
Added:
>
>

cPanel Hooks

For cPanel & WHM 11.30 and older versions of cPanel & WHM

As of cPanel & WHM 11.32, we have refactored this system so that it applies sanity checks to your software. You should review our Standardized Hooks documentation for the most recent information.

These documents explain how to hook into cPanel's functionality. You can run hooks before and after API calls. This will allow you to automate recurring tasks on a cPanel & WHM server.

cPanel Hooks
Introduction This document will get you started on the various methods of hooking into cPanel's functionality.
Writing Function Hooks Function hooks allow you to automatically perform actions after an API 1 or API 2 function is executed. These scripts are placed in /usr/local/cpanel/hooks and receive XML via STDIN from parent cPanel processes.
Script Hooks cPanel & WHM script hooks allow for custom code to be executed for certain system-level operations such as account modifications, installation of server software, and backup runs.
Custom Event Handlers A custom event handler is a powerful tool that allows you to access operations triggered by the cPanel interface. You can create custom event handlers as pre and post event handlers—meaning that the action is taken before or after an API function executes.
The cPanel Logger Module You can use the Cpanel::Logger module to raise error messages in a custom event handler.
Universal Password Trap As a cPanel account password can be changed in a number of places, including both cPanel and WHM, we've created a universal hook that fires anytime an account password is changed.
Hooking into EasyApache  
EasyApache Hooks? Using EasyApache, you can automatically perform actions before or after rebuilding Apache.
 

Developer Software

Revision 2501 Nov 2011 - Main.JustinSchaefer

Line: 1 to 1
 
META TOPICPARENT name="WebHome"

Documentation for developers working with cPanel & WHM

This section of our site contains links to to our SDK documentation.

Deleted:
<
<

cPanel & WHM's API

 
Added:
>
>

Standardized Hooks

For cPanel & WHM 11.32

The Standardized Hooks system adds sanity checks to your custom module and function hooks.

This system also offers a series of insertion points you can use to perform tasks on your cPanel & WHM server.

This system is only available in cPanel & WHM versions 11.32 and later.

Document Description
Abstract This document is a high-level description of the Standardized Hooks system.
Basic Usage You can find basic use information for the new system in this document.
Advanced Usage This document covers more advanced features of the Standardized Hooks system.
Insertion Points You can find the list of the Standardized Hooks system's insertion points and learn how to use them here.
Troubleshooting The Standardized Hooks system contains a wealth of robust troubleshooting features. You can learn about them here.

cPanel & WHM's API

 Our API allows you to access cPanel & WHM functionality from your own integrated or external applications. These documents describe how to use our API functions.

Basics

Revision 2420 Oct 2011 - Main.JustinSchaefer

Line: 1 to 1
 
META TOPICPARENT name="WebHome"

Documentation for developers working with cPanel & WHM

Line: 99 to 99
 This section contains all of our developer software. This software includes packages and libraries, utilities, API clients, and code examples.

Packages and Libraries
Deleted:
<
<
cPanel's PHP Library Coming Soon! The cPanel PHP library is a collection of decoupled PHP classes that you can use to build utilities and applications. This system will make it easy for you to create custom software in PHP that interfaces with our product. Documentation for this library is nearly complete and will be online in a matter of days!
Thank you for patience,
cPanel's Integration Team
 
API Clients  
PHP XML-API class This download provides a PHP class designed for easy automation of the XML API from within PHP scripts.
PublicAPI in PHP PublicAPI is a set of language-agnostic methods for interacting with cPanel systems. The PublicAPI PHP client class is a PHP implementation of our PublicAPI system. The client supports all of the methods used by the Public API interface, in addition to most of the methods available in our previous PHP client classes, such as the XML-API client class.

Revision 2319 Oct 2011 - MelanieSeibert

Line: 1 to 1
 
META TOPICPARENT name="WebHome"

Documentation for developers working with cPanel & WHM

Line: 90 to 90
 Advanced system administrators may find the following information useful.

Advanced System Administration
Changed:
<
<
More about TailWatch TailWatch is a process that handles the tasks previously handled by three separate processes: eximstats, antirelayd, and cpbandwd.
>
>
TailWatch TailWatch is a process that handles the tasks previously handled by three separate processes: eximstats, antirelayd, and cpbandwd.
 
Integrating Custom Webmail Applications You can add your favorite custom webmail applications to cPanel.
Troubleshooting Perl Here are some basic troubleshooting methods you can use when you encounter problems using Perl.

Revision 2205 Oct 2011 - Main.JustinSchaefer

Line: 1 to 1
 
META TOPICPARENT name="WebHome"

Documentation for developers working with cPanel & WHM

Line: 37 to 37
 
Writing cPanel Plugins cPanel Plugins allow you to integrate third-party applications with cPanel. You can use plugins to add links to your users' cPanel interfaces.
Using PHP in a cPanel Plugin's Interface cPanel allows for additional pages to be written in PHP rather than straight HTML. This document describes using PHP to generate a cPanel plugin's interface.
cPanel CGI Scripts CGI scripts can be very useful when you need more flexibility than cPanel's other integration methods allow. This document describes where and how to create your CGI script.
Added:
>
>
Live API This document covers some basic information about the LiveAPI system. The LiveAPI system is a growing body of work that will make creating software with cPanel & WHM's API and interpreted languages, such as Perl or PHP, much easier.
 
Using Live PHP in a cPanel Plugin LivePHP is a PHP framework you can use within cPanel. This framework provides PHP scripts with a local socket to the cPanel binary, cpsrvd, allowing your script to make API1 and API2 calls to the local machine via the socket.
Plugin Variables This page documents the variables available within cPanel's HTML logic and DynamicUI files.
DynamicUI Reference Charts You can use these charts as a reference guide whenever adding items to your cPanel interface.

Revision 2123 Aug 2011 - Main.JustinSchaefer

Line: 1 to 1
 
META TOPICPARENT name="WebHome"

Documentation for developers working with cPanel & WHM

Line: 49 to 49
 
ACL Reference Table You can find our access control reference table here.
The swapip Utility Though it does not reside in the /scripts directory, this tool allows you to update the IP address in a DNS zone record.
The cPanel Logger Module The Cpanel::Logger module can be used to raise error messages in a custom event handler. This module provides a common interface for logging to files, such as cPanel's error_log.
Added:
>
>
Pluggable dnsadmin Modules You can create pluggable dnsadmin modules that automate tasks in your DNS cluster. This set of documents describes how to create these modules.
 
EasyApache Modules  
Custom Modules? You can add features to EasyApache by developing custom modules.

Revision 2017 Aug 2011 - Main.JustinSchaefer

Line: 1 to 1
 
META TOPICPARENT name="WebHome"

Documentation for developers working with cPanel & WHM

Revision 1925 Apr 2011 - Main.JustinSchaefer

Line: 1 to 1
 
META TOPICPARENT name="WebHome"

Documentation for developers working with cPanel & WHM

Line: 104 to 104
 
PublicAPI in Perl PublicAPI is a set of language-agnostic methods for interacting with cPanel systems. The PublicAPI Perl client class is a Perl implementation of our PublicAPI system.
Developer Utilities  
API Tracer This CustomEventHandler allows you to trace API calls made in cPanel along with their input and output data.
PICK Important: This should only be run on development servers.
Deleted:
<
<

Revision 1820 Apr 2011 - Main.JustinSchaefer

Line: 1 to 1
 
META TOPICPARENT name="WebHome"

Documentation for developers working with cPanel & WHM

Line: 104 to 104
 
PublicAPI in Perl PublicAPI is a set of language-agnostic methods for interacting with cPanel systems. The PublicAPI Perl client class is a Perl implementation of our PublicAPI system.
Developer Utilities  
API Tracer This CustomEventHandler allows you to trace API calls made in cPanel along with their input and output data.
PICK Important: This should only be run on development servers.
Deleted:
<
<
Examples  
Frontend Customization This file contains an example of how to build an email account creation page.
Backend Customization This download contains a description of how to create a CustomEventHandler that implements email blacklisting, including proper error returning from within the CustomEventHandler system.
  \ No newline at end of file

Revision 1708 Apr 2011 - Main.JustinSchaefer

Line: 1 to 1
 
META TOPICPARENT name="WebHome"

Documentation for developers working with cPanel & WHM

Line: 93 to 93
 
Troubleshooting Perl Here are some basic troubleshooting methods you can use when you encounter problems using Perl.

Developer Software

Changed:
<
<
>
>
 This section contains all of our developer software. This software includes packages and libraries, utilities, API clients, and code examples.

Packages and Libraries

Revision 1607 Apr 2011 - Main.JustinSchaefer

Line: 1 to 1
 
META TOPICPARENT name="WebHome"

Documentation for developers working with cPanel & WHM

Line: 91 to 91
 
More about TailWatch TailWatch is a process that handles the tasks previously handled by three separate processes: eximstats, antirelayd, and cpbandwd.
Integrating Custom Webmail Applications You can add your favorite custom webmail applications to cPanel.
Troubleshooting Perl Here are some basic troubleshooting methods you can use when you encounter problems using Perl.
Deleted:
<
<

Downloads

 
Changed:
<
<
Downloads Access code examples and other useful downloads.
>
>

Developer Software

This section contains all of our developer software. This software includes packages and libraries, utilities, API clients, and code examples.

Packages and Libraries
cPanel's PHP Library Coming Soon! The cPanel PHP library is a collection of decoupled PHP classes that you can use to build utilities and applications. This system will make it easy for you to create custom software in PHP that interfaces with our product. Documentation for this library is nearly complete and will be online in a matter of days!
Thank you for patience,
cPanel's Integration Team
API Clients  
PHP XML-API class This download provides a PHP class designed for easy automation of the XML API from within PHP scripts.
PublicAPI in PHP PublicAPI is a set of language-agnostic methods for interacting with cPanel systems. The PublicAPI PHP client class is a PHP implementation of our PublicAPI system. The client supports all of the methods used by the Public API interface, in addition to most of the methods available in our previous PHP client classes, such as the XML-API client class.
PublicAPI in Perl PublicAPI is a set of language-agnostic methods for interacting with cPanel systems. The PublicAPI Perl client class is a Perl implementation of our PublicAPI system.
Developer Utilities  
API Tracer This CustomEventHandler allows you to trace API calls made in cPanel along with their input and output data.
PICK Important: This should only be run on development servers.
Examples  
Frontend Customization This file contains an example of how to build an email account creation page.
Backend Customization This download contains a description of how to create a CustomEventHandler that implements email blacklisting, including proper error returning from within the CustomEventHandler system.
 

Revision 1522 Mar 2011 - Main.JustinSchaefer

Line: 1 to 1
 
META TOPICPARENT name="WebHome"

Documentation for developers working with cPanel & WHM

Line: 10 to 10
 Our API allows you to access cPanel & WHM functionality from your own integrated or external applications. These documents describe how to use our API functions.

Basics
Changed:
<
<
Introduction Basic information about our application programming interface (API).
Authenticating API Function Calls 2 methods you can use to authenticate API function calls.
cPanel Template Toolkit cPanel Template Toolkit is a template-driven parser for API2 calls. This document describes how to use the cPanel Template Toolkit.
>
>
Introduction Basic information about our application programming interface (API).
Authenticating API Function Calls 2 methods you can use to authenticate API function calls.
cPanel Template Toolkit cPanel Template Toolkit is a template-driven parser for API2 calls. This document describes how to use the cPanel Template Toolkit.
 
Internal API  
Changed:
<
<
Calling API 1 Functions Learn how to call API 1 functions directly.
Calling API 2 Functions How to call API 2 functions directly. When coding for the cPanel interface, the API 2 system can utilize a custom templating system, based on Template Toolkit, to display data returned by the functions. API 2 is much more flexible than API 1, but requires more sophisticated coding. We recommend using API 2 whenever possible.
Calling API 1 & 2 Functions via XML API You can call API 1 and API 2 functions using our XML API.
>
>
Calling API 1 Functions Learn how to call API 1 functions directly.
Calling API 2 Functions How to call API 2 functions directly. When coding for the cPanel interface, the API 2 system can utilize a custom templating system, based on Template Toolkit, to display data returned by the functions. API 2 is much more flexible than API 1, but requires more sophisticated coding. We recommend using API 2 whenever possible.
Calling API 1 & 2 Functions via XML API You can call API 1 and API 2 functions using our XML API.
 
API 1 Functions A reference list of API 1 functions and modules.
API 2 Functions A reference list of API 2 functions and modules. When coding for the cPanel interface, the API 2 system can utilize a custom templating system, based on Template Toolkit, to display data returned by the functions. API 2 is much more flexible than API 1, but requires more sophisticated coding. We recommend using API 2 whenever possible.
External API  
Changed:
<
<
XML and JSON API Our XML and JSON APIs allow you to interact with WHM.
Parsing XML Data Learn how to parse XML output.
>
>
XML and JSON API Our XML and JSON APIs allow you to interact with WHM.
Parsing XML Data Learn how to parse XML output.
 
Manage 2 API Our Manage 2 API allows you to manage your licenses.
Changed:
<
<
API Privilege Escalation You can temporarily escalate a user's privileges while using API calls.
>
>
API Privilege Escalation You can temporarily escalate a user's privileges while using API calls.
 

Modules and Plugins

You can create cPanel modules and plugins to extend cPanel's functionality. WHM plulgins allow you to add new functionality to WHM. These documents explain how to create modules and plugins for cPanel & WHM.

cPanel Modules
Changed:
<
<
Writing cPanel Modules Modules are software components that you can add to cPanel to extend cPanel's functionality.
The PHP Accounting Module Learn how to use access keys with cPanel's PHP accounting module.
The cPanel::Accounting Perl Module Learn how to use remote access keys with the cPanel::Accounting Perl module.
>
>
Writing cPanel Modules Modules are software components that you can add to cPanel to extend cPanel's functionality.
The PHP Accounting Module Learn how to use access keys with cPanel's PHP accounting module.
The cPanel::Accounting Perl Module Learn how to use remote access keys with the cPanel::Accounting Perl module.
 
Writing cPanel Plugins  
Changed:
<
<
Writing cPanel Plugins cPanel Plugins allow you to integrate third-party applications with cPanel. You can use plugins to add links to your users' cPanel interfaces.
Using PHP in a cPanel Plugin's Interface cPanel allows for additional pages to be written in PHP rather than straight HTML. This document describes using PHP to generate a cPanel plugin's interface.
cPanel CGI Scripts CGI scripts can be very useful when you need more flexibility than cPanel's other integration methods allow. This document describes where and how to create your CGI script.
Using Live PHP in a cPanel Plugin LivePHP is a PHP framework you can use within cPanel. This framework provides PHP scripts with a local socket to the cPanel binary, cpsrvd, allowing your script to make API1 and API2 calls to the local machine via the socket.
Plugin Variables This page documents the variables available within cPanel's HTML logic and DynamicUI files.
DynamicUI Reference Charts You can use these charts as a reference guide whenever adding items to your cPanel interface.
Installing cPanel Plugins cPanel plugins must be installed and used in a specific way. You can learn about installing cPanel plugins here.
Adding Icons and Groups Learn about adding icons and groups to the cPanel interface.
>
>
Writing cPanel Plugins cPanel Plugins allow you to integrate third-party applications with cPanel. You can use plugins to add links to your users' cPanel interfaces.
Using PHP in a cPanel Plugin's Interface cPanel allows for additional pages to be written in PHP rather than straight HTML. This document describes using PHP to generate a cPanel plugin's interface.
cPanel CGI Scripts CGI scripts can be very useful when you need more flexibility than cPanel's other integration methods allow. This document describes where and how to create your CGI script.
Using Live PHP in a cPanel Plugin LivePHP is a PHP framework you can use within cPanel. This framework provides PHP scripts with a local socket to the cPanel binary, cpsrvd, allowing your script to make API1 and API2 calls to the local machine via the socket.
Plugin Variables This page documents the variables available within cPanel's HTML logic and DynamicUI files.
DynamicUI Reference Charts You can use these charts as a reference guide whenever adding items to your cPanel interface.
Installing cPanel Plugins cPanel plugins must be installed and used in a specific way. You can learn about installing cPanel plugins here.
Adding Icons and Groups Learn about adding icons and groups to the cPanel interface.
 
Plugin Installation File Generator You will need to generate an installation file for your plugins.
Plugin Security Policy You can read cPanel's plugin security policy here.
WHM Plugins  
Changed:
<
<
Creating WHM Plugins You can create WHM plugins that extend WHM's functionality.
ACL Reference Table You can find our access control reference table here.
The swapip Utility Though it does not reside in the /scripts directory, this tool allows you to update the IP address in a DNS zone record.
The cPanel Logger Module The Cpanel::Logger module can be used to raise error messages in a custom event handler. This module provides a common interface for logging to files, such as cPanel's error_log.
>
>
Creating WHM Plugins You can create WHM plugins that extend WHM's functionality.
ACL Reference Table You can find our access control reference table here.
The swapip Utility Though it does not reside in the /scripts directory, this tool allows you to update the IP address in a DNS zone record.
The cPanel Logger Module The Cpanel::Logger module can be used to raise error messages in a custom event handler. This module provides a common interface for logging to files, such as cPanel's error_log.
 
EasyApache Modules  
Custom Modules? You can add features to EasyApache by developing custom modules.
Line: 58 to 58
 These documents explain how to hook into cPanel's functionality. You can run hooks before and after API calls. This will allow you to automate recurring tasks on a cPanel & WHM server.

cPanel Hooks
Changed:
<
<
Introduction This document will get you started on the various methods of hooking into cPanel's functionality.
Writing Function Hooks Function hooks allow you to automatically perform actions after an API 1 or API 2 function is executed. These scripts are placed in /usr/local/cpanel/hooks and receive XML via STDIN from parent cPanel processes.
Script Hooks cPanel & WHM script hooks allow for custom code to be executed for certain system-level operations such as account modifications, installation of server software, and backup runs.
Custom Event Handlers A custom event handler is a powerful tool that allows you to access operations triggered by the cPanel interface. You can create custom event handlers as pre and post event handlers—meaning that the action is taken before or after an API function executes.
The cPanel Logger Module You can use the Cpanel::Logger module to raise error messages in a custom event handler.
>
>
Introduction This document will get you started on the various methods of hooking into cPanel's functionality.
Writing Function Hooks Function hooks allow you to automatically perform actions after an API 1 or API 2 function is executed. These scripts are placed in /usr/local/cpanel/hooks and receive XML via STDIN from parent cPanel processes.
Script Hooks cPanel & WHM script hooks allow for custom code to be executed for certain system-level operations such as account modifications, installation of server software, and backup runs.
Custom Event Handlers A custom event handler is a powerful tool that allows you to access operations triggered by the cPanel interface. You can create custom event handlers as pre and post event handlers—meaning that the action is taken before or after an API function executes.
The cPanel Logger Module You can use the Cpanel::Logger module to raise error messages in a custom event handler.
 
Universal Password Trap As a cPanel account password can be changed in a number of places, including both cPanel and WHM, we've created a universal hook that fires anytime an account password is changed.
Hooking into EasyApache  
EasyApache Hooks? Using EasyApache, you can automatically perform actions before or after rebuilding Apache.
Line: 72 to 72
 cPAddons allow you to add functionality to the cPanel interface.

cPAddons
Changed:
<
<
Introduction If you're new to cPAddons, this document will introduce you to some basic concepts.
Creating cPAddons Step-by-step instructions for creating a cPAddon.
Creating cPAddon Upgrades cPAddon upgrades are new versions of a cPAddon script. This document offers step-by-step instructions for creating an upgrade.
Using Hash References with cPAddons A reference of hash keys accepted by the cPAddon's installation configuration files.
Using Custom Installation Fields with cPAddons Add custom installation fields to a cPAddon's installation configuration files.
Configuration File Variables Learn how to set and manage configuration file variables.
Creating Invisible cPAddon Scripts If you create a cPAddon that is associated with another cPAddon, or should not appear to all users, you can create an invisible cPAddon script.
cPAddon Aliases If a cPAddon should fit into more than one category, you can create an alias.
Licensing cPAddons Learn about using commercial licenses with your cPAddons.
Distributing cPAddons Learn how to distribute your cPAddons through the WHM interface.
>
>
Introduction If you're new to cPAddons, this document will introduce you to some basic concepts.
Creating cPAddons Step-by-step instructions for creating a cPAddon.
Creating cPAddon Upgrades cPAddon upgrades are new versions of a cPAddon script. This document offers step-by-step instructions for creating an upgrade.
Using Hash References with cPAddons A reference of hash keys accepted by the cPAddon's installation configuration files.
Using Custom Installation Fields with cPAddons Add custom installation fields to a cPAddon's installation configuration files.
Configuration File Variables Learn how to set and manage configuration file variables.
Creating Invisible cPAddon Scripts If you create a cPAddon that is associated with another cPAddon, or should not appear to all users, you can create an invisible cPAddon script.
cPAddon Aliases If a cPAddon should fit into more than one category, you can create an alias.
Licensing cPAddons Learn about using commercial licenses with your cPAddons.
Distributing cPAddons Learn how to distribute your cPAddons through the WHM interface.
 

Advanced System Administration

Advanced system administrators may find the following information useful.

Advanced System Administration
Changed:
<
<
More about TailWatch TailWatch is a process that handles the tasks previously handled by three separate processes: eximstats, antirelayd, and cpbandwd.
Integrating Custom Webmail Applications You can add your favorite custom webmail applications to cPanel.
>
>
More about TailWatch TailWatch is a process that handles the tasks previously handled by three separate processes: eximstats, antirelayd, and cpbandwd.
Integrating Custom Webmail Applications You can add your favorite custom webmail applications to cPanel.
Troubleshooting Perl Here are some basic troubleshooting methods you can use when you encounter problems using Perl.
 

Downloads

Changed:
<
<
Downloads Access code examples and other useful downloads.
>
>
Downloads Access code examples and other useful downloads.
 

Revision 1417 Mar 2011 - Main.JustinSchaefer

Line: 1 to 1
 
META TOPICPARENT name="WebHome"

Documentation for developers working with cPanel & WHM

Line: 90 to 90
 
Advanced System Administration
More about TailWatch TailWatch is a process that handles the tasks previously handled by three separate processes: eximstats, antirelayd, and cpbandwd.
Integrating Custom Webmail Applications You can add your favorite custom webmail applications to cPanel.
Added:
>
>

Downloads

 
Downloads Access code examples and other useful downloads.

Revision 1315 Mar 2011 - Main.JustinSchaefer

Line: 1 to 1
 
META TOPICPARENT name="WebHome"

Documentation for developers working with cPanel & WHM

Line: 39 to 39
 
cPanel CGI Scripts CGI scripts can be very useful when you need more flexibility than cPanel's other integration methods allow. This document describes where and how to create your CGI script.
Using Live PHP in a cPanel Plugin LivePHP is a PHP framework you can use within cPanel. This framework provides PHP scripts with a local socket to the cPanel binary, cpsrvd, allowing your script to make API1 and API2 calls to the local machine via the socket.
Plugin Variables This page documents the variables available within cPanel's HTML logic and DynamicUI files.
Added:
>
>
DynamicUI Reference Charts You can use these charts as a reference guide whenever adding items to your cPanel interface.
 
Installing cPanel Plugins cPanel plugins must be installed and used in a specific way. You can learn about installing cPanel plugins here.
Adding Icons and Groups Learn about adding icons and groups to the cPanel interface.
Plugin Installation File Generator You will need to generate an installation file for your plugins.

Revision 1212 Mar 2011 - Main.JustinSchaefer

Line: 1 to 1
 
META TOPICPARENT name="WebHome"

Documentation for developers working with cPanel & WHM

Line: 48 to 48
 
ACL Reference Table You can find our access control reference table here.
The swapip Utility Though it does not reside in the /scripts directory, this tool allows you to update the IP address in a DNS zone record.
The cPanel Logger Module The Cpanel::Logger module can be used to raise error messages in a custom event handler. This module provides a common interface for logging to files, such as cPanel's error_log.
Added:
>
>
EasyApache Modules  
Custom Modules? You can add features to EasyApache by developing custom modules.
 

cPanel Hooks

Line: 60 to 62
 
Script Hooks cPanel & WHM script hooks allow for custom code to be executed for certain system-level operations such as account modifications, installation of server software, and backup runs.
Custom Event Handlers A custom event handler is a powerful tool that allows you to access operations triggered by the cPanel interface. You can create custom event handlers as pre and post event handlers—meaning that the action is taken before or after an API function executes.
The cPanel Logger Module You can use the Cpanel::Logger module to raise error messages in a custom event handler.
Added:
>
>
Universal Password Trap As a cPanel account password can be changed in a number of places, including both cPanel and WHM, we've created a universal hook that fires anytime an account password is changed.
 
Hooking into EasyApache  
EasyApache Hooks? Using EasyApache, you can automatically perform actions before or after rebuilding Apache.

Revision 1109 Mar 2011 - MelanieSeibert

Line: 1 to 1
 
META TOPICPARENT name="WebHome"
Changed:
<
<

Resources

>
>

Documentation for developers working with cPanel & WHM

  This section of our site contains links to to our SDK documentation.

Changed:
<
<

cPanel & WHM's API

>
>

cPanel & WHM's API

  Our API allows you to access cPanel & WHM functionality from your own integrated or external applications. These documents describe how to use our API functions.
Line: 25 to 25
 
Manage 2 API Our Manage 2 API allows you to manage your licenses.
API Privilege Escalation You can temporarily escalate a user's privileges while using API calls.
Changed:
<
<

Modules and Plugins

>
>

Modules and Plugins

  You can create cPanel modules and plugins to extend cPanel's functionality. WHM plulgins allow you to add new functionality to WHM. These documents explain how to create modules and plugins for cPanel & WHM.

Line: 50 to 50
 
The cPanel Logger Module The Cpanel::Logger module can be used to raise error messages in a custom event handler. This module provides a common interface for logging to files, such as cPanel's error_log.

Changed:
<
<

cPanel Hooks

>
>

cPanel Hooks

  These documents explain how to hook into cPanel's functionality. You can run hooks before and after API calls. This will allow you to automate recurring tasks on a cPanel & WHM server.
Line: 63 to 63
 
Hooking into EasyApache  
EasyApache Hooks? Using EasyApache, you can automatically perform actions before or after rebuilding Apache.
Changed:
<
<

cPAddons (Site Software)

>
>

cPAddons (Site Software)

  cPAddons allow you to add functionality to the cPanel interface.
Line: 79 to 79
 
Licensing cPAddons Learn about using commercial licenses with your cPAddons.
Distributing cPAddons Learn how to distribute your cPAddons through the WHM interface.
Changed:
<
<

Advanced System Administration

>
>

Advanced System Administration

  Advanced system administrators may find the following information useful.

Revision 1008 Mar 2011 - MelanieSeibert

Line: 1 to 1
 
META TOPICPARENT name="WebHome"
Changed:
<
<

Resources

>
>

Resources

  This section of our site contains links to to our SDK documentation.
Deleted:
<
<
 
Changed:
<
<

cPanel & WHM's API

>
>

cPanel & WHM's API

  Our API allows you to access cPanel & WHM functionality from your own integrated or external applications. These documents describe how to use our API functions.
Line: 27 to 25
 
Manage 2 API Our Manage 2 API allows you to manage your licenses.
API Privilege Escalation You can temporarily escalate a user's privileges while using API calls.
Changed:
<
<

Modules and Plugins

>
>

Modules and Plugins

  You can create cPanel modules and plugins to extend cPanel's functionality. WHM plulgins allow you to add new functionality to WHM. These documents explain how to create modules and plugins for cPanel & WHM.

Line: 52 to 50
 
The cPanel Logger Module The Cpanel::Logger module can be used to raise error messages in a custom event handler. This module provides a common interface for logging to files, such as cPanel's error_log.

Changed:
<
<

cPanel Hooks

>
>

cPanel Hooks

  These documents explain how to hook into cPanel's functionality. You can run hooks before and after API calls. This will allow you to automate recurring tasks on a cPanel & WHM server.
Line: 65 to 63
 
Hooking into EasyApache  
EasyApache Hooks? Using EasyApache, you can automatically perform actions before or after rebuilding Apache.
Changed:
<
<

cPAddons (Site Software)

>
>

cPAddons (Site Software)

  cPAddons allow you to add functionality to the cPanel interface.
Line: 81 to 79
 
Licensing cPAddons Learn about using commercial licenses with your cPAddons.
Distributing cPAddons Learn how to distribute your cPAddons through the WHM interface.
Changed:
<
<

Advanced System Administration

>
>

Advanced System Administration

 
Changed:
<
<
If you still have not found what you are looking for, you might find it in one of the documents below.
>
>
Advanced system administrators may find the following information useful.
 
Advanced System Administration
More about TailWatch TailWatch is a process that handles the tasks previously handled by three separate processes: eximstats, antirelayd, and cpbandwd.

Revision 908 Mar 2011 - MelanieSeibert

Line: 1 to 1
 
META TOPICPARENT name="WebHome"

Resources

Line: 71 to 71
 
cPAddons
Introduction If you're new to cPAddons, this document will introduce you to some basic concepts.
Changed:
<
<
Creating cPAddons Here, you can find step by step instructions for creating a cPAddon.
Creating cPAddon Upgrades cPAddon upgrades are new versions of a cPAddon script. This document details step by step instructions for creating an upgrade.
Using Hash References with cPAddons You can access a reference of hash keys accepted by the cPAddon's installation configuration files here.
Using Custom Installation Fields with cPAddons You can add custom installation fields for a cPAddon's installation configuration files.
Configuration File Variables Here, you can learn how to set and manage configuration file variables.
Creating Invisible cPAddon Scripts If you create a cPAddon that is in some way associated with another cPAddon, or should otherwise not appear to all users, you can create an invisible cPAddon script. This document describes how to create an invisible cPAddon script.
cPAddon Aliases If a cPAddon should fit into more than one category, you can create an alias. This document describes how to create an alias for a cPAddon script.
Licensing cPAddons Here, you can learn about using commercial licenses with your cPAddons.
Distributing cPAddons You can learn how to distribute your cPAddons through the WHM interface here.
>
>
Creating cPAddons Step-by-step instructions for creating a cPAddon.
Creating cPAddon Upgrades cPAddon upgrades are new versions of a cPAddon script. This document offers step-by-step instructions for creating an upgrade.
Using Hash References with cPAddons A reference of hash keys accepted by the cPAddon's installation configuration files.
Using Custom Installation Fields with cPAddons Add custom installation fields to a cPAddon's installation configuration files.
Configuration File Variables Learn how to set and manage configuration file variables.
Creating Invisible cPAddon Scripts If you create a cPAddon that is associated with another cPAddon, or should not appear to all users, you can create an invisible cPAddon script.
cPAddon Aliases If a cPAddon should fit into more than one category, you can create an alias.
Licensing cPAddons Learn about using commercial licenses with your cPAddons.
Distributing cPAddons Learn how to distribute your cPAddons through the WHM interface.
 

Advanced System Administration

Changed:
<
<
If you still have not found what you are looking for, you might find it in one of the miscellaneous documents below.
>
>
If you still have not found what you are looking for, you might find it in one of the documents below.
 
Advanced System Administration
More about TailWatch TailWatch is a process that handles the tasks previously handled by three separate processes: eximstats, antirelayd, and cpbandwd.
Integrating Custom Webmail Applications You can add your favorite custom webmail applications to cPanel.
Changed:
<
<
Downloads You can find code examples and other downloadable files here.
>
>
Downloads Access code examples and other useful downloads.
 

Revision 808 Mar 2011 - MelanieSeibert

Line: 1 to 1
 
META TOPICPARENT name="WebHome"

Resources

Changed:
<
<
This section of our site contains links to to our SDK's documentation. To access a document, simply click the corresponding link.
>
>
This section of our site contains links to to our SDK documentation.
 
Added:
>
>
 

cPanel & WHM's API

Changed:
<
<
These documents describe how to use our API functions. Our API allows you to access cPanel & WHM functionality from your own integrated or external applications.
>
>
Our API allows you to access cPanel & WHM functionality from your own integrated or external applications. These documents describe how to use our API functions.
 
Basics
Changed:
<
<
Introduction You can find basic information about our application programming interface (API) here.
Authenticating API Function Calls We have 2 methods you can use to authenticate API function calls.
>
>
Introduction Basic information about our application programming interface (API).
Authenticating API Function Calls 2 methods you can use to authenticate API function calls.
 
cPanel Template Toolkit cPanel Template Toolkit is a template-driven parser for API2 calls. This document describes how to use the cPanel Template Toolkit.
Internal API  
Changed:
<
<
Calling API 1 Functions You can learn how to call API 1 functions directly from this document.
Calling API 2 Functions Here, we describe how to call API 2 functions directly. When coding for the cPanel interface, the API 2 system can utilize a custom templating system, based on Template ToolKit, to display data returned by the functions. API 2 is much more flexible than API 1, but requires more sophisticated coding. We recommend using API 2 over API 1 whenever possible.
>
>
Calling API 1 Functions Learn how to call API 1 functions directly.
Calling API 2 Functions How to call API 2 functions directly. When coding for the cPanel interface, the API 2 system can utilize a custom templating system, based on Template Toolkit, to display data returned by the functions. API 2 is much more flexible than API 1, but requires more sophisticated coding. We recommend using API 2 whenever possible.
 
Calling API 1 & 2 Functions via XML API You can call API 1 and API 2 functions using our XML API.
Changed:
<
<
API 1 Functions This is a reference list of API 1 functions and modules.
API 2 Functions This is a reference list of API 2 functions and modules. When coding for the cPanel interface, the API 2 system can utilize a custom templating system, based on Template ToolKit, to display data returned by the functions. API 2 is much more flexible than API 1, but requires more sophisticated coding. We recommend using API 2 over API 1 whenever possible.
>
>
API 1 Functions A reference list of API 1 functions and modules.
API 2 Functions A reference list of API 2 functions and modules. When coding for the cPanel interface, the API 2 system can utilize a custom templating system, based on Template Toolkit, to display data returned by the functions. API 2 is much more flexible than API 1, but requires more sophisticated coding. We recommend using API 2 whenever possible.
 
External API  
XML and JSON API Our XML and JSON APIs allow you to interact with WHM.
Changed:
<
<
Parsing XML Data You can use this document to learn how to parse XML output.
>
>
Parsing XML Data Learn how to parse XML output.
 
Manage 2 API Our Manage 2 API allows you to manage your licenses.
API Privilege Escalation You can temporarily escalate a user's privileges while using API calls.

Modules and Plugins

Changed:
<
<
These documents explain how to create modules and plugins for cPanel & WHM. You can create cPanel modules and plugins to extend cPanel's functionality. WHM plulgins allow you to add new functionality to WHM.
>
>
You can create cPanel modules and plugins to extend cPanel's functionality. WHM plulgins allow you to add new functionality to WHM. These documents explain how to create modules and plugins for cPanel & WHM.
 
cPanel Modules
Writing cPanel Modules Modules are software components that you can add to cPanel to extend cPanel's functionality.
Changed:
<
<
The PHP Accounting Module Learn how to use access keys with cPanel's PHP accounting module from here.
The cPanel::Accounting Perl Module Here, you can learn how to use remote access keys with the cPanel::Accounting Perl module.
>
>
The PHP Accounting Module Learn how to use access keys with cPanel's PHP accounting module.
The cPanel::Accounting Perl Module Learn how to use remote access keys with the cPanel::Accounting Perl module.
 
Writing cPanel Plugins  
Changed:
<
<
Writing cPanel Plugins cPanel Plugins allow you to integrate third-party applications with cPanel. You can use plugins to add links to your users' cPanel interface.
>
>
Writing cPanel Plugins cPanel Plugins allow you to integrate third-party applications with cPanel. You can use plugins to add links to your users' cPanel interfaces.
 
Using PHP in a cPanel Plugin's Interface cPanel allows for additional pages to be written in PHP rather than straight HTML. This document describes using PHP to generate a cPanel plugin's interface.
cPanel CGI Scripts CGI scripts can be very useful when you need more flexibility than cPanel's other integration methods allow. This document describes where and how to create your CGI script.
Changed:
<
<
Using Live PHP in a cPanel Plugin LivePHP is a PHP framework you can utilize within cPanel. This framework provides PHP scripts with a local socket to the cPanel binary, cpsrvd, allowing your script to make API1 and API2 calls to the local machine via the socket.
>
>
Using Live PHP in a cPanel Plugin LivePHP is a PHP framework you can use within cPanel. This framework provides PHP scripts with a local socket to the cPanel binary, cpsrvd, allowing your script to make API1 and API2 calls to the local machine via the socket.
 
Plugin Variables This page documents the variables available within cPanel's HTML logic and DynamicUI files.
Installing cPanel Plugins cPanel plugins must be installed and used in a specific way. You can learn about installing cPanel plugins here.
Changed:
<
<
Adding Icons and Groups You can learn about adding icons and groups to the cPanel interface here.
>
>
Adding Icons and Groups Learn about adding icons and groups to the cPanel interface.
 
Plugin Installation File Generator You will need to generate an installation file for your plugins.
Plugin Security Policy You can read cPanel's plugin security policy here.
WHM Plugins  
Line: 50 to 51
 
The swapip Utility Though it does not reside in the /scripts directory, this tool allows you to update the IP address in a DNS zone record.
The cPanel Logger Module The Cpanel::Logger module can be used to raise error messages in a custom event handler. This module provides a common interface for logging to files, such as cPanel's error_log.
Added:
>
>
 

cPanel Hooks

These documents explain how to hook into cPanel's functionality. You can run hooks before and after API calls. This will allow you to automate recurring tasks on a cPanel & WHM server.

Line: 57 to 59
 
cPanel Hooks
Introduction This document will get you started on the various methods of hooking into cPanel's functionality.
Writing Function Hooks Function hooks allow you to automatically perform actions after an API 1 or API 2 function is executed. These scripts are placed in /usr/local/cpanel/hooks and receive XML via STDIN from parent cPanel processes.
Changed:
<
<
Script Hooks cPanel/WHM script hooks allow for custom code to be executed for certain system-level operations such as account modifications, installation of server software, and backup runs.
Custom Event Handlers A custom event handler is a powerful tool that allows you to access operations triggered by the cPanel interface. You can create custom event handlers as pre and post event handlers — meaning that the action is taken before or after an API.
>
>
Script Hooks cPanel & WHM script hooks allow for custom code to be executed for certain system-level operations such as account modifications, installation of server software, and backup runs.
Custom Event Handlers A custom event handler is a powerful tool that allows you to access operations triggered by the cPanel interface. You can create custom event handlers as pre and post event handlers—meaning that the action is taken before or after an API function executes.
 
The cPanel Logger Module You can use the Cpanel::Logger module to raise error messages in a custom event handler.
Hooking into EasyApache  
Changed:
<
<
EasyApache Hooks? You can automatically perform actions before or after rebuilding Apache using EasyApache.
>
>
EasyApache Hooks? Using EasyApache, you can automatically perform actions before or after rebuilding Apache.
 

cPAddons (Site Software)

Revision 703 Mar 2011 - Main.JustinSchaefer

Line: 1 to 1
 
META TOPICPARENT name="WebHome"

Resources

Line: 8 to 8
 

cPanel & WHM's API

Changed:
<
<
These documents describe how to use our API functions. Our API allows you to perform cPanel & WHM functions from within your own integrated or external applications.
>
>
These documents describe how to use our API functions. Our API allows you to access cPanel & WHM functionality from your own integrated or external applications.
 
Basics
Introduction You can find basic information about our application programming interface (API) here.
Authenticating API Function Calls We have 2 methods you can use to authenticate API function calls.
Added:
>
>
cPanel Template Toolkit cPanel Template Toolkit is a template-driven parser for API2 calls. This document describes how to use the cPanel Template Toolkit.
 
Internal API  
Calling API 1 Functions You can learn how to call API 1 functions directly from this document.
Changed:
<
<
Calling API 2 Functions Here, we describe how to call API 2 functions directly. When coding for the cPanel interface, the API 2 system can utilize a custom templating system, based on Template ToolKit, to display returned data. API 2, therefore, is much more flexible but requires more sophisticated coding from the developer. We recommend using API 2 over API 1 whenever possible.
Calling API 1 & 2 Functions via XML API You can call API 1 and API 2 functions via our XML API.
>
>
Calling API 2 Functions Here, we describe how to call API 2 functions directly. When coding for the cPanel interface, the API 2 system can utilize a custom templating system, based on Template ToolKit, to display data returned by the functions. API 2 is much more flexible than API 1, but requires more sophisticated coding. We recommend using API 2 over API 1 whenever possible.
Calling API 1 & 2 Functions via XML API You can call API 1 and API 2 functions using our XML API.
 
API 1 Functions This is a reference list of API 1 functions and modules.
Changed:
<
<
API 2 Functions This is a reference list of API 2 functions and modules. When coding for the cPanel interface, the API 2 system can utilize a custom templating system, based on Template ToolKit, to display returned data. API 2, therefore, is much more flexible but requires more sophisticated coding from the developer. We recommend using API 2 over API 1 whenever possible.
>
>
API 2 Functions This is a reference list of API 2 functions and modules. When coding for the cPanel interface, the API 2 system can utilize a custom templating system, based on Template ToolKit, to display data returned by the functions. API 2 is much more flexible than API 1, but requires more sophisticated coding. We recommend using API 2 over API 1 whenever possible.
 
External API  
XML and JSON API Our XML and JSON APIs allow you to interact with WHM.
Changed:
<
<
Parsing XML Data Learn how to parse XML output.
>
>
Parsing XML Data You can use this document to learn how to parse XML output.
 
Manage 2 API Our Manage 2 API allows you to manage your licenses.
API Privilege Escalation You can temporarily escalate a user's privileges while using API calls.

Modules and Plugins

Changed:
<
<
These documents explain some of the modules and scripts included with cPanel & WHM.
>
>
These documents explain how to create modules and plugins for cPanel & WHM. You can create cPanel modules and plugins to extend cPanel's functionality. WHM plulgins allow you to add new functionality to WHM.
 
cPanel Modules
Changed:
<
<
Writing cPanel Modules Modules are software components that can be used to perform a variety of tasks on your server.
>
>
Writing cPanel Modules Modules are software components that you can add to cPanel to extend cPanel's functionality.
 
The PHP Accounting Module Learn how to use access keys with cPanel's PHP accounting module from here.
The cPanel::Accounting Perl Module Here, you can learn how to use remote access keys with the cPanel::Accounting Perl module.
Writing cPanel Plugins  
Writing cPanel Plugins cPanel Plugins allow you to integrate third-party applications with cPanel. You can use plugins to add links to your users' cPanel interface.
Using PHP in a cPanel Plugin's Interface cPanel allows for additional pages to be written in PHP rather than straight HTML. This document describes using PHP to generate a cPanel plugin's interface.
cPanel CGI Scripts CGI scripts can be very useful when you need more flexibility than cPanel's other integration methods allow. This document describes where and how to create your CGI script.
Deleted:
<
<
cPanel Template Toolkit cPanel Template Toolkit is a template-driven parser for API2 calls. This document describes how to use the cPanel Template Toolkit.
 
Using Live PHP in a cPanel Plugin LivePHP is a PHP framework you can utilize within cPanel. This framework provides PHP scripts with a local socket to the cPanel binary, cpsrvd, allowing your script to make API1 and API2 calls to the local machine via the socket.
Plugin Variables This page documents the variables available within cPanel's HTML logic and DynamicUI files.
Installing cPanel Plugins cPanel plugins must be installed and used in a specific way. You can learn about installing cPanel plugins here.
Changed:
<
<
Adding Icons and Groups You can learn about adding icons and groups in the cPanel interface here.
Plugin Installation File Generator The Plugin Installation File Generator
>
>
Adding Icons and Groups You can learn about adding icons and groups to the cPanel interface here.
Plugin Installation File Generator You will need to generate an installation file for your plugins.
 
Plugin Security Policy You can read cPanel's plugin security policy here.
WHM Plugins  
Creating WHM Plugins You can create WHM plugins that extend WHM's functionality.

Revision 603 Mar 2011 - Main.JustinSchaefer

Line: 1 to 1
 
META TOPICPARENT name="WebHome"

Resources

Line: 8 to 8
 

cPanel & WHM's API

Changed:
<
<
These documents describe how to use our API functions. Our API allows you to control cPanel & WHM from a number of pre-written modules that you can drop into your code.
>
>
These documents describe how to use our API functions. Our API allows you to perform cPanel & WHM functions from within your own integrated or external applications.
 
Basics
Changed:
<
<
Introduction You can find basic information about using API 1 and API 2 here.
>
>
Introduction You can find basic information about our application programming interface (API) here.
 
Authenticating API Function Calls We have 2 methods you can use to authenticate API function calls.
Internal API  
Calling API 1 Functions You can learn how to call API 1 functions directly from this document.
Line: 21 to 21
 
API 2 Functions This is a reference list of API 2 functions and modules. When coding for the cPanel interface, the API 2 system can utilize a custom templating system, based on Template ToolKit, to display returned data. API 2, therefore, is much more flexible but requires more sophisticated coding from the developer. We recommend using API 2 over API 1 whenever possible.
External API  
XML and JSON API Our XML and JSON APIs allow you to interact with WHM.
Changed:
<
<
Parsing XML Data You can parse our XML output.
Manage 2 API Our Manage 2 API allows you to automate our Manage 2 software to manage your licenses.
>
>
Parsing XML Data Learn how to parse XML output.
Manage 2 API Our Manage 2 API allows you to manage your licenses.
 
API Privilege Escalation You can temporarily escalate a user's privileges while using API calls.

Modules and Plugins

Line: 38 to 38
 
Using PHP in a cPanel Plugin's Interface cPanel allows for additional pages to be written in PHP rather than straight HTML. This document describes using PHP to generate a cPanel plugin's interface.
cPanel CGI Scripts CGI scripts can be very useful when you need more flexibility than cPanel's other integration methods allow. This document describes where and how to create your CGI script.
cPanel Template Toolkit cPanel Template Toolkit is a template-driven parser for API2 calls. This document describes how to use the cPanel Template Toolkit.
Changed:
<
<
Using Live PHP in a cPanel Plugin LivePHP is a PHP environment you can utilize within cPanel. This PHP environment provides PHP scripts with a local socket to the cPanel binary, cpsrvd, allowing your script to make API1 and API2 calls to the local machine via the socket.
>
>
Using Live PHP in a cPanel Plugin LivePHP is a PHP framework you can utilize within cPanel. This framework provides PHP scripts with a local socket to the cPanel binary, cpsrvd, allowing your script to make API1 and API2 calls to the local machine via the socket.
 
Plugin Variables This page documents the variables available within cPanel's HTML logic and DynamicUI files.
Installing cPanel Plugins cPanel plugins must be installed and used in a specific way. You can learn about installing cPanel plugins here.
Adding Icons and Groups You can learn about adding icons and groups in the cPanel interface here.

Revision 502 Mar 2011 - Main.JustinSchaefer

Line: 1 to 1
 
META TOPICPARENT name="WebHome"

Resources

Line: 11 to 11
 These documents describe how to use our API functions. Our API allows you to control cPanel & WHM from a number of pre-written modules that you can drop into your code.

Basics
Changed:
<
<
Introduction This document provides basic information about using API 1 and API 2.
Authenticating API Function Calls This document details 2 methods you can use to authenticate API function calls.
>
>
Introduction You can find basic information about using API 1 and API 2 here.
Authenticating API Function Calls We have 2 methods you can use to authenticate API function calls.
 
Internal API  
Changed:
<
<
Calling API 1 Functions This document describes how to call API 1 functions. cPanel uses the API 1 system to add, modify, or delete data on the server. Since API1 functions ordinarily print data to the cPanel interface, they're particularly useful for creating themes or skins.
Calling API 2 Functions This document describes how to call API 2 functions. The API 2 system uses its own custom templating system to display output. API 2 is more flexible but considerably more complicated than API 1.
Calling API 1 & 2 Functions via XML API This document explains how to call API 1 and API 2 functions via the XML API.
API 1 Functions These documents describe each API 1 function and module. cPanel uses the API 1 system to add, modify, or delete data on the server. API 1 functions print data to the cPanel interface, making them useful for creating themes or skins. This document describes each API 1 function and module.
API 2 Functions These documents describe each API 2 function and module. The API 2 system uses its own custom templating system to display output. API 2 is more flexible but considerably more complicated than API 1.
>
>
Calling API 1 Functions You can learn how to call API 1 functions directly from this document.
Calling API 2 Functions Here, we describe how to call API 2 functions directly. When coding for the cPanel interface, the API 2 system can utilize a custom templating system, based on Template ToolKit, to display returned data. API 2, therefore, is much more flexible but requires more sophisticated coding from the developer. We recommend using API 2 over API 1 whenever possible.
Calling API 1 & 2 Functions via XML API You can call API 1 and API 2 functions via our XML API.
API 1 Functions This is a reference list of API 1 functions and modules.
API 2 Functions This is a reference list of API 2 functions and modules. When coding for the cPanel interface, the API 2 system can utilize a custom templating system, based on Template ToolKit, to display returned data. API 2, therefore, is much more flexible but requires more sophisticated coding from the developer. We recommend using API 2 over API 1 whenever possible.
 
External API  
Changed:
<
<
XML and JSON API Our XML and JSON APIs allow you to manipulate WHM features.
Parsing XML Data This document contains information about parsing XML output.
Manage 2 API These documents describe the Manage 2 API.
API Privilege Escalation This document describes how you can temporarily escalate a user's privileges while using API calls.
>
>
XML and JSON API Our XML and JSON APIs allow you to interact with WHM.
Parsing XML Data You can parse our XML output.
Manage 2 API Our Manage 2 API allows you to automate our Manage 2 software to manage your licenses.
API Privilege Escalation You can temporarily escalate a user's privileges while using API calls.
 

Modules and Plugins

Line: 31 to 31
 
cPanel Modules
Writing cPanel Modules Modules are software components that can be used to perform a variety of tasks on your server.
Changed:
<
<
The PHP Accounting Module This document explains how to use access keys with cPanel's PHP accounting module.
The cPanel::Accounting Perl Module This document explains how to use remote access keys with the cPanel::Accounting Perl module.
>
>
The PHP Accounting Module Learn how to use access keys with cPanel's PHP accounting module from here.
The cPanel::Accounting Perl Module Here, you can learn how to use remote access keys with the cPanel::Accounting Perl module.
 
Writing cPanel Plugins  
Changed:
<
<
Writing cPanel Plugins cPanel plugins allow you to add new functionality to cPanel.
>
>
Writing cPanel Plugins cPanel Plugins allow you to integrate third-party applications with cPanel. You can use plugins to add links to your users' cPanel interface.
 
Using PHP in a cPanel Plugin's Interface cPanel allows for additional pages to be written in PHP rather than straight HTML. This document describes using PHP to generate a cPanel plugin's interface.
cPanel CGI Scripts CGI scripts can be very useful when you need more flexibility than cPanel's other integration methods allow. This document describes where and how to create your CGI script.
cPanel Template Toolkit cPanel Template Toolkit is a template-driven parser for API2 calls. This document describes how to use the cPanel Template Toolkit.
Using Live PHP in a cPanel Plugin LivePHP is a PHP environment you can utilize within cPanel. This PHP environment provides PHP scripts with a local socket to the cPanel binary, cpsrvd, allowing your script to make API1 and API2 calls to the local machine via the socket.
Plugin Variables This page documents the variables available within cPanel's HTML logic and DynamicUI files.
Changed:
<
<
Installing cPanel Plugins cPanel plugins allow you to link cPanel Plugins are links that you add to a user’s cPanel interface. They allow you to integrate your own applications, or third-party ones, with cPanel.
Adding Icons and Groups This document contains information about adding icons and groups in the cPanel interface.
>
>
Installing cPanel Plugins cPanel plugins must be installed and used in a specific way. You can learn about installing cPanel plugins here.
Adding Icons and Groups You can learn about adding icons and groups in the cPanel interface here.
 
Plugin Installation File Generator The Plugin Installation File Generator
Changed:
<
<
Plugin Security Policy This document contains some information about the cPanel Security Policy Plugin Syste.
>
>
Plugin Security Policy You can read cPanel's plugin security policy here.
 
WHM Plugins  
Changed:
<
<
Creating WHM Plugins This document details the process of creating WHM plugins.
ACL Reference Table This document is an access control reference table.
>
>
Creating WHM Plugins You can create WHM plugins that extend WHM's functionality.
ACL Reference Table You can find our access control reference table here.
 
The swapip Utility Though it does not reside in the /scripts directory, this tool allows you to update the IP address in a DNS zone record.
Changed:
<
<
The cPanel Logger Module You can use the Cpanel::Logger module to raise error messages in a custom event handler.
>
>
The cPanel Logger Module The Cpanel::Logger module can be used to raise error messages in a custom event handler. This module provides a common interface for logging to files, such as cPanel's error_log.
 
Changed:
<
<

Hooking into cPanel's functionality

>
>

cPanel Hooks

  These documents explain how to hook into cPanel's functionality. You can run hooks before and after API calls. This will allow you to automate recurring tasks on a cPanel & WHM server.
Changed:
<
<
Hooking into cPanel
>
>
cPanel Hooks
 
Introduction This document will get you started on the various methods of hooking into cPanel's functionality.
Changed:
<
<
Writing Function Hooks Function hooks allow you to automatically perform actions after an API1 or API2 function is executed. This works by running a script inside of /usr/local/cpanel/hooks/ and sending XML data to the script's STDIN.
>
>
Writing Function Hooks Function hooks allow you to automatically perform actions after an API1 or API2 function is executed. These scripts are placed in /usr/local/cpanel/hooks and receive XML via STDIN from parent cPanel processes.
 
Script Hooks cPanel/WHM script hooks allow for custom code to be executed for certain system-level operations such as account modifications, installation of server software, and backup runs.
Custom Event Handlers A custom event handler is a powerful tool that allows you to access operations triggered by the cPanel interface. You can create custom event handlers as pre and post event handlers — meaning that the action is taken before or after an API.
Changed:
<
<
The cPanel Logger Module The Cpanel::Logger module can be used to raise error messages in a custom event handler. This module provides a common interface for logging to files, such as cPanel's error_log.
>
>
The cPanel Logger Module You can use the Cpanel::Logger module to raise error messages in a custom event handler.
 
Hooking into EasyApache  
Changed:
<
<
EasyApache Hooks? This document describes how to automatically perform actions before or after rebuilding Apache.
>
>
EasyApache Hooks? You can automatically perform actions before or after rebuilding Apache using EasyApache.
 

cPAddons (Site Software)

cPAddons allow you to add functionality to the cPanel interface.

cPAddons
Changed:
<
<
Introduction This document functions as a introduction and landing page for cPAddons.
Creating cPAddons This document details step by step instructions for creating a cPAddon.
>
>
Introduction If you're new to cPAddons, this document will introduce you to some basic concepts.
Creating cPAddons Here, you can find step by step instructions for creating a cPAddon.
 
Creating cPAddon Upgrades cPAddon upgrades are new versions of a cPAddon script. This document details step by step instructions for creating an upgrade.
Changed:
<
<
Using Hash References with cPAddons This document serves a reference for keys accepted by the cPAddon's installation configuration files.
Using Custom Installation Fields with cPAddons This document describes how to add custom installation fields for a cPAddon's installation configuration files.
Configuration File Variables This document details how to set and manage configuration file variables.
>
>
Using Hash References with cPAddons You can access a reference of hash keys accepted by the cPAddon's installation configuration files here.
Using Custom Installation Fields with cPAddons You can add custom installation fields for a cPAddon's installation configuration files.
Configuration File Variables Here, you can learn how to set and manage configuration file variables.
 
Creating Invisible cPAddon Scripts If you create a cPAddon that is in some way associated with another cPAddon, or should otherwise not appear to all users, you can create a n invisible cPAddon script. This document describes how to create an invisible cPAddon script.
cPAddon Aliases If a cPAddon should fit into more than one category, you can create an alias. This document describes how to create an alias for a cPAddon script.
Changed:
<
<
Licensing cPAddons This document describes the process of using commercial licenses with your cPAddons.
Distributing cPAddons This document describes distributing your cPAddons through the WHM interface.
>
>
Licensing cPAddons Here, you can learn about using commercial licenses with your cPAddons.
Distributing cPAddons You can learn how to distribute your cPAddons through the WHM interface here.
 

Advanced System Administration

Line: 85 to 85
 
Advanced System Administration
More about TailWatch TailWatch is a process that handles the tasks previously handled by three separate processes: eximstats, antirelayd, and cpbandwd.
Changed:
<
<
Integrating Custom Webmail Applications This document describes the process of adding custom webmail applications to cPanel.
>
>
Integrating Custom Webmail Applications You can add your favorite custom webmail applications to cPanel.
 
Downloads You can find code examples and other downloadable files here.
Deleted:
<
<
Adding Custom Webmail Applications This document describes how to make your favorite 3rd party webmail applications available to your cPanel users via the Webmail interface.
 

Revision 423 Feb 2011 - MelanieSeibert

Line: 1 to 1
 
META TOPICPARENT name="WebHome"

Resources

Line: 37 to 37
 
Writing cPanel Plugins cPanel plugins allow you to add new functionality to cPanel.
Using PHP in a cPanel Plugin's Interface cPanel allows for additional pages to be written in PHP rather than straight HTML. This document describes using PHP to generate a cPanel plugin's interface.
cPanel CGI Scripts CGI scripts can be very useful when you need more flexibility than cPanel's other integration methods allow. This document describes where and how to create your CGI script.
Changed:
<
<
cPanel Template Tool Kit cPanel Template Toolkit is a template-driven parser for API2 calls. This document describes how to use the cPanel Template Toolkit.
>
>
cPanel Template Toolkit cPanel Template Toolkit is a template-driven parser for API2 calls. This document describes how to use the cPanel Template Toolkit.
 
Using Live PHP in a cPanel Plugin LivePHP is a PHP environment you can utilize within cPanel. This PHP environment provides PHP scripts with a local socket to the cPanel binary, cpsrvd, allowing your script to make API1 and API2 calls to the local machine via the socket.
Plugin Variables This page documents the variables available within cPanel's HTML logic and DynamicUI files.
Installing cPanel Plugins cPanel plugins allow you to link cPanel Plugins are links that you add to a user’s cPanel interface. They allow you to integrate your own applications, or third-party ones, with cPanel.
Line: 47 to 47
 
WHM Plugins  
Creating WHM Plugins This document details the process of creating WHM plugins.
ACL Reference Table This document is an access control reference table.
Changed:
<
<
The swapip utility Though it does not reside in the /scripts directory, this tool allows you to update the IP address in a DNS zone record.
>
>
The swapip Utility Though it does not reside in the /scripts directory, this tool allows you to update the IP address in a DNS zone record.
 
The cPanel Logger Module You can use the Cpanel::Logger module to raise error messages in a custom event handler.

Hooking into cPanel's functionality

Line: 69 to 69
 
cPAddons
Introduction This document functions as a introduction and landing page for cPAddons.
Changed:
<
<
Create a cPAddon This document details step by step instructions for creating a cPAddon.
>
>
Creating cPAddons This document details step by step instructions for creating a cPAddon.
 
Creating cPAddon Upgrades cPAddon upgrades are new versions of a cPAddon script. This document details step by step instructions for creating an upgrade.
Using Hash References with cPAddons This document serves a reference for keys accepted by the cPAddon's installation configuration files.
Using Custom Installation Fields with cPAddons This document describes how to add custom installation fields for a cPAddon's installation configuration files.

Revision 321 Feb 2011 - Main.JustinSchaefer

Line: 1 to 1
 
META TOPICPARENT name="WebHome"

Resources

Line: 6 to 6
 
Changed:
<
<

cPanel & WHM's APIs

>
>

cPanel & WHM's API

  These documents describe how to use our API functions. Our API allows you to control cPanel & WHM from a number of pre-written modules that you can drop into your code.
Line: 25 to 25
 
Manage 2 API These documents describe the Manage 2 API.
API Privilege Escalation This document describes how you can temporarily escalate a user's privileges while using API calls.
Changed:
<
<

Modules, Scripts, and Plugins

>
>

Modules and Plugins

  These documents explain some of the modules and scripts included with cPanel & WHM.
Line: 50 to 50
 
The swapip utility Though it does not reside in the /scripts directory, this tool allows you to update the IP address in a DNS zone record.
The cPanel Logger Module You can use the Cpanel::Logger module to raise error messages in a custom event handler.
Changed:
<
<

Hooking into cPanel functionality

>
>

Hooking into cPanel's functionality

  These documents explain how to hook into cPanel's functionality. You can run hooks before and after API calls. This will allow you to automate recurring tasks on a cPanel & WHM server.

Revision 221 Feb 2011 - Main.JustinSchaefer

Line: 1 to 1
 
META TOPICPARENT name="WebHome"
Changed:
<
<

Resources

>
>

Resources

  This section of our site contains links to to our SDK's documentation. To access a document, simply click the corresponding link.

Changed:
<
<

cPanel & WHM's APIs

>
>

cPanel & WHM's APIs

  These documents describe how to use our API functions. Our API allows you to control cPanel & WHM from a number of pre-written modules that you can drop into your code.
Changed:
<
<
Basics  
>
>
Basics
 
Introduction This document provides basic information about using API 1 and API 2.
Authenticating API Function Calls This document details 2 methods you can use to authenticate API function calls.
Internal API  
Line: 25 to 25
 
Manage 2 API These documents describe the Manage 2 API.
API Privilege Escalation This document describes how you can temporarily escalate a user's privileges while using API calls.
Changed:
<
<

Modules, Scripts, and Plugins

>
>

Modules, Scripts, and Plugins

  These documents explain some of the modules and scripts included with cPanel & WHM.
Changed:
<
<
cPanel Modules  
>
>
cPanel Modules
 
Writing cPanel Modules Modules are software components that can be used to perform a variety of tasks on your server.
The PHP Accounting Module This document explains how to use access keys with cPanel's PHP accounting module.
The cPanel::Accounting Perl Module This document explains how to use remote access keys with the cPanel::Accounting Perl module.
Line: 50 to 50
 
The swapip utility Though it does not reside in the /scripts directory, this tool allows you to update the IP address in a DNS zone record.
The cPanel Logger Module You can use the Cpanel::Logger module to raise error messages in a custom event handler.
Changed:
<
<

Hooking into cPanel functionality

>
>

Hooking into cPanel functionality

  These documents explain how to hook into cPanel's functionality. You can run hooks before and after API calls. This will allow you to automate recurring tasks on a cPanel & WHM server.
Changed:
<
<

Hooking into cPanel  
>
>
Hooking into cPanel
 
Introduction This document will get you started on the various methods of hooking into cPanel's functionality.
Writing Function Hooks Function hooks allow you to automatically perform actions after an API1 or API2 function is executed. This works by running a script inside of /usr/local/cpanel/hooks/ and sending XML data to the script's STDIN.
Script Hooks cPanel/WHM script hooks allow for custom code to be executed for certain system-level operations such as account modifications, installation of server software, and backup runs.
Custom Event Handlers A custom event handler is a powerful tool that allows you to access operations triggered by the cPanel interface. You can create custom event handlers as pre and post event handlers — meaning that the action is taken before or after an API.
The cPanel Logger Module The Cpanel::Logger module can be used to raise error messages in a custom event handler. This module provides a common interface for logging to files, such as cPanel's error_log.
Changed:
<
<
Hooking into EasyApache
EasyApache Hooks?  
>
>
Hooking into EasyApache  
EasyApache Hooks? This document describes how to automatically perform actions before or after rebuilding Apache.
 
Changed:
<
<

cPAddons (Site Software)

>
>

cPAddons (Site Software)

  cPAddons allow you to add functionality to the cPanel interface.
Changed:
<
<
Document Description
>
>
cPAddons
 
Introduction This document functions as a introduction and landing page for cPAddons.
Create a cPAddon This document details step by step instructions for creating a cPAddon.
Creating cPAddon Upgrades cPAddon upgrades are new versions of a cPAddon script. This document details step by step instructions for creating an upgrade.
Line: 82 to 79
 
Licensing cPAddons This document describes the process of using commercial licenses with your cPAddons.
Distributing cPAddons This document describes distributing your cPAddons through the WHM interface.
Changed:
<
<

Advanced System Administration

>
>

Advanced System Administration

  If you still have not found what you are looking for, you might find it in one of the miscellaneous documents below.
Changed:
<
<
Document Description
>
>
Advanced System Administration
 
More about TailWatch TailWatch is a process that handles the tasks previously handled by three separate processes: eximstats, antirelayd, and cpbandwd.
Integrating Custom Webmail Applications This document describes the process of adding custom webmail applications to cPanel.
Downloads You can find code examples and other downloadable files here.

Revision 121 Feb 2011 - Main.JustinSchaefer

Line: 1 to 1
Added:
>
>
META TOPICPARENT name="WebHome"

Resources

This section of our site contains links to to our SDK's documentation. To access a document, simply click the corresponding link.

cPanel & WHM's APIs

These documents describe how to use our API functions. Our API allows you to control cPanel & WHM from a number of pre-written modules that you can drop into your code.

Basics  
Introduction This document provides basic information about using API 1 and API 2.
Authenticating API Function Calls This document details 2 methods you can use to authenticate API function calls.
Internal API  
Calling API 1 Functions This document describes how to call API 1 functions. cPanel uses the API 1 system to add, modify, or delete data on the server. Since API1 functions ordinarily print data to the cPanel interface, they're particularly useful for creating themes or skins.
Calling API 2 Functions This document describes how to call API 2 functions. The API 2 system uses its own custom templating system to display output. API 2 is more flexible but considerably more complicated than API 1.
Calling API 1 & 2 Functions via XML API This document explains how to call API 1 and API 2 functions via the XML API.
API 1 Functions These documents describe each API 1 function and module. cPanel uses the API 1 system to add, modify, or delete data on the server. API 1 functions print data to the cPanel interface, making them useful for creating themes or skins. This document describes each API 1 function and module.
API 2 Functions These documents describe each API 2 function and module. The API 2 system uses its own custom templating system to display output. API 2 is more flexible but considerably more complicated than API 1.
External API  
XML and JSON API Our XML and JSON APIs allow you to manipulate WHM features.
Parsing XML Data This document contains information about parsing XML output.
Manage 2 API These documents describe the Manage 2 API.
API Privilege Escalation This document describes how you can temporarily escalate a user's privileges while using API calls.

Modules, Scripts, and Plugins

These documents explain some of the modules and scripts included with cPanel & WHM.

cPanel Modules  
Writing cPanel Modules Modules are software components that can be used to perform a variety of tasks on your server.
The PHP Accounting Module This document explains how to use access keys with cPanel's PHP accounting module.
The cPanel::Accounting Perl Module This document explains how to use remote access keys with the cPanel::Accounting Perl module.
Writing cPanel Plugins  
Writing cPanel Plugins cPanel plugins allow you to add new functionality to cPanel.
Using PHP in a cPanel Plugin's Interface cPanel allows for additional pages to be written in PHP rather than straight HTML. This document describes using PHP to generate a cPanel plugin's interface.
cPanel CGI Scripts CGI scripts can be very useful when you need more flexibility than cPanel's other integration methods allow. This document describes where and how to create your CGI script.
cPanel Template Tool Kit cPanel Template Toolkit is a template-driven parser for API2 calls. This document describes how to use the cPanel Template Toolkit.
Using Live PHP in a cPanel Plugin LivePHP is a PHP environment you can utilize within cPanel. This PHP environment provides PHP scripts with a local socket to the cPanel binary, cpsrvd, allowing your script to make API1 and API2 calls to the local machine via the socket.
Plugin Variables This page documents the variables available within cPanel's HTML logic and DynamicUI files.
Installing cPanel Plugins cPanel plugins allow you to link cPanel Plugins are links that you add to a user’s cPanel interface. They allow you to integrate your own applications, or third-party ones, with cPanel.
Adding Icons and Groups This document contains information about adding icons and groups in the cPanel interface.
Plugin Installation File Generator The Plugin Installation File Generator
Plugin Security Policy This document contains some information about the cPanel Security Policy Plugin Syste.
WHM Plugins  
Creating WHM Plugins This document details the process of creating WHM plugins.
ACL Reference Table This document is an access control reference table.
The swapip utility Though it does not reside in the /scripts directory, this tool allows you to update the IP address in a DNS zone record.
The cPanel Logger Module You can use the Cpanel::Logger module to raise error messages in a custom event handler.

Hooking into cPanel functionality

These documents explain how to hook into cPanel's functionality. You can run hooks before and after API calls. This will allow you to automate recurring tasks on a cPanel & WHM server.

Hooking into cPanel  
Introduction This document will get you started on the various methods of hooking into cPanel's functionality.
Writing Function Hooks Function hooks allow you to automatically perform actions after an API1 or API2 function is executed. This works by running a script inside of /usr/local/cpanel/hooks/ and sending XML data to the script's STDIN.
Script Hooks cPanel/WHM script hooks allow for custom code to be executed for certain system-level operations such as account modifications, installation of server software, and backup runs.
Custom Event Handlers A custom event handler is a powerful tool that allows you to access operations triggered by the cPanel interface. You can create custom event handlers as pre and post event handlers — meaning that the action is taken before or after an API.
The cPanel Logger Module The Cpanel::Logger module can be used to raise error messages in a custom event handler. This module provides a common interface for logging to files, such as cPanel's error_log.
Hooking into EasyApache
EasyApache Hooks?  

cPAddons (Site Software)

cPAddons allow you to add functionality to the cPanel interface.

Document Description
Introduction This document functions as a introduction and landing page for cPAddons.
Create a cPAddon This document details step by step instructions for creating a cPAddon.
Creating cPAddon Upgrades cPAddon upgrades are new versions of a cPAddon script. This document details step by step instructions for creating an upgrade.
Using Hash References with cPAddons This document serves a reference for keys accepted by the cPAddon's installation configuration files.
Using Custom Installation Fields with cPAddons This document describes how to add custom installation fields for a cPAddon's installation configuration files.
Configuration File Variables This document details how to set and manage configuration file variables.
Creating Invisible cPAddon Scripts If you create a cPAddon that is in some way associated with another cPAddon, or should otherwise not appear to all users, you can create a n invisible cPAddon script. This document describes how to create an invisible cPAddon script.
cPAddon Aliases If a cPAddon should fit into more than one category, you can create an alias. This document describes how to create an alias for a cPAddon script.
Licensing cPAddons This document describes the process of using commercial licenses with your cPAddons.
Distributing cPAddons This document describes distributing your cPAddons through the WHM interface.

Advanced System Administration

If you still have not found what you are looking for, you might find it in one of the miscellaneous documents below.

Document Description
More about TailWatch TailWatch is a process that handles the tasks previously handled by three separate processes: eximstats, antirelayd, and cpbandwd.
Integrating Custom Webmail Applications This document describes the process of adding custom webmail applications to cPanel.
Downloads You can find code examples and other downloadable files here.
Adding Custom Webmail Applications This document describes how to make your favorite 3rd party webmail applications available to your cPanel users via the Webmail interface.

<-- 
  • Set PAGETITLE = cPanel & WHM's SDK
-->