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
DomainLookup Module Documentation
This module allows you to gather domain and document root maps from authenticated accounts. 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.DomainLookup::getbasedomains
| API Version: | 2 - Click here for documentation |
|---|---|
| Description: | Retrieve parked domains, addon domains, and main domains for a cPanel account. |
| Returns: | |
<data> <domain> A string value that contains a domain.</domain> </data> |
DomainLookup::getdocroot
| API Version: | 2 - Click here for documentation |
|---|---|
| Description: | Retrieve the absolute and relative paths to a specific domain's document root. |
| Parameters: | |
| domain (string) | |
| The domain corresponding to the document root you wish to know. If you do not pass this parameter any information, your main domain is used. You must own the domain you wish to query. | |
| Returns: | |
<data> <docroot> A string value that contains the absolute path to the domain's document root. (e.g. /home/user/public_html/subdomain/)</docroot> <reldocroot> A string value that contains the relative path to the domain's document root. (e.g. public_html/subdomain/)</reldocroot> </data> |
DomainLookup::getdocroots
| API Version: | 2 - Click here for documentation |
|---|---|
| Description: | Retrieve the full paths to all of your domains' document roots. |
| Returns: | |
<data> <docroot> A string value that contains the absolute path to the domain's document root. (e.g. /home/user/public_html/subdomain/)</docroot> <domain> A string value that contains the domain name corresponding to the document root. (e.g. example.com)</domain> </data> |
DomainLookup::countbasedomains
| API Version: | 2 - Click here for documentation |
|---|---|
| Description: | Retrieve the total number of base domains associated with your cPanel account. This value includes the main domain, addon domains, and parked domains. |
| Returns: | |
<data> <count> An integer value that contains the number of base domains associated with your cPanel account.</count> </data> |
Edit | Attach | Print version | History: r1 | Backlinks | Raw View | More topic actions
Topic revision: r1 - 17 Aug 2012 - 20:28:46 - Main.TWikiGuest