| |
| |
| META TOPICPARENT |
name="WebHome" |
Documentation for developers working with cPanel & WHM | | | 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.
| |
<
< |
| >
> |
| | |
| |
<
< |
| 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 |
|
| |
<
< |
| >
> |
| | |
| Manage 2 API |
Our Manage 2 API allows you to manage your licenses. |
| |
<
< |
| >
> |
| | |
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.
| |
<
< |
| >
> |
| | |
| |
<
< |
| 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. |
| | |
| |
<
< |
| 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. |
| | | 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.
| |
<
< |
| 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. |
| | | cPAddons allow you to add functionality to the cPanel interface.
| |
<
< |
| >
> |
| | |
Advanced System Administration
Advanced system administrators may find the following information useful.
| Advanced System Administration |
|
| |
<
< |
| >
> |
| | | Downloads | |
<
< |
| Downloads |
Access code examples and other useful downloads. |
| >
> |
| Downloads |
Access code examples and other useful downloads. |
| | |
| |
| META TOPICPARENT |
name="WebHome" |
Documentation for developers working with cPanel & WHM | | |
| |
>
> |
Downloads | | |
| Downloads |
Access code examples and other useful downloads. |
| |
| META TOPICPARENT |
name="WebHome" |
Documentation for developers working with cPanel & WHM | | |
| 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. |
| |
>
> |
| | |
|
| |
| META TOPICPARENT |
name="WebHome" |
Documentation for developers working with cPanel & WHM | | |
| 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. |
| | |
cPanel Hooks | | |
| 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. |
|
| |
| META TOPICPARENT |
name="WebHome" |
| |
<
< | Resources | >
> | Documentation for developers working with cPanel & WHM | | |
This section of our site contains links to to our SDK documentation.
| |
<
< | 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. | | |
| |
<
< | 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.
| | |
| 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. |
| |
<
< | 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. | | |
| Hooking into EasyApache |
|
| EasyApache Hooks |
Using EasyApache, you can automatically perform actions before or after rebuilding Apache. |
| |
<
< | cPAddons (Site Software) | >
> | cPAddons (Site Software) | | |
cPAddons allow you to add functionality to the cPanel interface. | | |
| |
<
< | Advanced System Administration | >
> | Advanced System Administration | | |
Advanced system administrators may find the following information useful. |
| |
| META TOPICPARENT |
name="WebHome" |
| |
<
< | Resources | >
> | Resources | | |
This section of our site contains links to to our SDK documentation. | |
<
< | | | | | |
<
< | 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. | | |
| |
<
< | 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.
| | |
| 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. |
| |
<
< | 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. | | |
| Hooking into EasyApache |
|
| EasyApache Hooks |
Using EasyApache, you can automatically perform actions before or after rebuilding Apache. |
| |
<
< | cPAddons (Site Software) | >
> | cPAddons (Site Software) | | |
cPAddons allow you to add functionality to the cPanel interface. | | |
| |
<
< | 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 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. |
|
| |
| META TOPICPARENT |
name="WebHome" |
Resources | | |
| cPAddons |
|
| 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. |
| 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. |
| >
> |
| | |
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. | >
> | If you still have not found what you are looking for, you might find it in one of the documents below. | | |
| |
<
< |
| Downloads |
You can find code examples and other downloadable files here. |
| >
> |
| Downloads |
Access code examples and other useful downloads. |
| | |
| |
| 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. | >
> | This section of our site contains links to to our SDK documentation. | | | | |
>
> | | | | cPanel & WHM's API | |
<
< | 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. | | |
| |
<
< |
| >
> |
| | |
| 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. |
| 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. |
| | |
| |
<
< |
| 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. |
| |
<
< |
| >
> |
| | |
Modules and Plugins | |
<
< | 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. |
| |
<
< |
| >
> |
| | |
| |
<
< |
| 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. |
| |
<
< |
| 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. |
| |
<
< |
| >
> |
| | |
| | |
| 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. |
| |
>
> | | | | 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. |
| >
> |
| 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 |
|
| |
<
< |
| 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) |
| |
| META TOPICPARENT |
name="WebHome" |
Resources | | |
cPanel & WHM's API | |
<
< | 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. | | |
| |
>
> |
| cPanel Template Toolkit |
cPanel Template Toolkit is a template-driven parser for API2 calls. This document describes how to use the cPanel Template Toolkit. |
| | |
| |
<
< |
| 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 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. |
| |
<
< |
| >
> |
| | |
Modules and Plugins | |
<
< | 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. | | |
| |
<
< |
| 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. |
| |
<
< |
| 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. |
| |
<
< |
| >
> |
| | |
|
| |
| META TOPICPARENT |
name="WebHome" |
Resources | | |
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. | >
> | 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. | | |
| |
<
< |
| 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. |
| | |
| | |
| 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. |
| |
<
< |
| 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. |
| >
> |
| | |
Modules and Plugins | | |
| 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. |
| >
> |
| 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. |
|
| |
| META TOPICPARENT |
name="WebHome" |
Resources | | | 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.
| |
<
< |
| >
> |
| | |
| |
<
< |
| 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. |
| | |
| |
<
< |
| >
> |
| | |
Modules and Plugins | | |
| cPanel Modules |
|
| Writing cPanel Modules |
Modules are software components that can be used to perform a variety of tasks on your server. |
| |
<
< |
| >
> |
| | |
| |
<
< |
| >
> |
| 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. |
| |
<
< |
| 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. |
| >
> |
| | |
| |
<
< |
| >
> |
| | |
| |
<
< |
| >
> |
| | |
| 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. |
| | | | |
<
< | 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. | |
<
< |
| >
> |
| | |
| 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. |
| >
> |
| 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. |
| |
<
< |
| 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 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.
| |
<
< |
| 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. |
| |
<
< |
| >
> |
| | |
| 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 | | |
| Advanced System Administration |
|
| More about TailWatch |
TailWatch is a process that handles the tasks previously handled by three separate processes: eximstats, antirelayd, and cpbandwd. |
| |
<
< |
| >
> |
| | |
| 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. |
| | |
| |
| META TOPICPARENT |
name="WebHome" |
Resources | | |
| 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. |
| >
> |
| 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. |
| | |
| |
<
< |
| 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. |
| | |
Hooking into cPanel's functionality | | |
| 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 cPAddons |
This document details step by step instructions for creating a cPAddon. |
| | |
|
| |
| META TOPICPARENT |
name="WebHome" |
Resources | | | | |
<
< | 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. | | |
| 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 | >
> | Modules and Plugins | | |
These documents explain some of the modules and scripts included with cPanel & WHM. | | |
| 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 | >
> | 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. |
| |
| META TOPICPARENT |
name="WebHome" |
| |
<
< | Resources | >
> | 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 | >
> | 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. | |
<
< |
| >
> |
| | |
| | |
| 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 | >
> | Modules, Scripts, and Plugins | | |
These documents explain some of the modules and scripts included with cPanel & WHM. | |
<
< |
| >
> |
| | |
| | |
| 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 | >
> | 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. | |
<
< |
| >
> |
| | |
| 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 |
This document describes how to automatically perform actions before or after rebuilding Apache. |
| | | | |
<
< | cPAddons (Site Software) | >
> | cPAddons (Site Software) | | |
cPAddons allow you to add functionality to the cPanel interface. | |
<
< |
| >
> |
| | |
| 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. |
| | |
| 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 | >
> | 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. | |
<
< |
| >
> |
| 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. |
|
|
>
> |
| 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
--> |
|
|
|
|
|
Note: 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. 
Important: This should only be run on development servers.