Software Development Kit
cPanel & WHM's API [+] cPanel & WHM's API [-]Modules and Plugins [+] Modules and Plugins [-]
cPanel Modules
Writing cPanel Modules PHP Accounting Module cPanel::Accounting Perl Module Writing cPanel Plugins
Writing cPanel Plugins PHP in cPanel Plugin Interfaces cPanel CGI Scripts Live PHP in cPanel Plugins Plugin Variables Installing cPanel Plugins Adding Icons and Groups Plugin Installation File Generator Plugin Security Policy (
.pdf)
WHM Plugins
Creating WHM Plugins ACL Reference Table The swapip Utility cPanel Logger Module Pluggable dnsadmin Modules EasyApache Modules
Custom Modules?
cPanel & WHM Hooks [+] cPanel & WHM Hooks [-]
Standardized Hooks Introduction Taxonomy Getting Started Hooks Management Interface Hookable Events Advanced Usage Troubleshooting
Legacy Hooks Introduction Writing Function Hooks Script Hooks Custom Event Handlers cPanel Logger Module Universal Password Trap Hooking into EasyApache
EasyApache Hooks?
cPAddons (Site Software) [+] cPAddons (Site Software) [-]
System Administration [+] System Administration [-]
Developer Software [+] Developer Software [-]
Back to All Documentation
Park Module Documentation
The Park module allows you to manage parked domains. The functions within this module may or may not be governed by a feature list. The required feature list may vary from function to function, to review a total list of the available features sets on a cPanel server, please see "Feature Manager" in WHM.Park::unpark
| API Version: | 2 - Click here for documentation |
|---|---|
| Description: | Remove a parked domain. |
| Parameters: | |
| domain (string) | |
| The domain name of the parked domain you wish to remove. | |
| Returns: | |
<data> <reason> A string that contains a success message or reason for failure.</reason> <result> A boolean value indicating success or failure. '1' if successful. '0' if failed.</result> </data> |
Park::listparkeddomains
| API Version: | 2 - Click here for documentation |
|---|---|
| Description: | Retrieve a list of parked domains associated with a cPanel account. |
| Parameters: | |
| regex (Regular Expression (optional)) | |
| This will only return domains that match against the provided regular expression. | |
| Returns: | |
<data> <domain> A string value that contains the parked domain's domain name.</domain> <status> A string value that indicates whether or not the parked domain redirects to another domain.</status> <reldir> A string value that contains the relative path to the domain's document root prefixed by 'home:'. (e.g. home:public_html/addon-example.com)</reldir> <dir> A string value that contains the absolute path to the document root. (e.g. /home/user/public_html/parked-domain.com/)</dir> <basedir> A string value that contains the relative path to the domain's document root. This value is not prefixed by 'home:'. (e.g. public_html/addon-example.com/)</basedir> </data> |
Park::listaddondomains
| API Version: | 2 - Click here for documentation |
|---|---|
| Description: | Retrieve a list of addon domains associated with a cPanel account. |
| Parameters: | |
| regex (Regular Expression (optional)) | |
| Allows you to search for a specific addon domain by specifying a specific string or regular expression to match against the "domain" key in the returned data. | |
| Returns: | |
<data> <domainkey> The addon domain's domain key. This value includes the cPanel username and main domain separated by an underscore (_). (e.g. username_maindomain.com)</domainkey> <domain> The addon domain's domain name. (e.g. addon-example.com)</domain> <rootdomain> The cPanel account's main domain.</rootdomain> <status> Indicates whether or not the addon domain redirects to another domain.</status> <fullsubdomain> The subdomain that corresponds to the addon domain. (e.g. username.maindomain.com)</fullsubdomain> <subdomain> The username that corresponds to the subdomain and addon domain. (e.g. username)</subdomain> <reldir> The relative path to the domain's document root prefixed by 'home:'. (e.g. home:public_html/addon-example.com/)</reldir> <dir> The absolute path to the domain's document root. (e.g. /home/user/public_html/addon-example.com/)</dir> <basedir> The relative path to the domain's document root. This value is not prefixed by 'home:'. (e.g. public_html/addon-example.com/)</basedir> </data> |
Park::park
| API Version: | 2 - Click here for documentation |
|---|---|
| Description: | Park a domain on top of another domain. |
| Parameters: | |
| domain (string) | |
| The domain name you wish to park. | |
| topdomain (string) | |
| The domain on top of which the parked domain will be parked. This value must point to a preexisting subdomain (e.g. topdomain.example.com). If this parameter is not specified, the primary domain is used. . | |
| Returns: | |
<data> <reason> A string value that contains a message of success or a reason for failure.</reason> <result> A boolean value indicating success or failure. '1' if successful. '0' if failed.</result> </data> |
Edit | Attach | Print version | History: r2 < r1 | Backlinks | Raw View | More topic actions
Topic revision: r2 - 26 Mar 2012 - 16:20:38 - Main.JenniferDoubrava