Knowledgebase

 API Shell for WHM

Overview This feature allows you to call WHM API functions interactively within the interface....

 Functions - Market::request_ssl_certificates

Description This function submits a request for a certificate order to the cPanel...

 Guide to API Authentication

Introduction cPanel & WHM supports several API authentication methods. Whenever code calls...

 Guide to API Privilege Escalation

Introduction Warning: Poor implementations of this system may cause root-privilege...

 Guide to API Privilege Escalation - Application Files

Introduction The application file contains the functions that you wish for the system to...

 Guide to API Privilege Escalation - Call Your Application

Introduction To use your AdminBin application, call the appropriate method. The method to use...

 Guide to API Privilege Escalation - Configuration Files

Introduction The configuration file defines two configuration settings that determine your...

 Guide to API Privilege Escalation - Legacy Method

Introduction Warning: Poor implementations of this system may cause root-privilege...

 Guide to API Privilege Escalation - Object Methods

Introduction Your class will inherit several useful methods, such as get_caller_username(), from...

 Guide to AppConfig

Introduction The AppConfig system configures cPanel & WHM attributes and registers WHM...

 Guide to AppConfig - AppConfig Utilities

Introduction The AppConfig system's utilities automate several AppConfig functions. We...

 Guide to AppConfig - The AppConfig Configuration File

  Introduction AppConfig configuration files store each application's AppConfig settings....

 Guide to Custom dnsadmin Plugins

Introduction Custom dnsadmin plugins can update DNS records on external systems. To create a...

 Guide to Custom dnsadmin Plugins - Node Configuration Files

Introduction Use the node configuration file to add nodes to a DNS cluster. The dnsadmin system...

 Guide to Custom dnsadmin Plugins - Remote Module Command Methods

Introduction You must include command methods in your custom dnsadmin plugin's Remote module....

 Guide to Custom dnsadmin Plugins - The Remote Module

Introduction The Remote module communicates with other servers in the DNS cluster. Store the...

 Guide to Custom dnsadmin Plugins - The Setup Module

Introduction The Setup module creates the node configuration file for a new DNS node. Store the...

 Guide to External Authentication

  Introduction   Pluggable external authentication modules allow users to log in through...

 Guide to External Authentication - OpenID Connect

Introduction External authentication allows your server's users to log in to WHM, cPanel, and...

 Guide to Locales

Introduction The locale system localizes text in Perl, Template Toolkit, or JavaScript code....

 Guide to Locales - Basic Usage

Introduction You can display locale system strings in custom code. This document includes...

 Guide to Locales - Best Practices

Introduction The locale system's functionality relies heavily on localization best practices....

 Guide to Locales - Distribute a Custom Locale

Introduction Use the /scripts/locale_export script to distribute your custom locales. Notes:...

 Guide to Locales - For Translators

Introduction This document provides information for translators of phrases from cPanel &...

 Guide to Locales - The Snowman Locale

Introduction The i_cpanel_snowmen locale allows you to quickly test localization. This locale...

 Guide to Locales - Troubleshooting

Introduction Use this document to troubleshoot common locale system issues. Remember:...

 Guide to Locales - Why You Should Use UTF-8

Introduction The locale system's character set is  always utf-8 . While it is possible to use...

 Guide to Package Extensions

Introduction Package extensions add custom fields to packages and accounts. These fields can...

 Guide to Package Extensions - Data Behavior and Changes

Introduction WHM API calls can modify package extension data in ways that the WHM interface...

 Guide to Package Extensions - Default Settings Files

Introduction The default settings file provides the default configuration for an extension's...

 Guide to Package Extensions - Template Files

Introduction Package extensions use Template Toolkit (.tt2) files to display variable forms in...

 Guide to Perl in cPanel

Introduction cPanel & WHM ships with multiple Perl environments. Perl modules allow you to...

 Guide to Perl in cPanel - Custom Modules

Introduction cPanel & WHM servers include multiple Perl environments. Your Perl modules can...

 Guide to Perl in cPanel - Perl Environments

Introduction cPanel & WHM servers include multiple Perl environments. Your Perl...

 Guide to Site Publisher Templates

Introduction You can create your own custom templates for cPanel's Site Publisher feature....

 Guide to Site Publisher Templates - Template Files

Introduction This document provides basic information about the files that most templates...

 Guide to Site Publisher Templates - The Configuration File

Introduction The Site Publisher feature publishes configuration data with each Site Publisher...

 Guide to Site Publisher Templates - The meta.json File

Introduction The meta.json file stores your Site Publisher template's information. Every Site...

 Guide to Standardized Hooks

Introduction Standardized Hooks trigger applications when cPanel & WHM performs an action....

 Guide to Standardized Hooks - Checks

Introduction Checks verify arbitrary conditions before the system runs the hook action code....

 Guide to Standardized Hooks - Cpanel Functions

Introduction The Cpanel category creates hookable events for cPanel API 1, cPanel API...

 Guide to Standardized Hooks - Custom Event Handlers

Introduction Warning: This method is deprecated. To convert custom event handlers to use...

 Guide to Standardized Hooks - Debug Mode

Introduction The Standardized Hooks System's debug mode helps to troubleshoot hook issues....

 Guide to Standardized Hooks - Exceptions

Introduction The Standardized Hooks System honors exceptions in hook action code or in check...

 Guide to Standardized Hooks - Function Hooks

Introduction Function hook scripts run automatically, after a specific cPanel API function. You...

 Guide to Standardized Hooks - Hook Action Code

Introduction You can create hook action code in a custom Perl module or as an executable script....

 Guide to Standardized Hooks - Hookable Events

Introduction Hookable events set the action that triggers a hook, and whether the hook triggers...

 Guide to Standardized Hooks - Hookable Events in Custom Modules

Introduction Custom modules can define additional hookable events for the Standardized Hooks...

 Guide to Standardized Hooks - Passwd Functions

Introduction The Passwd category's events occur when a WHM user changes a cPanel user's...

 Guide to Standardized Hooks - PkgAcct Functions

Introduction The PkgAcct category's events occur during backup creation. Create...

 Guide to Standardized Hooks - Privilege Escalation

Introduction Scripted hook action code that runs as the cPanel user can escalate that user's...

 Guide to Standardized Hooks - RPM::Versions Functions

Introduction The RPM::Versions category creates hookable events for RPMs. Note: cPanel...

 Guide to Standardized Hooks - Rollbacks

Introduction Rollbacks undo hook action code changes in specific circumstances. If any hook...

 Guide to Standardized Hooks - Script Hooks

Introduction Script hooks execute custom code before and after certain system-level...

 Guide to Standardized Hooks - Stats Functions

Introduction The Stats category's events occur during statistics processing. RunAll...

 Guide to Standardized Hooks - System Functions

Introduction The System category's events occur during system updates or backups. upcp...

 Guide to Standardized Hooks - The describe() Method

Introduction The describe() method embeds hook action code attributes in your hook action code....

 Guide to Standardized Hooks - The manage_hooks Utility

Introduction Use the manage_hooks utility to connect (register) the hook action code...

 Guide to Standardized Hooks - Universal Password Trap

Introduction The universal password trap hook triggers each time a user's password changes. This...

 Guide to Standardized Hooks - Whostmgr Functions

Introduction The Whostmgr category's events occur during WHM functions....

 Guide to Template Toolkit - API Calls from Template Toolkit

Introduction cPanel & WHM uses template files to construct interfaces that call cPanel's...

 Guide to Template Toolkit - Includes

Introduction Includes allow you to standardize the appearance of Template Toolkit files....

 Guide to Template Toolkit - Localization in Template Toolkit

Introduction Use localization in Template Toolkit files to produce dynamic interfaces in...

 Guide to Template Toolkit in cPanel & WHM

Introduction Template Toolkit is the main template system for the cPanel and WHM interfaces....

 Guide to Testing Custom Code

Introduction This guide explains the basics of how to test your custom code. You can avoid...

 Guide to Testing Custom Code - API Authentication

Introduction This guide explains the basics of how to test your custom code's authentication...

 Guide to Testing Custom Code - Standardized Hooks

Introduction This guide explains the basics of how to test Standardized Hookcode. This document...

 Guide to Testing Custom Code - WHM API Calls

Introduction This guide explains the basics of how to test calls to WHM API 0 or WHM API 1. This...

 Guide to Testing Custom Code - cPanel API and UAPI Calls

Introduction This guide explains the basics of how to test calls to cPanel API 1, cPanel API 2,...

 Guide to Testing Custom Code - cPanel Plugin Registration

Introduction This guide explains the basics of how to troubleshoot registration issues for...

 Guide to UAPI

Introduction UAPI accesses the cPanel interface's features. Use this API to access and modify...

 Guide to WHM Plugins

Introduction WHM plugins add new functionality to the WHM interface.Third-party developers can...

 Guide to WHM Plugins - ACL Reference Chart

Introduction cPanel & WHM ships with a default list of Access Control Lists (ACLs). Plugin...

 Guide to WHM Plugins - Access Control Lists

Introduction Access Control Lists (ACLs) limit the features that WHM users can access. Each ACL...

 Guide to WHM Plugins - AppConfig Registration

Introduction Use AppConfig to register plugins with the WHM interface. AppConfig registration...

 Guide to WHM Plugins - Custom ACLs

Introduction Plugin developers and server administrators can add custom ACLs. Custom ACLs can...

 Guide to WHM Plugins - The ACL Metadata Perl Module

Introduction The ACL metadata Perl module defines necessary functions for the ACL system. Create...

 Guide to WHM Plugins - The ACL Object Perl Module

Introduction The ACL object Perl module configures the ACL's namespace and display information....

 Guide to cPanel API 1

Introduction cPanel API 1 accesses information from the cPanel interface. Warning: cPanel...

 Guide to cPanel API 2

Introduction cPanel API 2 accesses cPanel account information and modifies settings. Notes:...

 Guide to cPanel Interface Customization

Introduction You can use several different methods to modify the appearance of the cPanel...

 Guide to cPanel Interface Customization - Apply Styles

Introduction For a style to display for a particular user in the cPanel interface, you must...

 Guide to cPanel Interface Customization - Custom Icons and Logos

Introduction You can add one or more custom icons or logos to your custom cPanel style.  If you...

 Guide to cPanel Interface Customization - The styles.css File

Introduction The styles.css file contains the CSS for each cPanel style. After you create the...

 Guide to cPanel Interface Customization - Troubleshoot Custom Styles

Introduction Use this document to troubleshoot your custom styles. Custom CSS does not render...

 Guide to cPanel Interface Customization - cPanel Style Development

Introduction You can develop custom styles that modify the appearance of the cPanel interface....

 Guide to cPanel Plugins

Introduction cPanel plugins add new functionality to the cPanel interface. Third-party...

 Guide to cPanel Plugins - Add Plugins to cPanel & WHM Version 11.42 and Earlier

Introduction cPanel & WHM version 11.42 and earlier requires you to manually add...

 Guide to cPanel Plugins - Add Plugins to cPanel & WHM Version 11.44 and Later

Introduction cPanel & WHM version 11.44 and later uses an install.json file to add icons and...

 Guide to cPanel Plugins - The dynamicui Files

Introduction cPanel's Home interface uses the dynamicui file system to display icons...

 Guide to cPanel Plugins - Uninstall Plugins

Introduction To uninstall plugins from cPanel & WHM, choose the uninstallation process...

 Guide to cPanel Variables

Introduction The LiveAPI system and dynamicui files can access cPanel's global variables. These...

 Guide to the LiveAPI System

Introduction The LiveAPI System provides environments for applications in cPanel's x3 theme....

 Guide to the LiveAPI System - LiveAPI Methods

Introduction The LiveAPI system uses the following methods to interact with cPanel & WHM....

 Guide to the LiveAPI System - PHP Class

Introduction The LiveAPI PHP Class provides an environment for PHP applications. You can find...

 Guide to the LiveAPI System - Perl Module

Introduction The LiveAPI Perl Module provides an environment for Perl applications. You can find...

 Guide to the LiveAPI System - The api() Method

Description The api() method executes a cPanel API 1 or cPanel API 2 function. Important:...

 Guide to the LiveAPI System - The cpanelfeature() Method

Description The cpanelfeature() method is a wrapper for the feature tag, which checks whether...

 Guide to the LiveAPI System - The cpanelif() Method

Description The cpanelif() method is a wrapper for the cpanelif tag, which evaluates a cPanel...

 Guide to the LiveAPI System - The cpanellangprint() Method

Description The cpanellangprint() method is a wrapper for the deprecated lang system's langprint...

 Guide to the LiveAPI System - The cpanelprint() Method

Description The cpanelprint() method returns  a cPanel variable's value. Warning: Despite...

 Guide to the LiveAPI System - The debug_log() Method

Description The debug_log() method writes data to the debugging log file. By default, LiveAPI...

 Guide to the LiveAPI System - The debug_log_json() Method

Description The debug_log_json() method writes JSON data to the debugging log file. By...

 Guide to the LiveAPI System - The end() Method

Description The end() method deconstructs the Cpanel::LiveAPI object and closes the connection...

 Guide to the LiveAPI System - The exec() Method

Description The exec() method executes a cPanel tag. Important: We strongly recommend that...

 Guide to the LiveAPI System - The fetch() Method

Description The fetch() method is a wrapper to return a hash reference from the  cpanelprint()...

 Guide to the LiveAPI System - The footer() Method

Description The footer() method calls the cPanel interface's footer. Use this method to add the...

 Guide to the LiveAPI System - The get_debug_level() Method

Description The get_debug_level() method retrieves the current debug level. Note: To set...

 Guide to the LiveAPI System - The get_debug_log() Method

Description The get_debug_log() method retrieves the debug log file's absolute path and...

 Guide to the LiveAPI System - The get_result() Method

Description The get_result() method fetches the most recent data result node. Note: This...

 Guide to the LiveAPI System - The header() Method

Description The header() method calls the cPanel interface's header. Use this method to add the...

 Guide to the LiveAPI System - The new() Method

Description The new() method instantiates the Cpanel::LiveAPI object. Only use this method...

 Guide to the LiveAPI System - The set_debug() Method

Description The set_debug() method sets the amount of debug information to store in LiveAPI's...

 Manage External Authentications

For cPanel & WHM version 58 Overview Manage credentials Additional documentation...

 Remote Access Key

For cPanel & WHM version 58 (Home >> Clusters >> Remote Access Key)...

 The cPanel Interface

For  cPanel  &  WHM  version  58 Overview The cPanel interface is...

 Tweak Settings

Tweak Settings   For cPanel & WHM version 58 ( Home >> Server...

 UAPI - Create Your Module

Introduction To create a custom module, you must first create the Module.pm file....

 UAPI - Custom Function Basics

Introduction Custom modules contain one or more individual functions. Warning: Make...

 UAPI - Custom UAPI Modules

Introduction You can add custom modules to cPanel & WHM and call them with UAPI. Warning:...

 UAPI - Filter Output

Introduction You can use additional parameters to filter UAPI output. Filter output UAPI...

 UAPI - Output Columns

Introduction You can use additional parameters to select the parameters to display in UAPI...

 UAPI - Paginate Output

Introduction You can use special variables to display UAPI output data in multiple pages...

 UAPI - Return Data

Introduction UAPI outputs data in JavaScript Object Notation (JSON). Note: You...

 UAPI - Sort Output

Introduction You can use additional parameters to sort UAPI output. Sort output UAPI...

 UAPI - The Cpanel::Args Object

Introduction UAPI modules use the Cpanel::Args object to receive arguments (input...

 UAPI - The Cpanel::Result Object

Introduction UAPI modules use the Cpanel::Result object to return messages and data.  When you...

 UAPI Functions - Backup::list_backups

Description This function lists the account's backup files. Examples   cPanel or...

 UAPI Functions - Bandwidth::get_retention_periods

Description This function retrieves the retention periods for bandwidth data. Examples...

 UAPI Functions - Bandwidth::query

Description This function queries an account's bandwidth data and returns a report....

 UAPI Functions - Batch::strict

Description This function combines calls for multiple UAPI functions and performs them in order....

 UAPI Functions - Brand::read

Description This function retrieves the cPanel account's branding information. For more...

 UAPI Functions - Branding::file

Description This function retrieves a branding file's path.  The function searches the...

 UAPI Functions - Branding::get_application_information

Description This function retrieves an application's information from the dynamicui.conf file....

 UAPI Functions - Branding::get_applications

Description This function retrieves an application's information from a specific theme's...

 UAPI Functions - Branding::get_available_applications

Description This function retrieves information about the groups and applications in the...

 UAPI Functions - Branding::get_information_for_applications

Description This function retrieves an application's information from a specific theme's...

 UAPI Functions - Branding::image

Description This function retrieves a branding image's URL. Examples   cPanel or...

 UAPI Functions - Branding::include

Description This function retrieves another file's contents for display. Warning: This...

 UAPI Functions - Branding::spritelist

Description This function retrieves a sprite URL. Sprites store the cPanel interface's icons as...

 UAPI Functions - CacheBuster::read

Description This function returns the current CacheBuster ID. Use this ID to work with and...

 UAPI Functions - CacheBuster::update

Description This function generates a random integer (the CacheBuster ID). Use this ID to work...

 UAPI Functions - Chkservd::get_exim_ports

Description This function lists the ports on which Exim listens. Examples   cPanel...

 UAPI Functions - Chkservd::get_exim_ports_ssl

Description This function retrieves Exim's SSL port. Examples   cPanel or Webmail...

 UAPI Functions - Chrome::get_dom

Description This function returns header and footer HTML. You can use this HTML to create a page...

 UAPI Functions - Contactus::is_enabled

Description This function checks whether the account's contact option is enabled. The contact...

 UAPI Functions - DAV::disable_shared_global_addressbook

Description This function disables the shared global address book for the current cPanel...

 UAPI Functions - DAV::enable_shared_global_addressbook

Description This function enables the shared global address book for the current cPanel...

 UAPI Functions - DAV::get_calendar_contacts_config

Description This function returns the connection information to set up the CalDAV and CardDAV...

 UAPI Functions - DAV::has_shared_global_addressbook

Description This function checks whether the shared global address book is enabled on the...

 UAPI Functions - DAV::is_dav_service_enabled

Description This function checks whether the DAV service is enabled. Examples...

 UAPI Functions - DAV::is_horde_enabled

Description This function checks whether Horde is enabled. Examples  cPanel or...

 UAPI Functions - DCV::ensure_domains_can_pass_dcv

Description This function indicates whether the account's domains can pass a Domain Control...

 UAPI Functions - DNS::ensure_domains_reside_only_locally

Description This function indicates whether the account's domains resolve exclusively to this...

 UAPI Functions - DomainInfo::domains_data

Description This function lists user data for the cPanel account's domains. Note: This...

 UAPI Functions - DomainInfo::list_domains

Description This function lists the cPanel account's domains. Note: For this function to...

 UAPI Functions - DomainInfo::single_domain_data

Description This function lists user data for a domain. Note: This function retrieves data...

 UAPI Functions - Email::account_name

Description This function returns an email account's username or address. Note: If you...

 UAPI Functions - Email::add_auto_responder

Description This function creates an autoresponder for an email account. Examples...

 UAPI Functions - Email::add_domain_forwarder

Description This function creates a domain-level forwarder. Examples   cPanel or...

 UAPI Functions - Email::add_forwarder

Description This function creates an email forwarder. Examples   cPanel or Webmail...

 UAPI Functions - Email::add_list

Description This function creates a Mailman mailing list. Examples   cPanel or...

 UAPI Functions - Email::add_mailman_delegates

Description This function grants mailing list administrative privileges to users. Examples...

 UAPI Functions - Email::add_mx

Description This function creates a Mail Exchanger (MX) record. For more information about MX...

 UAPI Functions - Email::add_pop

Description This function creates an email address. Examples   cPanel or Webmail...

 UAPI Functions - Email::add_spam_filter

Description This function sets a new minimum Apache SpamAssassin™ spam score. Examples...

 UAPI Functions - Email::browse_mailbox

Description This function lists the mail directory's subdirectories (boxes) and files....

 UAPI Functions - Email::change_mx

Description This function modifies a Mail Exchanger (MX) record. For more information about MX...

 UAPI Functions - Email::check_fastmail

Description This function checks whether BlackBerry® FastMail support is enabled. Examples...

 UAPI Functions - Email::check_pipe_forwarder

Description This function checks a program that receives forwarded mail. Examples...

 UAPI Functions - Email::delete_auto_responder

Description This function deletes an autoresponder. Examples   cPanel or Webmail...

 UAPI Functions - Email::delete_domain_forwarder

Description This function deletes a domain-level forwarder. Examples   cPanel or...

 UAPI Functions - Email::delete_filter

Description This function deletes an email filter. Examples   cPanel or Webmail...

 UAPI Functions - Email::delete_forwarder

Description This function deletes an email forwarder. Examples   cPanel or Webmail...

 UAPI Functions - Email::delete_list

Description This function deletes a Mailman mailing list. Examples   cPanel or...

 UAPI Functions - Email::delete_mx

Description This function deletes a Mail Exchanger (MX) record. For more information about MX...

 UAPI Functions - Email::delete_pop

Description This function deletes an email address. Examples   cPanel or Webmail...

 UAPI Functions - Email::disable_filter

Description This function disables an email filter. Examples   cPanel or Webmail...

 UAPI Functions - Email::disable_spam_assassin

Description This function disables Apache SpamAssassin™ for a cPanel account. Examples...

 UAPI Functions - Email::disable_spam_autodelete

Description This function disables the Apache SpamAssassin™ autodelete function. Examples...

 UAPI Functions - Email::edit_pop_quota

Description This function changes an email address's quota. Examples   cPanel or...

 UAPI Functions - Email::enable_filter

Description This function enables an email filter. Examples   cPanel or Webmail...

 UAPI Functions - Email::enable_spam_assassin

Description This function enables Apache SpamAssassin™ for the account. Examples...

 UAPI Functions - Email::enable_spam_autodelete

Description This function enables the Apache SpamAssassin™ autodelete function for the account....

 UAPI Functions - Email::fetch_charmaps

Description This function lists the available character encodings. Examples...

 UAPI Functions - Email::generate_mailman_otp

Description This function generates a one-time password (OTP) for a mailing list. Note:...

 UAPI Functions - Email::get_auto_responder

Description This function retrieves autoresponder information. Examples   cPanel...

 UAPI Functions - Email::get_charsets

Description This function lists character encodings that the mail server supports. Examples...

 UAPI Functions - Email::get_default_email_quota

Description This function retrieves the system's default email quota. Examples...

 UAPI Functions - Email::get_disk_usage

Description This function retrieves the disk space that an email account uses. Examples...

 UAPI Functions - Email::get_filter

Description This function retrieves an email filter's information. Examples...

 UAPI Functions - Email::get_mailman_delegates

Description This function lists a mailing list's administrators. Examples   cPanel...

 UAPI Functions - Email::get_main_account_disk_usage

Description This function returns the disk space that the main account uses. Examples...

 UAPI Functions - Email::get_max_email_quota

Description This function retrieves the system's maximum email quota. Examples...

 UAPI Functions - Email::get_pop_quota

Description This function retrieves an email account's quota. Examples   cPanel or...

 UAPI Functions - Email::get_spam_settings

Description This function retrieves the Apache SpamAssassin™ settings for the account....

 UAPI Functions - Email::get_webmail_settings

Description This function retrieves an email account's Webmail settings. Examples...

 UAPI Functions - Email::has_delegated_mailman_lists

Description This function checks an account's administrative privileges on mailing lists....

 UAPI Functions - Email::has_plaintext_authentication

Description This function checks whether plaintext authentication is enabled on the Dovecot mail...

 UAPI Functions - Email::is_integer

Description This function is deprecated and does not return useful output. Examples...

 UAPI Functions - Email::list_auto_responders

Description This function lists a domain's autoresponders. Examples   cPanel or...

 UAPI Functions - Email::list_default_address

Description This function retrieves a domain's default address. Examples   cPanel...

 UAPI Functions - Email::list_domain_forwarders

Description This function lists domain-level forwarders. Examples   cPanel or...

 UAPI Functions - Email::list_filters

Description This function lists account-level mail filters. For more information about Exim...

 UAPI Functions - Email::list_filters_backups

Description This function lists all of the cPanel account's domains that use domain-level...

 UAPI Functions - Email::list_forwarders

Description This function lists a domain's forwarders. Examples   cPanel or...

 UAPI Functions - Email::list_forwarders_backups

Description This function lists the domains with domain-level forwarders. Examples...

 UAPI Functions - Email::list_lists

Description This function lists the account's Mailman mailing lists. Examples...

 UAPI Functions - Email::list_mail_domains

Description This function lists the account's mail domains. Examples  cPanel or...

 UAPI Functions - Email::list_mxs

Description This function lists Mail Exchanger (MX) records. Examples   cPanel or...

 UAPI Functions - Email::list_pops

Description This function lists the cPanel account's email accounts. Examples...

 UAPI Functions - Email::list_pops_with_disk

Description This function lists the cPanel account's email accounts with disk information....

 UAPI Functions - Email::list_system_filter_info

Description This function retrieves a .yaml.gz file that contains system-level filter...

 UAPI Functions - Email::passwd_list

Description This function changes a mailing list's password. Examples   cPanel or...

 UAPI Functions - Email::passwd_pop

Description This function changes an email account's password. Examples   cPanel...

 UAPI Functions - Email::remove_mailman_delegates

Description This function removes an account's mailing list administrative privileges....

 UAPI Functions - Email::reorder_filters

Description This function modifies the filter order for an email address.  For more information...

 UAPI Functions - Email::set_always_accept

Description This function sets the Mail Exchanger (MX) type. Note: This function only...

 UAPI Functions - Email::set_default_address

Description This function configures a default (catchall) email address. Examples...

 UAPI Functions - Email::set_list_privacy_options

Description This function modifies a Mailman mailing list's privacy options. Examples...

 UAPI Functions - Email::store_filter

Description This function creates a new email filter. For more information about Exim filters,...

 UAPI Functions - Email::suspend_incoming

Description This function suspends incoming email for an account. The system will reject...

 UAPI Functions - Email::suspend_login

Description This function suspends a user's ability to log in to, send mail from, and read their...

 UAPI Functions - Email::trace_filter

Description This function tests mail filters. The function only tests filters for the cPanel...

 UAPI Functions - Email::unsuspend_incoming

Description This function unsuspends incoming email for an email account. Examples...

 UAPI Functions - Email::verify_password

Description This function verifies the password for an email account. Examples...

 UAPI Functions - ExternalAuthentication::add_authn_link

Description This function adds an External Authentication authorization link to an account....

 UAPI Functions - ExternalAuthentication::configured_modules

Description This function lists the display information for your server's available and...

 UAPI Functions - ExternalAuthentication::get_authn_links

Description This function lists the external authentication links to the current cPanel account....

 UAPI Functions - ExternalAuthentication::remove_authn_link

Description This function removes a link to an account at an external authentication identity...

 UAPI Functions - Features::has_feature

Description This function checks whether an account has a feature installed. Examples...

 UAPI Functions - Features::list_features

Description This function lists an account's features. Examples   cPanel or...

 UAPI Functions - Fileman::autocompletedir

Description This function returns any files and directories that begin with a specified string....

 UAPI Functions - Fileman::get_file_content

Description This function retrieves a file's content. Examples  cPanel or Webmail...

 UAPI Functions - Fileman::get_file_information

Description This function returns the information for a specified file or directory....

 UAPI Functions - Fileman::list_files

Description This function returns a sorted list of files and directories. Examples...

 UAPI Functions - Fileman::save_file_content

Description This function saves a file in a directory and encodes it in a character set....

 UAPI Functions - Fileman::transcode

Description This function converts a buffer from one encoding language to another. Examples...

 UAPI Functions - Fileman::upload_files

Description This function uploads files. Examples  cPanel or Webmail Session...

 UAPI Functions - Ftp::add_ftp

Description This function creates an FTP account. Examples   cPanel or Webmail...

 UAPI Functions - Ftp::allows_anonymous_ftp

Description This function checks whether the account allows anonymous FTP connections....

 UAPI Functions - Ftp::allows_anonymous_ftp_incoming

Description This function checks whether the account allows inbound anonymous FTP transfers....

 UAPI Functions - Ftp::delete_ftp

Description This function deletes an FTP account. Examples   cPanel or Webmail...

 UAPI Functions - Ftp::ftp_exists

Description This function checks whether an FTP account exists. Note: This function does...

 UAPI Functions - Ftp::get_ftp_daemon_info

Description This function retrieves the extended information about the server's FTP daemon....

 UAPI Functions - Ftp::get_port

Description This function returns the FTP port. Examples   cPanel or Webmail...

 UAPI Functions - Ftp::get_quota

Description This function checks an FTP account's quota. Examples   cPanel or...

 UAPI Functions - Ftp::get_welcome_message

Description This function retrieves the cPanel account's FTP welcome message. Examples...

 UAPI Functions - Ftp::kill_session

Description This function kills FTP sessions. Examples   cPanel or Webmail Session...

 UAPI Functions - Ftp::list_ftp

Description This function lists FTP account information. Examples   cPanel or...

 UAPI Functions - Ftp::list_ftp_with_disk

Description This function lists FTP account and disk usage information. Examples...

 UAPI Functions - Ftp::list_sessions

Description This function lists the FTP server's active sessions. Examples...

 UAPI Functions - Ftp::passwd

Description This function changes an FTP account's password. Examples   cPanel or...

 UAPI Functions - Ftp::server_name

Description This function checks whether the server uses ProFTPD or Pure-FTPd. Examples...

 UAPI Functions - Ftp::set_anonymous_ftp

Description This function enables or disables anonymous FTP logins. Examples...

 UAPI Functions - Ftp::set_anonymous_ftp_incoming

Description This function enables or disables inbound anonymous FTP transfers. Examples...

 UAPI Functions - Ftp::set_homedir

Description This function changes the home directory for FTP accounts. Examples...

 UAPI Functions - Ftp::set_quota

Description This function changes an FTP account's quota. Examples   cPanel or...

 UAPI Functions - Ftp::set_welcome_message

Description This function sets the FTP welcome message. Examples   cPanel or...

 UAPI Functions - Integration::fetch_url

Description This function returns the URL for an integrated application. Examples...

 UAPI Functions - LangPHP::php_get_installed_versions

Description This function lists the system's PHP versions. Note: This document only...

 UAPI Functions - LangPHP::php_get_system_default_version

Description This function lists the system's default PHP version. Note: This document only...

 UAPI Functions - LangPHP::php_get_vhost_versions

Description This function returns the PHP version of every virtual host that a reseller...

 UAPI Functions - LangPHP::php_ini_get_user_basic_directives

Description This function lists a virtual host's basic PHP directives. The Basic Mode section of...

 UAPI Functions - LangPHP::php_ini_get_user_content

Description This function returns the contents of a virtual host's php.ini file. Note:...

 UAPI Functions - LangPHP::php_ini_get_user_paths

Description This function lists the php.ini file paths for the user's home directory and virtual...

 UAPI Functions - LangPHP::php_ini_set_user_basic_directives

Description This function sets the values of any basic PHP directive. The Basic Mode section of...

 UAPI Functions - LangPHP::php_ini_set_user_content

Description This function changes the contents of a virtual host's php.ini file. Note:...

 UAPI Functions - LangPHP::php_set_vhost_versions

Description This function sets a virtual host's PHP version. Note: This document only...

 UAPI Functions - Locale::get_attributes

Description This function retrieves information about the user's current locale setting....

 UAPI Functions - Market::cancel_pending_ssl_certificate

Description This function cancels an order and removes the polling for a pending certificate....

 UAPI Functions - Market::get_all_products

Description This function lists all products available through all enabled cPanel Market...

 UAPI Functions - Market::get_login_url

Description This function retrieves the login URL for the cPanel Market provider. Examples...

 UAPI Functions - Market::get_pending_ssl_certificates

Description This function lists all pending SSL certificates from a cPanel Market provider for...

 UAPI Functions - Market::get_providers_list

Description This function lists the names of enabled cPanel Market providers. Examples...

 UAPI Functions - Market::get_ssl_certificate_if_available

Description This function retrieves SSL certificates when they are available from the cPanel...

 UAPI Functions - Market::process_ssl_pending_queue

Description This function manually processes the cPanel Market's SSL certificate pending queue....

 UAPI Functions - Market::set_status_of_pending_queue_items

Description This function sets the status of an item or items in the cPanel Market pending...

 UAPI Functions - Market::set_url_after_checkout

Description This function updates the URL to which a provider sends a user after they check out....

 UAPI Functions - Market::validate_login_token

Description This function validates a login token to a cPanel Market provider and returns an...

 UAPI Functions - Mime::add_handler

Description This function creates an Apache MIME type handler for a file extension....

 UAPI Functions - Mime::add_hotlink

Description This function adds hotlink protection for a site. Hotlink protection will redirect...

 UAPI Functions - Mime::add_mime

Description This function adds a MIME type to Apache. Examples   cPanel or Webmail...

 UAPI Functions - Mime::add_redirect

Description This function adds a redirect to a domain. Examples   cPanel or...

 UAPI Functions - Mime::delete_handler

Description This function deletes an Apache MIME type handler. Examples...

 UAPI Functions - Mime::delete_hotlink

Description This function removes hotlink protection. Examples   cPanel or...

 UAPI Functions - Mime::delete_mime

Description This function removes a MIME type from Apache. Examples   cPanel or...

 UAPI Functions - Mime::delete_redirect

Description This function removes a redirect from a domain. Examples   cPanel or...

 UAPI Functions - Mime::list_handlers

Description This function lists all of Apache's MIME handlers. Examples   cPanel...

 UAPI Functions - Mime::list_hotlinks

Description This function lists domains with hotlink protection. Examples   cPanel...

 UAPI Functions - Mime::list_mime

Description This function lists all of Apache's MIME types. Examples   cPanel or...

 UAPI Functions - Mime::list_redirects

Description This function lists the redirects in an account's .htaccess files. Examples...

 UAPI Functions - Mime::redirect_info

Description This function retrieves redirect information for a URL or ** All Public Domains **....

 UAPI Functions - ModSecurity::disable_all_domains

Description This function disables ModSecurity™ on a cPanel account's domains. Examples...

 UAPI Functions - ModSecurity::disable_domains

Description This function disables ModSecurity™ on specified domains. Examples...

 UAPI Functions - ModSecurity::enable_all_domains

Description This function enables ModSecurity™ on a cPanel account's domains. Examples...

 UAPI Functions - ModSecurity::enable_domains

Description This function enables ModSecurity™ for specified domains. Examples...

 UAPI Functions - ModSecurity::has_modsecurity_installed

Description This function checks whether ModSecurity™ is installed on a server. Examples...

 UAPI Functions - ModSecurity::list_domains

Description This function returns ModSecurity's™ status for a cPanel account's domains....

 UAPI Functions - Mysql::add_host

Description This function authorizes a remote MySQL® host to access the account's databases....

 UAPI Functions - Mysql::check_database

Description This function checks all of the tables a MySQL® database for errors. Examples...

 UAPI Functions - Mysql::create_database

Description This function creates a MySQL® database. Examples   cPanel or Webmail...

 UAPI Functions - Mysql::create_user

Description This function creates a MySQL® database user. Examples  cPanel or...

 UAPI Functions - Mysql::delete_database

Description This function deletes a MySQL® database. Examples   cPanel or Webmail...

 UAPI Functions - Mysql::delete_host

Description This function removes a remote MySQL® host's access to the account's databases....

 UAPI Functions - Mysql::delete_user

Description This function deletes a MySQL® user. Examples   cPanel or Webmail...

 UAPI Functions - Mysql::get_privileges_on_database

Description This function lists a MySQL® database user's privileges. Examples...

 UAPI Functions - Mysql::get_restrictions

Description This function lists a MySQL® database's name, username length restrictions, and...

 UAPI Functions - Mysql::get_server_information

Description This function returns information about the account's MySQL® host. Examples...

 UAPI Functions - Mysql::locate_server

Description This function returns information about the account's MySQL® host. Examples...

 UAPI Functions - Mysql::rename_database

Description This function renames a MySQL® database. Warning: It is potentially dangerous...

 UAPI Functions - Mysql::rename_user

Description This function renames a MySQL® database user. Examples  cPanel or...

 UAPI Functions - Mysql::repair_database

Description This function repairs all of the tables in a MySQL® database. Examples...

 UAPI Functions - Mysql::revoke_access_to_database

Description This function revokes a MySQL® database user's privileges. Examples...

 UAPI Functions - Mysql::set_password

Description This function sets a MySQL® database user's password. Examples...

 UAPI Functions - Mysql::set_privileges_on_database

Description This function sets a MySQL® database user's privileges. Examples...

 UAPI Functions - NVData::get

Description This function retrieves an environment variable's value. Examples...

 UAPI Functions - NVData::set

Description This function creates a non-volatile datastore. The system creates the datastore in...

 UAPI Functions - Notifications::get_notifications_count

Description This function returns the number of server-wide notifications on an account....

 UAPI Functions - Parser::firstfile_relative_uri

Description This function reports the first file's URI, relative to the cPanel base directory....

 UAPI Functions - PasswdStrength::get_required_strength

Description This function retrieves an application's minimum required password strength....

 UAPI Functions - Postgresql::create_database

Description This function creates a PostgreSQL® database. Examples   cPanel or...

 UAPI Functions - Postgresql::create_user

Description This function creates a PostgreSQL® database user. Examples  cPanel or...

 UAPI Functions - Postgresql::delete_database

Description This function deletes a PostgreSQL database. Examples  cPanel or...

 UAPI Functions - Postgresql::get_restrictions

Description This function retrieves the PostgreSQL® user and database name length restrictions....

 UAPI Functions - Postgresql::grant_all_privileges

Description This function grants all privileges for a PostgreSQL® database to a database user....

 UAPI Functions - Postgresql::rename_database

Description This function renames a PostgreSQL® database. Examples   cPanel or...

 UAPI Functions - Postgresql::rename_user

Description This function renames a PostgreSQL® database user. Examples  cPanel or...

 UAPI Functions - Postgresql::rename_user_no_password

Description This function renames a PostgreSQL® database user. Warnings: If you rename...

 UAPI Functions - Postgresql::revoke_all_privileges

Description This function revokes all privileges for a PostgreSQL® database from a database...

 UAPI Functions - Postgresql::set_password

Description This function changes a PostgreSQL® database user's password. Examples...

 UAPI Functions - Pushbullet::send_test_message

Description This function sends a Pushbullet™ test message to determine that the token is valid...

 UAPI Functions - Quota::get_quota_info

Description This function retrieves the cPanel user's quota. Examples  cPanel or...

 UAPI Functions - Resellers::list_accounts

Description This function lists all of a reseller's cPanel accounts. Examples...

 UAPI Functions - SSH::get_port

Description This function retrieves the server's SSH port. Examples   cPanel or...

 UAPI Functions - SSL::check_shared_cert

Description This function checks whether a shared SSL certificate is associated with the...

 UAPI Functions - SSL::delete_cert

Description This function deletes an SSL certificate. Examples  cPanel or Webmail...

 UAPI Functions - SSL::delete_csr

Description This function deletes a Certificate Signing Request (CSR). Examples...

 UAPI Functions - SSL::delete_key

Description This function deletes a private key. Examples   cPanel or Webmail...

 UAPI Functions - SSL::delete_ssl

Description This function removes SSL from a domain. Examples   cPanel or Webmail...

 UAPI Functions - SSL::disable_mail_sni

Description This function disables SNI mail services on the specified domains. Note: After...

 UAPI Functions - SSL::enable_mail_sni

Description This function enables SNI mail services on the specified domains. Warning:...

 UAPI Functions - SSL::fetch_best_for_domain

Description This function retrieves the best-available certificate for the domain. The function...

 UAPI Functions - SSL::fetch_cert_info

Description This function retrieves all of a certificate's available information. Examples...

 UAPI Functions - SSL::fetch_key_and_cabundle_for_certificate

Description This function extracts the private key and CA bundle information from a certificate....

 UAPI Functions - SSL::find_certificates_for_key

Description This function retrieves SSL certificates for a private key. Examples...

 UAPI Functions - SSL::find_csrs_for_key

Description This function retrieves certificate signing requests (CSR) for a private key....

 UAPI Functions - SSL::generate_cert

Description This function generates a self-signed SSL certificate. Examples...

 UAPI Functions - SSL::generate_csr

Description This function generates a Certificate Signing Request (CSR). Note: This...

 UAPI Functions - SSL::generate_key

Description This function generates a private key. Examples   cPanel or Webmail...

 UAPI Functions - SSL::get_cabundle

Description This function retrieves a certificate's CA bundle and hostname. Examples...

 UAPI Functions - SSL::get_cn_name

Description This function retrieves the best domain to use for SSL for a service. Examples...

 UAPI Functions - SSL::install_ssl

Description This function installs an SSL certificate. Note: Due to their inherent...

 UAPI Functions - SSL::installed_host

Description This function retrieves information about a certificate that is installed on a...

 UAPI Functions - SSL::is_mail_sni_supported

Description This function checks whether the sslinstall feature is enabled. Warning: Mail...

 UAPI Functions - SSL::is_sni_supported

Description This function checks whether the Apache web server supports SNI. Examples...

 UAPI Functions - SSL::list_certs

Description This function lists an account's certificates. Examples  cPanel or...

 UAPI Functions - SSL::list_csrs

Description This function lists an account's Certificate Signing Requests (CSR). Examples...

 UAPI Functions - SSL::list_keys

Description This function lists an account's private keys. Examples   cPanel or...

 UAPI Functions - SSL::list_ssl_items

Description This function lists SSL-related items on a domain. Examples   cPanel...

 UAPI Functions - SSL::mail_sni_status

Description This function retrieves the status of the domain's SNI mail services. Warning:...

 UAPI Functions - SSL::rebuild_mail_sni_config

Description This function rebuilds the SNI configuration files. Note: You must run this...

 UAPI Functions - SSL::rebuildssldb

Description This function rebuilds the account's SSL database. Examples   cPanel...

 UAPI Functions - SSL::set_cert_friendly_name

Description This function changes a certificate's friendly name. Examples   cPanel...

 UAPI Functions - SSL::set_csr_friendly_name

Description This function changes a certificate signing request's (CSR) friendly name....

 UAPI Functions - SSL::set_key_friendly_name

Description This function changes a key's friendly name. Examples   cPanel or...

 UAPI Functions - SSL::set_primary_ssl

Description This function sets a new primary SSL website for a dedicated IP address....

 UAPI Functions - SSL::set_ssl_share

Description This function shares and unshares the account's SSL certificate. Examples...

 UAPI Functions - SSL::show_cert

Description This function retrieves a certificate. Examples  cPanel or Webmail...

 UAPI Functions - SSL::show_csr

Description This function retrieves a Certificate Signing Request (CSR). Examples...

 UAPI Functions - SSL::show_key

Description This function retrieves a private key. Examples   cPanel or Webmail...

 UAPI Functions - SSL::upload_cert

Description This function uploads a certificate. Note: Due to the limited field length of...

 UAPI Functions - SSL::upload_key

Description This function uploads a private key. Note: Due to the limited field length of...

 UAPI Functions - Session::create_temp_user

Description This function creates a temporary user session. In earlier versions of cPanel &...

 UAPI Functions - SiteTemplates::list_site_templates

Description This function lists available templates for cPanel's Site Publisher feature. If...

 UAPI Functions - SiteTemplates::list_user_settings

Description This function lists information for the cPanel account's Site Publisher websites....

 UAPI Functions - SiteTemplates::publish

Description This function publishes a  Site Publisher  website. This function uses the...

 UAPI Functions - StatsBar::get_stats

Description This function retrieves a cPanel account's statistics. Examples...

 UAPI Functions - Styles::current

Description This function returns the user's current style. Examples   cPanel or...

 UAPI Functions - Styles::list

Description This function lists information about reseller account's available styles....

 UAPI Functions - Styles::set_default

Description This function sets a customer's default style. Examples   cPanel or...

 UAPI Functions - Styles::update

Description This function applies a new style to the cPanel interface. Examples...

 UAPI Functions - Themes::get_theme_base

Description This function returns the cPanel account's base theme. If you have modified the...

 UAPI Functions - Themes::list

Description This function lists available themes. Examples   cPanel or Webmail...

 UAPI Functions - Themes::update

Description This function applies a new style to the cPanel interface. Examples...

 UAPI Functions - TwoFactorAuth::generate_user_configuration

Description This function generates an authentication code to enable configuration of two-factor...

 UAPI Functions - TwoFactorAuth::get_user_configuration

Description This function retrieves the user's configuration settings for two-factor...

 UAPI Functions - TwoFactorAuth::remove_user_configuration

Description This function removes removes the user from the two-factor authentication userdata...

 UAPI Functions - TwoFactorAuth::set_user_configuration

Description This function configures the two-factor authentication settings for an account....

 UAPI Functions - UserManager::check_account_conflicts

Description This function lists the other subaccounts or services accounts that conflict with...

 UAPI Functions - UserManager::create_user

Description This function creates a subaccount. Examples  cPanel or Webmail...

 UAPI Functions - UserManager::delete_user

Description This function deletes a subaccount. This function returns only metadata if no other...

 UAPI Functions - UserManager::dismiss_merge

Description This function removes a service account as a link candidate to create a subaccount...

 UAPI Functions - UserManager::edit_user

Description This function edits a subaccount. Examples   cPanel or Webmail Session...

 UAPI Functions - UserManager::list_users

Description This function lists the cPanel account's subaccounts. Examples...

 UAPI Functions - UserManager::lookup_user

Description This function lists a single subaccount. Examples   cPanel or Webmail...

 UAPI Functions - UserManager::merge_service_account

Description This function links service accounts to subaccounts and creates a subaccount if one...

 UAPI Functions - UserManager::unlink_service_account

Description This function unlinks a service account from a subaccount. Examples...

 UAPI Functions - WebDisk::set_homedir

Description This function changes the home directory for a Web Disk account. Examples...

 UAPI Functions - WebDisk::set_password

Description This function changes the Web Disk account's password. Examples...

 UAPI Functions - WebDisk::set_permissions

Description This function changes the Web Disk home directory's permissions. Examples...

 UAPI Functions - WebVhosts::list_domains

Description This function lists virtual host names for each domain. Examples...

 UAPI Functions - Webmailapps::listwebmailapps

Description This function lists the account's available webmail clients. Examples...

 UAPI Functions - cPAddons::get_available_addons

Description This function lists an account's available cPAddons. Examples   cPanel...

 UAPI Functions - cPGreyList::disable_all_domains

Description This function disables Greylisting on a cPanel account's domains. Examples...

 UAPI Functions - cPGreyList::disable_domains

Description This function disables Greylisting on a cPanel account's selected domains....

 UAPI Functions - cPGreyList::enable_all_domains

Description This function enables Greylisting on all of the cPanel account's domains....

 UAPI Functions - cPGreyList::has_greylisting_enabled

Description This function checks whether Greylisting is enabled for the cPanel account....

 UAPI Functions - cPGreyList::list_domains

Description This function returns Greylisting's status for a cPanel account's domains....

 Use WHM API to Call cPanel API & UAPI

Introduction You can call cPanel API and UAPI functions through the WHM API. Note: We...

 User Preferences

For cPanel & WHM version 58 Overview This document outlines how to access your cPanel...

 WHM API 1 Functions - create_user_session

Description This function creates a new temporary user session for a specified service. This...

 What is cPanelID?

In This Article:  Overview ServicesHow to get a cPanelID cPanelID External...

 cPanel API 1 - Deprecated cPanel Tag Usage

Introduction  The deprecated cPanel tag system used the <cpanel > HTML tag to call cPanel...

 cPanel API 1 - Return Data

Introduction   Warning: cPanel API 1 is deprecated. We strongly recommend that you use...

 cPanel API 1 Functions - Bandwidth::displaybw

Description This function generates bandwidth data for the specified day. Warning: We...

 cPanel API 1 Functions - Bandwidth::displaybwheader

Description This function generates a monthly bandwidth graph. Warning: We removed this...

 cPanel API 1 Functions - Bandwidth::displayday

Description This function generates bandwidth graphs for the specified day. Warning: We...

 cPanel API 1 Functions - Bandwidth::displaymainbwheader

Description This function generates bandwidth graphs for the current day, week, and year....

 cPanel API 1 Functions - BoxTrapper::changestatus

  Description This function enables or disables BoxTrapper for an email account.  Warning:...

 cPanel API 1 Functions - BoxTrapper::cleancfgfilelist

Description This function corrects common BoxTrapper configuration file issues. When you run...

 cPanel API 1 Functions - BoxTrapper::editmsg

Description This function checks for a BoxTrapper form letter file. If the specified file is not...

 cPanel API 1 Functions - BoxTrapper::fetchcfgfile

Description This function prints the contents of a BoxTrapper configuration file or form letter....

 cPanel API 1 Functions - BoxTrapper::getboxconfdir

Description This function returns the path to an account's BoxTrapper configuration directory....

 cPanel API 1 Functions - BoxTrapper::listmsgs

Description This function generates an HTML form to edit BoxTrapper's form letters. Warning:...

 cPanel API 1 Functions - BoxTrapper::logcontrols

Description This function generates HTML links to BoxTrapper logs. Warning: cPanel API 1...

 cPanel API 1 Functions - BoxTrapper::messageaction

Description This function performs an action on a message in the BoxTrapper queue. Warning:...

 cPanel API 1 Functions - BoxTrapper::resetmsg

Description This function resets a BoxTrapper form letter to its default contents. Warning:...

 cPanel API 1 Functions - BoxTrapper::savecfgfile

Description This function saves a string to a BoxTrapper configuration file or form letter....

 cPanel API 1 Functions - BoxTrapper::saveconf

Description This function modifies an account's BoxTrapper configuration. Warning: cPanel...

 cPanel API 1 Functions - BoxTrapper::showautowhitelist

Description This function checks whether BoxTrapper automatic whitelisting is enabled for an...

 cPanel API 1 Functions - BoxTrapper::showemails

Description This function returns BoxTrapper's list of email addresses that send email to an...

 cPanel API 1 Functions - BoxTrapper::showfromname

Description This function returns the From: name that the account's BoxTrapper form letters use....

 cPanel API 1 Functions - BoxTrapper::showlog

Description This function returns the account's BoxTrapper log. Warning: cPanel API 1 is...

 cPanel API 1 Functions - BoxTrapper::showmessage

Description This function returns the first 200 lines of an email in the BoxTrapper queue....

 cPanel API 1 Functions - BoxTrapper::showqueue

Description This function generates a list of messages in the BoxTrapper queue. Warning:...

 cPanel API 1 Functions - BoxTrapper::showqueuesearch

Description This function searches the account's BoxTrapper queue. Warning: cPanel API 1...

 cPanel API 1 Functions - BoxTrapper::showqueuetime

Description This function checks the number of days to retain messages in the BoxTrapper queue....

 cPanel API 1 Functions - BoxTrapper::status

Description This function checks BoxTrapper's status for an account. Warning:   cPanel...

 cPanel API 1 Functions - BoxTrapper::statusbutton

Description This function generates HTML for a button that enables or disables BoxTrapper....

 cPanel API 1 Functions - Branding::file

Description This function searches for a file within a theme and returns its URL. Warning:...

 cPanel API 1 Functions - Branding::image

Description This function displays a branding image's URL. Warning: cPanel API 1 is...

 cPanel API 1 Functions - Branding::killimg

Description This function removes an image from a branding package. Warning: cPanel API 1...

 cPanel API 1 Functions - Branding::setbrandingpkg

Description This function changes an account's branding package. Warning: cPanel API 1 is...

 cPanel API 1 Functions - Branding::setmyacctspkg

Description This function changes the branding package for a reseller and the reseller's...

 cPanel API 1 Functions - Branding::setupdirs

Description This function creates an account's /cpanelbranding directory and subdirectories, and...

 cPanel API 1 Functions - Branding::tempsetbrandingpkg

 cPanel API 1 Functions - Branding::tempsetbrandingpkg

Description This function temporarily changes an account's branding package. Warning:...

 cPanel API 1 Functions - Cgi::backuplink

Description This function retrieves the most recent backup's URL. Warning: cPanel API 1 is...

 cPanel API 1 Functions - Cgi::displayurchin

Description This function retrieves a domain's Urchin statistics, if Urchin is installed for...

 cPanel API 1 Functions - Cgi::phpmyadminlink

  Description This function retrieves the link to phpMyAdmin. Warning: cPanel API 1 is...

 cPanel API 1 Functions - Chkservd::geteximport

Description This function retrieves the port on which Exim listens. Warning: cPanel API 1...

 cPanel API 1 Functions - Chkservd::geteximport_ssl

Description This function retrieves Exim's non-SSL port number (465). Warning: cPanel API...

 cPanel API 1 Functions - ClamScanner::bars

Description This function initiates a ClamAV virus scan. Warning: cPanel API 1 is...

 cPanel API 1 Functions - Cron::crontab_perms

Description This function returns a warning if the permissions for the /usr/bin/crontab file are...

 cPanel API 1 Functions - CustInfo::getemail

Description This function retrieves the account's contact email addresses. Warning: cPanel...

 cPanel API 1 Functions - DenyIp::adddenyip

Description This function adds a deny from IP line to the account's .htaccess file. Warning:...

 cPanel API 1 Functions - DenyIp::deldenyip

Description This function removes a deny from IP line from the account's .htaccess file....

 cPanel API 1 Functions - DiskUsage::showmanager

Description This function displays the HTML for cPanel's Disk Space Usage interface (Home...

 cPanel API 1 Functions - Email::addautoresponder

Description This function creates an autoresponder for an email account. Note: This...

 cPanel API 1 Functions - Email::addfilter

Description This function adds an account-wide email filter. Warning: cPanel API 1 is...

 cPanel API 1 Functions - Email::addforward

Description This function adds a domain-level email forwarder. Warning: cPanel API 1 is...

 cPanel API 1 Functions - Email::addlist

  Description   This function adds a Mailman mailing list.   Warning: cPanel API 1 is...

 cPanel API 1 Functions - Email::addmx

Description This function adds an MX entry to a domain's DNS zone file. Warning: cPanel...

 cPanel API 1 Functions - Email::addpop

Description This function adds an email account. Warning: cPanel API 1 is deprecated. Do...

 cPanel API 1 Functions - Email::addspam

Description This function enables Apache SpamAssassin™ for a cPanel account. Warning:...

 cPanel API 1 Functions - Email::addspambox

Description This function enables the Apache SpamAssassin™ Spam Box for a cPanel account....

 cPanel API 1 Functions - Email::addspamfilter

Description This function modifies the minimum Apache SpamAssassin™ spam score. Warning:...

 cPanel API 1 Functions - Email::changemx

Description This function modifies a mail exchanger's settings. Warning: cPanel API 1 is...

 cPanel API 1 Functions - Email::checkfastmail

Description This function sets the fastmail cPvariable to indicate whether BlackBerry™ FastMail...

 cPanel API 1 Functions - Email::checkpipefwd

Description This function checks whether a pipe or a shebang should precede a script that...

 cPanel API 1 Functions - Email::clearspambox

Description This function clears the spambox for each of a cPanel account's email addresses....

 cPanel API 1 Functions - Email::delautoresponder

Description This function deletes an autoresponder. Warning: cPanel API 1 is deprecated....

 cPanel API 1 Functions - Email::deldforward

Description This function deletes a domain-level email forwarder. Warning: cPanel API 1 is...

 cPanel API 1 Functions - Email::delfilter

Description This function deletes an email filter. Warning: cPanel API 1 is deprecated. Do...

 cPanel API 1 Functions - Email::dellist

Description This function deletes a Mailman mailing list. Warning: cPanel API 1 is...

 cPanel API 1 Functions - Email::delmx

Description This function deletes a mail exchanger. Warning: cPanel API 1 is deprecated....

 cPanel API 1 Functions - Email::delpop

Description This function deletes an email account. Warning: cPanel API 1 is deprecated....

 cPanel API 1 Functions - Email::delspam

Description This function disables Apache SpamAssassin™ for a cPanel account. Warning:...

 cPanel API 1 Functions - Email::delspambox

Description This function disables the Apache SpamAssassin™ Spam Box for a cPanel account....

 cPanel API 1 Functions - Email::disable_spam_autodelete

Description This function disables the Apache SpamAssassin™ auto-delete spam feature....

 cPanel API 1 Functions - Email::editquota

Description This function modifies an email account's quota. Warning: cPanel API 1 is...

 cPanel API 1 Functions - Email::enable_spam_autodelete

Description This function enables the Apache SpamAssassin™ auto-delete spam feature. Warning:...

 cPanel API 1 Functions - Email::getaging

Description This function checks an email account's aging setting. Warning: cPanel API 1...

 cPanel API 1 Functions - Email::getarsbody

Description This function retrieves the body field for an autoresponder message. Warning:...

 cPanel API 1 Functions - Email::getarscharset

Description This function retrieves an autoresponder message's character set. Warning:...

 cPanel API 1 Functions - Email::getarsfrom

Description This function retrieves an autoresponder message's from field. Warning: cPanel...

 cPanel API 1 Functions - Email::getarshtml

Description This function returns an autoresponder message's HTML body. Warning: cPanel...

 cPanel API 1 Functions - Email::getarsinterval

Description This function retrieves an autoresponder's interval setting. The interval setting...

 cPanel API 1 Functions - Email::getarsstart

Description This function retrieves an autoresponder's start time. Warning: cPanel API 1...

 cPanel API 1 Functions - Email::getarsstop

Description This function retrieves an autoresponder's stop time. Warning: cPanel API 1 is...

 cPanel API 1 Functions - Email::getarssubject

Description This function retrieves an autoresponder message's subject field. Warning:...

 cPanel API 1 Functions - Email::getmailserver

Description This function retrieves an account's mail server name. Warning: cPanel API 1...

 cPanel API 1 Functions - Email::getmailserveruser

Description This function retrieves the username that an account uses to authenticate with the...

 cPanel API 1 Functions - Email::getpopquota

Description This function retrieves an email account's disk quota. Warning: cPanel API 1...

 cPanel API 1 Functions - Email::has_spam_as_acl

Description This function checks whether the server includes Apache SpamAssassin™ as an ACL. The...

 cPanel API 1 Functions - Email::has_spam_autodelete

Description This function checks whether the server uses Apache SpamAssassin™ to autodelete...

 cPanel API 1 Functions - Email::listmaildomains

Description This function lists all of a cPanel account's mail domains, with the main domain...

 cPanel API 1 Functions - Email::listmaildomainsopt

Description This function lists all of a cPanel account's mail domains, with none preselected....

 cPanel API 1 Functions - Email::listmaildomainsoptndef

Description This function lists all of a cPanel account's mail domains, with one domain...

 cPanel API 1 Functions - Email::mainacctdiskused

Description This function returns the amount of disk space that the main mail account uses....

 cPanel API 1 Functions - Email::passwdlist

Description This function modifies a mailing list's password. Warning: cPanel API 1 is...

 cPanel API 1 Functions - Email::passwdpop

Description This function modifies an email account's password and disk quota. Warning:...

 cPanel API 1 Functions - Email::setmxaccept

Description This function sets a mail exchanger's role. Note: This function only affects...

 cPanel API 1 Functions - Email::spamboxstatus

Description This function checks whether Apache SpamAssassin™ Spam Box is enabled. Warning:...

 cPanel API 1 Functions - Email::spamstatus

Description This function checks whether Apache SpamAssassin™ is enabled. Warning:...

 cPanel API 1 Functions - Email::tracefilter

Description This function tests an account's email filters. Notes: This function only...

 cPanel API 1 Functions - Fileman::Empty Trash

Description This function deletes the contents of the user's /trash directory. Warning:...

 cPanel API 1 Functions - Fileman::changeperm

Description This function changes a file's permissions. Warning: cPanel API 1 is...

 cPanel API 1 Functions - Fileman::delfile

Description This function deletes a file and backs it up in the /trash directory. Warning:...

 cPanel API 1 Functions - Fileman::dofileop

Description This function moves or copies a file to a different directory. Warning: cPanel...

 cPanel API 1 Functions - Fileman::extractfile

Description This function extracts a compressed file. Warning: cPanel API 1 is deprecated....

 cPanel API 1 Functions - Fileman::fileimg

Description This function returns the HTML to display a file type's icon. Warning: cPanel...

 cPanel API 1 Functions - Fileman::fmmkdir

Description This function creates a new directory. Warning: cPanel API 1 is deprecated. Do...

 cPanel API 1 Functions - Fileman::fmmkfile

Description This function creates a new blank file. Warning: cPanel API 1 is deprecated....

 cPanel API 1 Functions - Fileman::fmpushfile

Description This function prints a file to the browser. Warning: cPanel API 1 is...

 cPanel API 1 Functions - Fileman::fmrename

Description This function renames a file. Warning: cPanel API 1 is deprecated. We strongly...

 cPanel API 1 Functions - Fileman::fmsavefile

Description This function saves a string's contents to a file. Warning: cPanel API 1 is...

 cPanel API 1 Functions - Fileman::fmsavehtmlfile

Description This function saves information to an HTML file. Warning: cPanel API 1 is...

 cPanel API 1 Functions - Fileman::fullbackup

Description This function creates a full backup. Warning: cPanel API 1 is deprecated. We...

 cPanel API 1 Functions - Fileman::getfile

Description This function prints the contents of a file to the web browser. Warning:...

 cPanel API 1 Functions - Fileman::htmleditor

Description This function opens a file in the HTML editor. Warning: cPanel API 1 is...

 cPanel API 1 Functions - Fileman::killdir

Description This function deletes a directory. Warning: cPanel API 1 is deprecated. We...

 cPanel API 1 Functions - Fileman::listfiles

Description This function lists a directory's files, permissions, and some display options....

 cPanel API 1 Functions - Fileman::listfullbackups

Description This function retrieves a list of full server backups. Warning: cPanel API 1...

 cPanel API 1 Functions - Fileman::listtemplates

Description This function lists file templates from the /usr/local/cpanel/share/templates...

 cPanel API 1 Functions - Fileman::restoreaf

Description This function restores email filters or forwarder backups. Warning: cPanel API...

 cPanel API 1 Functions - Fileman::restorefile

Description This function restores a file from the /trash directory. Warning: cPanel API 1...

 cPanel API 1 Functions - Fileman::restorefiles

  Description This function restores a backup to a directory. Warning: cPanel API 1 is...

 cPanel API 1 Functions - Fileman::savehtmlfile

Description This function saves a string's contents to an HTML file. Warning: cPanel API 1...

 cPanel API 1 Functions - Fileman::showperm

Description This function displays a file's permissions. Warning: cPanel API 1 is...

 cPanel API 1 Functions - Fileman::uploadfiles

Description This function uploads files to the server. Warning: cPanel API 1 is...

 cPanel API 1 Functions - Fileman::viewfile

Description This function displays a file. Warning: cPanel API 1 is deprecated. Do not use...

 cPanel API 1 Functions - FrontPage::addfp

Description This function adds Microsoft® FrontPage® Extensions to the domain. Notes: In...

 cPanel API 1 Functions - FrontPage::delfp

Description This function removes Microsoft® FrontPage® Extensions from the domain. Notes:...

 cPanel API 1 Functions - Ftp::addftp

Description This function creates a new FTP account. Warning: cPanel API 1 is deprecated....

 cPanel API 1 Functions - Ftp::delftp

Description This function deletes an FTP account. Warning: cPanel API 1 is deprecated. Do...

 cPanel API 1 Functions - Ftp::ftpquota

Description This function sets an account's FTP quota. Warning: cPanel API 1 is...

 cPanel API 1 Functions - Ftp::ftpservername

Description This function retrieves the server's FTP daemon. Warning: cPanel API 1 is...

 cPanel API 1 Functions - Ftp::ftpstatslogin

Description This function retrieves the account's FTP statistics login information. You can use...

 cPanel API 1 Functions - Ftp::get_anonftp

Description This function checks whether the account allows anonymous FTP connections....

 cPanel API 1 Functions - Ftp::get_anonftpin

Description This function checks whether the account allows inbound anonymous FTP transfers....

 cPanel API 1 Functions - Ftp::get_welcomemsg

Description This function returns the anonymous FTP welcome message. Warning: cPanel API 1...

 cPanel API 1 Functions - Ftp::getftpquota

Description This function retrieves an account's FTP quota. Warning: cPanel API 1 is...

 cPanel API 1 Functions - Ftp::kill_ftp_session

Description This function kills an active FTP session. Warning: cPanel API 1 is...

 cPanel API 1 Functions - Ftp::listftpstatsurl

Description This function returns the HTML links to an account's FTP logs. This link includes...

 cPanel API 1 Functions - Ftp::passwdftp

Description This function changes an FTP user's password. Warning: cPanel API 1 is...

 cPanel API 1 Functions - Ftp::set_anonftp

Description This function enables or disables anonymous FTP logins. Warning: cPanel API 1...

 cPanel API 1 Functions - Ftp::set_anonftpin

Description This function changes whether the anonymous FTP upload directory is writable. This...

 cPanel API 1 Functions - Ftp::set_welcomemsg

Description This function changes the anonymous FTP welcome message. Warning: cPanel API 1...

 cPanel API 1 Functions - Gpg::deletekey

Description This function deletes a GnuPG key. Warning: cPanel API 1 is deprecated. We...

 cPanel API 1 Functions - Gpg::exportkey

Description This function returns a public GnuPG key. Warning: cPanel API 1 is deprecated....

 cPanel API 1 Functions - Gpg::exportsecretkey

Description This function returns a private GnuPG key. Warning: cPanel API 1 is...

 cPanel API 1 Functions - Gpg::genkey

Description This function generates a GnuPG key. The system saves the key in the user's...

 cPanel API 1 Functions - Gpg::importkeys

Description This function imports a GnuPG key. Warning: cPanel API 1 is deprecated. We...

 cPanel API 1 Functions - Htaccess::checkprotected

Description This function checks whether the Password Protect feature protects a specified...

 cPanel API 1 Functions - Htaccess::del_user

Description This function removes a user's access to a password-protected directory. Warning:...

 cPanel API 1 Functions - Htaccess::getindex

Description This function checks whether a directory contains a custom index page. Warning:...

 cPanel API 1 Functions - Htaccess::htdirls

Description This function returns HTML to display an interface to modify the  dohtaccess.html...

 cPanel API 1 Functions - Htaccess::number_of_users

Description This function counts the number of users that can access a directory. Warning:...

 cPanel API 1 Functions - Htaccess::phpselectable

Description This function displays the account's default PHP version. It also sets the...

 cPanel API 1 Functions - Htaccess::resname

Description This function retrieves the authname value from an .htaccess file. Warning:...

 cPanel API 1 Functions - Htaccess::set_pass

Description This function creates a new user and password for a protected directory. Warning:...

 cPanel API 1 Functions - Htaccess::set_protect

Description This function enables password protection for a directory. Warning: cPanel API...

 cPanel API 1 Functions - Htaccess::setindex

Description This function sets the index behavior for a directory. Warning: cPanel API 1...

 cPanel API 1 Functions - Htaccess::setphpreference

Description This function sets the PHP version for the account. Warning: cPanel API 1 is...

 cPanel API 1 Functions - Htaccess::showusers

Description This function retrieves the number of users that can access a directory. Warning:...

 cPanel API 1 Functions - ImageManager::convert

Description This function converts an image to a new file format. The function uses...

 cPanel API 1 Functions - ImageManager::dimensions

Description This function returns the dimensions of the image file that you specify. Warning:...

 cPanel API 1 Functions - ImageManager::hdimension

Description This function returns the height of an image in pixels. Warning: cPanel API 1...

 cPanel API 1 Functions - ImageManager::scale

Description This function scales a specified image. Warning: cPanel API 1 is deprecated....

 cPanel API 1 Functions - ImageManager::thumbnail

Description This function creates thumbnails from images. The function saves the new thumbnail...

 cPanel API 1 Functions - ImageManager::wdimension

Description This function returns the width of an image in pixels. Warning: cPanel API 1...

 cPanel API 1 Functions - LastLogin::lastlogin

Description This function retrieves the IP address of the last user to successfully log in to...

 cPanel API 1 Functions - LeechProtect::disable

Description This function disables leech protection for a directory. Warning: cPanel API 1...

 cPanel API 1 Functions - LeechProtect::enable

Description This function enables leech protection on a directory. Warning: cPanel API 1...

 cPanel API 1 Functions - LeechProtect::setup

Description This function queries values that the system in a directory's .leechprotect...

 cPanel API 1 Functions - LeechProtect::showpasswdfile

Description This function retrieves the passwd file's location. Warning: cPanel API 1 is...

 cPanel API 1 Functions - LeechProtect::status

Description This function displays a directory's leech protection status. Warning: cPanel...

 cPanel API 1 Functions - LogManager::listdownloads

Description This function displays the account's available raw access logs. Warning:...

 cPanel API 1 Functions - MagicRevision::uri

Description This function returns a URI fragment with the location of the cached version of the...

 cPanel API 1 Functions - Mime::add_handler

Description This function adds an Apache MIME type handler for a specific file extension....

 cPanel API 1 Functions - Mime::add_hotlink

Description This function enables hotlink protection for a site. If visitors arrive at a...

 cPanel API 1 Functions - Mime::add_mime

Description This function adds a MIME type to an account's .htaccess file. Note: This...

 cPanel API 1 Functions - Mime::add_redirect

Description This function adds a redirect to your .htaccess file. Warning: cPanel API 1 is...

 cPanel API 1 Functions - Mime::del_handler

Description This function removes an Apache MIME type handler from a file extension. Warning:...

 cPanel API 1 Functions - Mime::del_hotlink

Description This function disables hotlink protection. Warning: cPanel API 1 is...

 cPanel API 1 Functions - Mime::del_mime

Description This function removes an Apache MIME type handler from an account's .htaccess file....

 cPanel API 1 Functions - Mime::del_redirect

Description This function removes a redirect from an account's .htaccess file. Warning:...

 cPanel API 1 Functions - Mime::linkallownull

Description This function checks whether the system allows direct requests to images and other...

 cPanel API 1 Functions - Mime::linkenable

Description This function checks whether hotlink protection is enabled. Warning: cPanel...

 cPanel API 1 Functions - Mime::linkexts

Description This function lists the extensions that hotlink protection protects. Warning:...

 cPanel API 1 Functions - Mime::linkrurl

Description This function displays the URL to which hotlinkers will redirect. Warning:...

 cPanel API 1 Functions - Mime::linkurls

Description This function lists URLs that may access protected images. Warning: cPanel API...

 cPanel API 1 Functions - Mysql::adddb

Description This function creates a MySQL® database. Warning: cPanel API 1 is deprecated....

 cPanel API 1 Functions - Mysql::addhost

Description This function authorizes a remote host to access a cPanel account's MySQL® users....

 cPanel API 1 Functions - Mysql::adduser

Description This function creates a MySQL® database user. Warning: cPanel API 1 is...

 cPanel API 1 Functions - Mysql::adduserdb

Description This function grants permissions to a MySQL® database user. Warning: cPanel...

 cPanel API 1 Functions - Mysql::checkdb

Description This function checks a MySQL® database's integrity. Warning: cPanel API 1 is...

 cPanel API 1 Functions - Mysql::deldb

Description This function removes a MySQL® database. Warning: cPanel API 1 is deprecated....

 cPanel API 1 Functions - Mysql::delhost

Description This function authorizes a remote host to access a cPanel account's MySQL® users....

 cPanel API 1 Functions - Mysql::deluser

Description This function removes a MySQL® database user. Warning: cPanel API 1 is...

 cPanel API 1 Functions - Mysql::deluserdb

Description This function removes a MySQL® database user's access privileges from a database....

 cPanel API 1 Functions - Mysql::gethost

Description This function retrieves the server's MySQL® host. Warning: cPanel API 1 is...

 cPanel API 1 Functions - Mysql::initcache

Description This function refreshes cPanel's cache of MySQL® information. The cache exists in...

 cPanel API 1 Functions - Mysql::listdbs

Description This function lists a page's databases. Warning: cPanel API 1 is deprecated....

 cPanel API 1 Functions - Mysql::listdbsopt

Description This function displays a list of the cPanel account's databases. Warning:...

 cPanel API 1 Functions - Mysql::listusers

Description This function displays a HTML snippet to manage MySQL® users. Warning: cPanel...

 cPanel API 1 Functions - Mysql::listusersopt

Description This function lists an account's MySQL® database users. Warning: cPanel API 1...

 cPanel API 1 Functions - Mysql::number_of_dbs

Description This function retrieves the number of databases that the cPanel account owns....

 cPanel API 1 Functions - Mysql::number_of_users

Description This function retrieves the cPanel account's current number of database users....

 cPanel API 1 Functions - Mysql::repairdb

Description This function repairs a MySQL® database. Warning: cPanel API 1 is deprecated....

 cPanel API 1 Functions - Mysql::routines

Description This function lists user-created MySQL® routines. Warning: cPanel API 1 is...

 cPanel API 1 Functions - Mysql::updateprivs

Description This function repairs a MySQL® database. Warning: cPanel API 1 is deprecated....

 cPanel API 1 Functions - NVData::set

Description This function sets the value of an environment variable. The system stores the value...

 cPanel API 1 Functions - Net::dnslookup

Description This function performs a DNS lookup on a domain. Warning: cPanel API 1 is...

 cPanel API 1 Functions - Net::dnszone

Description This function returns DNS zone information about a domain. Warning: cPanel API...

 cPanel API 1 Functions - Net::sethastraceroute

Description This function checks whether the traceroute binary exists on the server. The system...

 cPanel API 1 Functions - News::displaynews

Description This function displays the contents of server-wide news. It uses the following files...

 cPanel API 1 Functions - OptimizeWS::loadoptimizesettings

Description This function sets the OptimizeWS module's environments. Notes: If...

 cPanel API 1 Functions - OptimizeWS::loadoptimizesettings (bytes)

Description This function returns a cPanel account's free disk space quota. Warning:...

 cPanel API 1 Functions - OptimizeWS::optimizews

Description This function configures a cPanel account's mod_deflate setting. Warning:...

 cPanel API 1 Functions - Park::disableredirect

Description This function removes the redirection URL from a parked domain. Warning:...

 cPanel API 1 Functions - Park::getredirecturl

Description This function retrieves a parked domain's redirection URL. Warning: cPanel API...

 cPanel API 1 Functions - Park::park

Description This function parks domains, or adds addon domains. This function also allows you...

 cPanel API 1 Functions - Park::setredirecturl

Description This function redirects a park domain to a URL. Warning: cPanel API 1 is...

 cPanel API 1 Functions - Park::unpark

Description This function unparks a parked domain. Warning: cPanel API 1 is deprecated. Do...

 cPanel API 1 Functions - Postgres::adddb

Description This function adds a PostgreSQL® database. Warning: cPanel API 1 is...

 cPanel API 1 Functions - Postgres::adduser

Description This function adds a PostgreSQL® database user. Warning: cPanel API 1 is...

 cPanel API 1 Functions - Postgres::adduserdb

Description This function adds a PostgreSQL® database user to a database. Warning: cPanel...

 cPanel API 1 Functions - Postgres::deldb

Description This function removes a PostgreSQL® database. Warning: cPanel API 1 is...

 cPanel API 1 Functions - Postgres::deluser

Description This function removes a PostgreSQL® database user. Warning: cPanel API 1 is...

 cPanel API 1 Functions - Postgres::deluserdb

Description This function removes a PostgreSQL® database user's access to a database....

 cPanel API 1 Functions - Postgres::initcache

Description This function initializes cPanel's PostgreSQL® caches. Warning: cPanel API 1...

 cPanel API 1 Functions - Postgres::listdbsopt

Description This function lists the cPanel account's PostgreSQL® databases. Warning:...

 cPanel API 1 Functions - Postgres::listusersopt

Description This function lists the cPanel account's PostgreSQL® database users. Warning:...

 cPanel API 1 Functions - Postgres::number_of_dbs

Description This function counts the cPanel account's PostgreSQL® databases. Warning:...

 cPanel API 1 Functions - Postgres::number_of_users

Description This function counts the cPanel account's PostgreSQL's database users. Warning:...

 cPanel API 1 Functions - ProxyUtils::proxyaddress

Description This function displays the proxy address for a specific application. Warning:...

 cPanel API 1 Functions - Resellers::accountlistopt

Description This function lists a reseller's cPanel accounts. Warning: cPanel API 1 is...

 cPanel API 1 Functions - Resellers::themelistopt

Description This function displays available themes. Warning: cPanel API 1 is deprecated....

 cPanel API 1 Functions - SSH::getport

Description This function returns the port number to which the sshd daemon listens. Warning:...

 cPanel API 1 Functions - SSL::delete

Description This function deletes a domain's SSL certificate. Warning: cPanel API 1 is...

 cPanel API 1 Functions - SSL::deletecrt

Description This function deletes a domain's SSL certificate. Warning: cPanel API 1 is...

 cPanel API 1 Functions - SSL::deletecsr

Description This function deletes a domain's CSR (Certificate Signing Request). Warning:...

 cPanel API 1 Functions - SSL::deletekey

Description This function deletes a domain's SSL key. Warning: cPanel API 1 is deprecated....

 cPanel API 1 Functions - SSL::gencrt

Description This function generates a self-signed certificate for a domain. Warning:...

 cPanel API 1 Functions - SSL::gencsr

Description This function generates a CSR (Certificate Signing Request). Warning: cPanel...

 cPanel API 1 Functions - SSL::genkey

Description This function generates an SSL key for a host. Warning: cPanel API 1 is...

 cPanel API 1 Functions - SSL::getcabundle

Description This function retrieves the hostname and CA (Certificate Authority) bundle for a...

 cPanel API 1 Functions - SSL::getcnname

Description This function retrieves the name of the certificate that secures a email service....

 cPanel API 1 Functions - SSL::install

Description This function installs an SSL certificate. Warning: cPanel API 1 is...

 cPanel API 1 Functions - SSL::installedhost

Description This function retrieves the name of the SSL certificate for the IP address of a...

 cPanel API 1 Functions - SSL::listkeysopt

Description This function lists the account's SSL keys. Warning: cPanel API 1 is...

 cPanel API 1 Functions - SSL::showcrt

Description This function retrieves a certificate. Warning: cPanel API 1 is deprecated. Do...

 cPanel API 1 Functions - SSL::showcsr

Description This function retrieves a CSR (Certificate Signing Request). Warning: cPanel...

 cPanel API 1 Functions - SSL::showkey

Description This function retrieves a key. Warning: cPanel API 1 is deprecated. Do not use...

 cPanel API 1 Functions - SSL::sslsharedstatus

Description This function displays whether the account uses a shared SSL certificate....

 cPanel API 1 Functions - SSL::uploadcrt

Description This function uploads an SSL certificate to the server. Warning: cPanel API 1...

 cPanel API 1 Functions - SSL::uploadkey

Description This function uploads an SSL key to the server. Warning: cPanel API 1 is...

 cPanel API 1 Functions - Serverinfo::servicestatus

Description This function displays the status of services that the chkservd daemon monitors....

 cPanel API 1 Functions - SetLang::listlangsopt

Description This function lists the interface languages that are available to an account....

 cPanel API 1 Functions - SetLang::setlang

Description This function sets the interface language for an account. Warning: cPanel API...

 cPanel API 1 Functions - SpamAssassin::config

Description This function prints the cPanel account's Apache SpamAssassin's™ default values....

 cPanel API 1 Functions - SpamAssassin::saveconfig

Description This function saves Apache SpamAssassin's™ configuration information. Warning:...

 cPanel API 1 Functions - StatManager::doForm

Description This function display returns HTML for a table of the cPanel account's domains and...

 cPanel API 1 Functions - StatManager::updateUserConfig

Description This function enables or disables a statistics program for a domain. Warning:...

 cPanel API 1 Functions - Stats::analoglist

Description This function displays the domain's Analog statistics. Warning: cPanel API 1...

 cPanel API 1 Functions - Stats::awstats

Description This function retrieves the relative URL path to a domain's AWStats data....

 cPanel API 1 Functions - Stats::bwbar

Description This function retrieves a graphical bar that indicates bandwidth usage for the...

 cPanel API 1 Functions - Stats::errlog

Description This function displays the last few entries from the domain's error log. Warning:...

 cPanel API 1 Functions - Stats::lastvisitors

Description This function retrieves a list of a domain's most recent visitors. Warning:...

 cPanel API 1 Functions - Stats::showbandwidth

Description This function displays bandwidth usage for the cPanel account's domains. This...

 cPanel API 1 Functions - Stats::webalizer

Description This function retrieves the path to a domain's Webalizer data. Warning: cPanel...

 cPanel API 1 Functions - Stats::webalizerftp

Description This function retrieves the file path to Webalizer's FTP statistics. Warning:...

 cPanel API 1 Functions - SubDomain::addsubdomain

Description This function adds a subdomain to a domain. Warning:  cPanel API 1 is...

 cPanel API 1 Functions - SubDomain::cplistsubdomains

Description This function lists an account's subdomains. Warning: cPanel API 1 is...

 cPanel API 1 Functions - SubDomain::disablesubrd

Description This function disables a subdomain redirection. Warning: cPanel API 1 is...

 cPanel API 1 Functions - SubDomain::listsubdomainsop

Description This function lists an account's subdomains. Warning: cPanel API 1 is...

 cPanel API 1 Functions - SubDomain::setsuburl

Description This function redirects a subdomain to a URL. Warning: cPanel API 1 is...

 cPanel API 1 Functions - UI::confirm

Description This function displays the $Cpanel::FORM elements and values in HTML input tags....

 cPanel API 1 Functions - UI::redirect

Description This function creates an HTML redirect string. Warning: cPanel API 1 is...

 cPanel API 1 Functions - UI::showresult

Description This function prints a function's results within div tags. Warning: cPanel API...

 cPanel API 1 Functions - cPAddons::mainpg

Description This function provides tools to install a cPAddon.  This function performs the...

 cPanel API 2 - Deprecated cPanel Tag Usage

Introduction   Warning: In cPanel & WHM version 11.30 and later, cPanel tags are...

 cPanel API 2 - Filter and Sort Output

Introduction You can use additional variables to filter and sort cPanel API 2 output. Notes:...

 cPanel API 2 - Output Columns

Introduction You can use special variables to select the parameters to display in cPanel API 2...

 cPanel API 2 - Paginate Output

Introduction You can use special variables to display cPanel API 2 output data in multiple pages...

 cPanel API 2 - Return Data

Introduction cPanel API 2 outputs data in JavaScript Object Notation (JSON). Note: XML...

 cPanel API 2 Functions - AddonDomain::addaddondomain

Description This function creates an addon domain, its subdomain, its FTP account, and its DNS...

 cPanel API 2 Functions - AddonDomain::deladdondomain

Description This function deletes an addon domain and its subdomain. Warning: We strongly...

 cPanel API 2 Functions - AddonDomain::listaddondomains

Description This function lists an account's addon domains. Warning: We strongly recommend...

 cPanel API 2 Functions - Backups::listfullbackups

Description This function displays pending and completed backups in the /home directory....

 cPanel API 2 Functions - Bandwidth::addhttpbandwidth

Description This function adds bandwidth to an account. Warning: We removed this function...

 cPanel API 2 Functions - Bandwidth::getbwdata

Description This function queries a Round Robin Database (RRD) dataset for your account's...

 cPanel API 2 Functions - Bandwidth::gethourlyaveragebwoveryear

Description This function returns an account's average hourly peak bandwidth use for one year....

 cPanel API 2 Functions - BoxTrapper::accountmanagelist

Description This function retrieves the BoxTrapper status for email accounts. Warning: We...

 cPanel API 2 Functions - Branding::addbrandingobj

Description This function adds an item to the current dynamicui.conf file. Note: cPanel...

 cPanel API 2 Functions - Branding::applist

Description This function lists icon information from the current dynamicui.conf file....

 cPanel API 2 Functions - Branding::brandingeditor

Description This function updates objects in a branding package's dynamicui.conf file....

 cPanel API 2 Functions - Branding::createpkg

Description This function creates a branding package's directory. Note: cPanel API 2's...

 cPanel API 2 Functions - Branding::cssmerge

Description This function updates a branding package's CSS file. Note: cPanel API 2's...

 cPanel API 2 Functions - Branding::delbrandingobj

Description This function deletes items from the current dynamicui.conf file. Note: cPanel...

 cPanel API 2 Functions - Branding::delpkg

Description This function deletes a branding package. Note: cPanel API 2's Branding module...

 cPanel API 2 Functions - Branding::gensprites

Description This function rebuilds the cPanel interface's sprites. Sprites store the cPanel...

 cPanel API 2 Functions - Branding::getbrandingpkg

Description This function retrieves the current branding package's name. Note: cPanel API...

 cPanel API 2 Functions - Branding::getbrandingpkgstatus

Description This function retrieves the current branding package's status. Note: cPanel...

 cPanel API 2 Functions - Branding::getdefaultbrandingpkg

Description This function retrieves the account's default branding package. Note: cPanel...

 cPanel API 2 Functions - Branding::installbrandingpkgs

Description This function is for cPanel & WHM's internal use only. It requires variables...

 cPanel API 2 Functions - Branding::installimages

Description This function checks whether the current branding package's images are installed. If...

 cPanel API 2 Functions - Branding::killimgs

Description This function is for cPanel & WHM's internal use only. It requires variables...

 cPanel API 2 Functions - Branding::listimgtypes

Description This function lists the current dynamicui.conf file's image types. Note:...

 cPanel API 2 Functions - Branding::listobjecttypes

Description This function lists the current dynamicui.conf file's object types. Note:...

 cPanel API 2 Functions - Branding::preloadconf

Description This function returns the dynamicui.conf file's contents. Warning:...

 cPanel API 2 Functions - Branding::resetall

Description This function resets all of the dynamicui.conf file's items. Note: cPanel API...

 cPanel API 2 Functions - Branding::resetcss

Description This function resets the local.css file. Note: cPanel API 2's Branding module...

 cPanel API 2 Functions - Branding::resethtml

Description This function resets the branding package's HTML files. Note: cPanel API 2's...

 cPanel API 2 Functions - Branding::resolve_file

Description This function returns a file's path. Warning: We strongly recommend that you...

 cPanel API 2 Functions - Branding::resolvelocalcss

Description This function returns the path to the account's local.css file. Note: cPanel...

 cPanel API 2 Functions - Branding::savelocalcss

Description This function creates or updates the local.css file. Note: cPanel API 2's...

 cPanel API 2 Functions - Branding::setbrandingpkgstatus

Description This function enables or disables the current branding package. Note: cPanel...

 cPanel API 2 Functions - Branding::showpkgs

Description This function lists available branding packages. Note: cPanel API 2's Branding...

 cPanel API 2 Functions - Branding::spritelist

Description This function lists sprite information and locations. Sprites store the cPanel...

 cPanel API 2 Functions - CSVImport::columnchoices

Description This function is deprecated and does not return useful output.  Warning: We...

 cPanel API 2 Functions - CSVImport::configimport

Description This function is deprecated and does not return useful output.  Warning: We...

 cPanel API 2 Functions - CSVImport::data

Description This function is deprecated and does not return useful output.  Warning: We...

 cPanel API 2 Functions - CSVImport::fetchimportdata

Description This function is deprecated and does not return useful output.  Warning: We...

 cPanel API 2 Functions - CSVImport::isenabled

Description This function is deprecated and does not return useful output.  Warning: We...

 cPanel API 2 Functions - CSVImport::loaddata

Description This function is deprecated and does not return useful output.  Warning: We...

 cPanel API 2 Functions - CSVImport::processdata

Description This function is deprecated and does not return useful output.  Warning: We...

 cPanel API 2 Functions - CSVImport::sendcontact

Description This function is deprecated and does not return useful output.  Warning: We...

 cPanel API 2 Functions - CSVImport::uploadimport

Description This function is deprecated and does not return useful output.  Warning: We...

 cPanel API 2 Functions - Contactus::isenabled

Description This function checks whether the account's contact option is enabled. Warning:...

 cPanel API 2 Functions - Contactus::sendcontact

Description This function sends a support request to the site's host. Warning: We strongly...

 cPanel API 2 Functions - Cron::add_line

Description This function adds a crontab entry. Warning: We strongly recommend that you...

 cPanel API 2 Functions - Cron::edit_line

Description This function edits a crontab entry. Warning: We strongly recommend that you...

 cPanel API 2 Functions - Cron::fetchcron

Description This function lists all of the account's cron jobs. Warning: We...

 cPanel API 2 Functions - Cron::get_email

Description This function retrieves the notification email address. Warning: We strongly...

 cPanel API 2 Functions - Cron::listcron

Description This function lists all cron jobs. Warning: We strongly recommend that you use...

 cPanel API 2 Functions - Cron::remove_line

Description This function removes a crontab entry. Warning: We strongly recommend that you...

 cPanel API 2 Functions - Cron::set_email

Description This function sets the default notification email for the cron daemon. Warning:...

 cPanel API 2 Functions - CustInfo::contactemails

Description This function retrieves the account's primary and secondary email addresses....

 cPanel API 2 Functions - CustInfo::contactprefs

Description This function retrieves the account's notification settings.  Warning: We...

 cPanel API 2 Functions - CustInfo::displaycontactinfo

Description This function displays an account's contact and notification settings.  Warning:...

 cPanel API 2 Functions - CustInfo::savecontactinfo

Description This function modifies an account's contact and notification settings. Warning:...

 cPanel API 2 Functions - DBmap::status

Description This function checks whether an account uses database prefixing.  Warning: We...

 cPanel API 2 Functions - DBmap::version

Description This function retrieves the account's version of cPanel & WHM.  Warning:...

 cPanel API 2 Functions - DKIMUI::available

Description This function checks whether Domain Keys Identified Mail (DKIM) is available on a...

 cPanel API 2 Functions - DKIMUI::getrecords

Description This function retrieves active Domain Keys Identified Mail (DKIM) records....

 cPanel API 2 Functions - DKIMUI::install

Description This function installs Domain Keys Identified Mail (DKIM). Warning: We...

 cPanel API 2 Functions - DKIMUI::installed

Description This function checks whether Domain Keys Identified Mail (DKIM) is installed on a...

 cPanel API 2 Functions - DKIMUI::uninstall

Description This function uninstalls Domain Keys Identified Mail (DKIM). Warning: We...

 cPanel API 2 Functions - DenyIp::listdenyips

Description This function lists blocked IP addresses.  Warning: We strongly recommend that...

 cPanel API 2 Functions - DiskCounter::disk_counter

Description This function lists files on your server as a nested directory tree. Warning:...

 cPanel API 2 Functions - DiskUsage::buildcache

Description This function rebuilds the account's cache of disk space usage data. Warning:...

 cPanel API 2 Functions - DiskUsage::clearcache

Description This function clears the account's cache of disk space usage data. It is useful if...

 cPanel API 2 Functions - DiskUsage::fetch_raw_disk_usage

Description This function is deprecated and does not return useful output. Warning: We...

 cPanel API 2 Functions - DiskUsage::fetchdiskusage

Description This function retrieves the account's disk usage data.    Examples...

 cPanel API 2 Functions - DiskUsage::fetchdiskusagewithextras

Description This function retrieves the account's disk space usage data. The results include...

 cPanel API 2 Functions - DnsLookup::name2ip

Description This function returns a domain's IP address. Warning: We strongly recommend...

 cPanel API 2 Functions - DomainLookup::countbaseddomains

Description This function retrieves the total number of base domains. Warning: We strongly...

 cPanel API 2 Functions - DomainLookup::getbasedomains

Description This function lists parked domains, addon domains, and main domains. Warning:...

 cPanel API 2 Functions - DomainLookup::getdocroot

Description This function retrieves a domain's document root file paths.  Warning: We...

 cPanel API 2 Functions - DomainLookup::getdocroots

Description This function retrieves all of the domains' document root file paths. Warning:...

 cPanel API 2 Functions - DomainLookup::getmaindomain

Description This function retrieves a cPanel account's main domain. Warning: We strongly...

 cPanel API 2 Functions - Email::accountname

Description This function retrieves an email account's username. Warning: We strongly...

 cPanel API 2 Functions - Email::adddomainforward

Description This function creates a domain-level email forwarder. Warning: We strongly...

 cPanel API 2 Functions - Email::addforward

Description This function creates an email forwarder. Warning: We strongly...

 cPanel API 2 Functions - Email::addmx

Description This function creates an MX record. For more information about MX record...

 cPanel API 2 Functions - Email::addpop

Description This function adds an email account. Warning: We strongly recommend that you...

 cPanel API 2 Functions - Email::browseboxes

Description This function retrieves a list of the mail directory's subdirectories (boxes) and...

 cPanel API 2 Functions - Email::changemx

Description This function changes an MX entry's configuration. Warning: We...

 cPanel API 2 Functions - Email::checkmaindiscard

Description This function checks whether the system deletes a domain's unroutable mail. Note:...

 cPanel API 2 Functions - Email::clearpopcache

Description This function rebuilds an email account's cache file. Warning: We strongly...

 cPanel API 2 Functions - Email::deletefilter

Description This function deletes an email filter. For more information about Exim filters, read...

 cPanel API 2 Functions - Email::delforward

Description This function deletes an email forwarder that forwards mail to another address....

 cPanel API 2 Functions - Email::delmx

Description This function deletes a mail exchanger.  Warning: We strongly...

 cPanel API 2 Functions - Email::delpop

Description This function deletes an email account. When you call this function, the system...

 cPanel API 2 Functions - Email::disablefilter

Description This function disables a filter. Warning: We strongly recommend that you use...

 cPanel API 2 Functions - Email::editquota

Description This function modifies an email account's disk quota. Warning: We strongly...

 cPanel API 2 Functions - Email::enablefilter

Description This function enables a filter. Warning: We strongly recommend that you use...

 cPanel API 2 Functions - Email::fetchcharmaps

Description This function retrieves a list of cPanel-supported character encodings. Warning:...

 cPanel API 2 Functions - Email::filteractions

Description This function is deprecated and does not return useful output. Warning: We...

 cPanel API 2 Functions - Email::filterlist

Description This function lists mail filters.  Warning: We strongly recommend that you use...

 cPanel API 2 Functions - Email::filtername

Description This function generates a name for a new email filter. When you call this function,...

 cPanel API 2 Functions - Email::filterrules

Description This function is deprecated and does not return useful output. Warning: We...

 cPanel API 2 Functions - Email::get_archiving_configuration

Description This function retrieves the cPanel account's archiving configurations. Warning:...

 cPanel API 2 Functions - Email::get_archiving_default_configuration

Description This function retrieves the default archiving configurations. Warning: We...

 cPanel API 2 Functions - Email::get_archiving_types

Description This function lists the available email archiving types. Warning: We strongly...

 cPanel API 2 Functions - Email::get_default_email_quota

Description This function retrieves the system's default email quota. Warning: We strongly...

 cPanel API 2 Functions - Email::get_email_signing

Description This function checks whether Domain Keys Identified Mail (DKIM) is enabled....

 cPanel API 2 Functions - Email::get_max_email_quota

Description This function retrieves the system's maximum email quota. Warning: We strongly...

 cPanel API 2 Functions - Email::getabsbrowsedir

Description This function retrieves the absolute path to a mail folder.  Warning: We...

 cPanel API 2 Functions - Email::getalwaysaccept

Description This function checks a domain's mail exchanger type.  Note: This function only...

 cPanel API 2 Functions - Email::getdiskusage

Description This function retrieves an email account's current disk usage. Warning: We...

 cPanel API 2 Functions - Email::getmxcheck

Description This function retrieves a domain's mail exchanger's type. For more information about...

 cPanel API 2 Functions - Email::has_delegated_mailman_lists

Description This function checks whether an email account possesses administrative privileges on...

 cPanel API 2 Functions - Email::list_system_filter_info

Description This function retrieves the name of the email account's filter file. For more...

 cPanel API 2 Functions - Email::listaliasbackups

Description This function retrieves a list of the account's domains that use aliases and custom...

 cPanel API 2 Functions - Email::listautoresponders

Description This function lists the cPanel account's autoresponders. Warning: We strongly...

 cPanel API 2 Functions - Email::listdefaultaddresses

Description This function retrieves the domain's default address and its rules. The cPanel...

 cPanel API 2 Functions - Email::listdomainforwards

Description This function retrieves information about a domain-level forwarder. Warning:...

 cPanel API 2 Functions - Email::listfilterbackups

Description This function lists domains with domain-level filters.  Warning: We strongly...

 cPanel API 2 Functions - Email::listfilters

Description This function lists data for old-style email filters in the cPanel account's .filter...

 cPanel API 2 Functions - Email::listforwards

Description This function list a domain's forwarders. Warning: We strongly...

 cPanel API 2 Functions - Email::listforwards

Description This function list a domain's forwarders. Warning: We strongly recommend that...

 cPanel API 2 Functions - Email::listlists

Description This function lists the cPanel account or domain's mailing lists. Warning: We...

 cPanel API 2 Functions - Email::listmaildomains

Description This function lists the cPanel account's mail domains. Warning: We strongly...

 cPanel API 2 Functions - Email::listmx

Description This function lists mail exchangers. For more information about MX record settings,...

 cPanel API 2 Functions - Email::listmxs

Description This function lists mail exchangers. For more information about MX record settings,...

 cPanel API 2 Functions - Email::listpops

Description This function lists the cPanel account's email addresses. Warning: We strongly...

 cPanel API 2 Functions - Email::listpopssingle

Description This function lists the cPanel account's email addresses. Warning: We strongly...

 cPanel API 2 Functions - Email::listpopswithdisk

Description This function lists a domain's email addresses with quota and disk usage...

 cPanel API 2 Functions - Email::listpopswithimage

Description This function lists the cPanel account's email addresses with mainacct.jpg image...

 cPanel API 2 Functions - Email::loadfilter

Description This function retrieves an email filter's information. For more information about...

 cPanel API 2 Functions - Email::passwdpop

Description This function modifies an email account's password. Warning: We strongly...

 cPanel API 2 Functions - Email::reorderfilters

Description This function modifies email filter order. Warning: We strongly recommend that...

 cPanel API 2 Functions - Email::set_archiving_configuration

Description This function configures email archiving for a domain. Warning: We strongly...

 cPanel API 2 Functions - Email::set_archiving_default_configuration

Description This function sets a default email archiving configuration. Warning: We...

 cPanel API 2 Functions - Email::set_email_signing

Description This function enables or disables DKIM. Warning: We strongly recommend that...

 cPanel API 2 Functions - Email::setalwaysaccept

Description This function modifies a mail exchanger's type.  Warning: We...

 cPanel API 2 Functions - Email::setdefaultaddress

Description This function configures the account's default address's rules for unroutable...

 cPanel API 2 Functions - Email::setmxcheck

Description This function modifies a mail exchanger's type. For more information about MX record...

 cPanel API 2 Functions - Email::storefilter

Description This function creates an email filter. For more information about Exim...

 cPanel API 2 Functions - Email::tracefilter

Description This function tests mail filters. The function only tests filters for the cPanel...

 cPanel API 2 Functions - EmailTrack::search

Description This function displays tracking information for the messages in the account's...

 cPanel API 2 Functions - EmailTrack::stats

Description This function returns a cPanel account's mail statistics. Warning: We strongly...

 cPanel API 2 Functions - EmailTrack::trace

Description This function traces the route to an email address. Warning: We strongly...

 cPanel API 2 Functions - Encoding::get_encodings

Description This function retrieves a list of available file character encodings. Warning:...

 cPanel API 2 Functions - Encoding::guess_file

Description This function attempts to retrieve a file's character encoding. Warning: We...

 cPanel API 2 Functions - Encoding::guess_file_opts

Description This function retrieves a file's encoding and a list of all cPanel-supported...

 cPanel API 2 Functions - FSTest::dirisempty

Description This function checks whether a directory is empty. Warning: We strongly...

 cPanel API 2 Functions - Fileman::autocompletedir

Description This function queries files and directories. Warning: We strongly recommend...

 cPanel API 2 Functions - Fileman::fileop

Description This function performs an operation on one or more files. Warning: We strongly...

 cPanel API 2 Functions - Fileman::getabsdir

Description This function lists cPanel's current directory. The default directory is the /...

 cPanel API 2 Functions - Fileman::getdir

Description This function returns an account's home directory's path in URI-encoded format....

 cPanel API 2 Functions - Fileman::getdiractions

Description This function lists possible directory actions. Warning: We strongly...

 cPanel API 2 Functions - Fileman::getdiskinfo

Description This function returns an account's disk usage statistics. Warning: We strongly...

 cPanel API 2 Functions - Fileman::getedittype

Description This function returns a file's type. Warning: We strongly recommend that you...

 cPanel API 2 Functions - Fileman::getfileactions

Description This function lists possible file actions. Warning: We strongly recommend that...

 cPanel API 2 Functions - Fileman::getpath

Description This function splits a URI-encoded path into individual parts. Warning: We...

 cPanel API 2 Functions - Fileman::listfiles

Description This function lists a directory's files and their attributes. Warning: This...

 cPanel API 2 Functions - Fileman::mkdir

Description This function creates a directory. Warning: We strongly recommend that you use...

 cPanel API 2 Functions - Fileman::mkfile

Description This function creates a file. Warning: We strongly recommend that you use UAPI...

 cPanel API 2 Functions - Fileman::savefile

Description This function saves a string to a file. Warning: This function is deprecated...

 cPanel API 2 Functions - Fileman::search

Description This function recursively searches for a file within a directory....

 cPanel API 2 Functions - Fileman::statfiles

Description This function lists file information. Warning: This function is deprecated as...

 cPanel API 2 Functions - Fileman::uploadfiles

Description This function uploads files. Warning: We strongly recommend that you use the...

 cPanel API 2 Functions - Fileman::viewfile

Description This function lists file information. Warning: This function is deprecated as...

 cPanel API 2 Functions - ForcePassword::get_force_password_flags

Description This function is deprecated and does not return useful output. Warning: We...

 cPanel API 2 Functions - ForcePassword::update_force_password_flags

Description This function is deprecated and does not return useful output. Warning: We...

 cPanel API 2 Functions - Frontpage::fpenabled

Description This function checks whether Microsoft® FrontPage® is enabled.  Warning: We...

 cPanel API 2 Functions - Frontpage::list

Description This function lists the Microsoft® FrontPage® status for each of the account's...

 cPanel API 2 Functions - Ftp::addftp

Description This function creates an FTP account. Warning: We strongly recommend that you...

 cPanel API 2 Functions - Ftp::delftp

Description This function deletes an FTP account. Warning: We strongly recommend that you...

 cPanel API 2 Functions - Ftp::listftp

Description This function lists an account's FTP users. Warning: We strongly recommend...

 cPanel API 2 Functions - Ftp::listftpsessions

Description This function lists an account's active FTP sessions. Warning: We strongly...

 cPanel API 2 Functions - Ftp::listftpwithdisk

Description This function lists FTP users and their home directory's disk information....

 cPanel API 2 Functions - Ftp::passwd

Description This function changes an FTP user's password. Warning: We strongly recommend...

 cPanel API 2 Functions - Ftp::setquota

Description This function changes an FTP account's quota. Warning: We strongly recommend...

 cPanel API 2 Functions - Gpg::listgpgkeys

Description This function retrieves public GPG keys. Warning: We strongly recommend that...

 cPanel API 2 Functions - Gpg::listsecretgpgkeys

Description This function retrieves a user's private GPG keys. Warning: We strongly...

 cPanel API 2 Functions - Gpg::number_of_private_keys

Description This function retrieves the number of private GPG keys. Warning: We strongly...

 cPanel API 2 Functions - Gpg::number_of_public_keys

Description This function retrieves the number of public GPG keys. Warning: We strongly...

 cPanel API 2 Functions - Htaccess::listuser

Description This function retrieves a directory's authorized users from the .htaccess file....

 cPanel API 2 Functions - Htaccess::listusers

Description This function retrieves a directory's authorized users from the .htaccess file....

 cPanel API 2 Functions - HttpUtils::getdirindices

Description This function lists index files that the account will serve if a web browser...

 cPanel API 2 Functions - ImageManager::thumbnail

Description This function is deprecated and does not return useful output. Warning: We...

 cPanel API 2 Functions - LVEInfo::getUsage

Description This function returns a CloudLinux™ system account's LVE information. Warning:...

 cPanel API 2 Functions - LangMods::getarchname

Description This function retrieves a cPanel-supported scripting language's processor...

 cPanel API 2 Functions - LangMods::getkey

Description This function retrieves a cPanel-supported scripting language's key, or long name....

 cPanel API 2 Functions - LangMods::getprefix

Description This function retrieves a cPanel-supported scripting language module's base...

 cPanel API 2 Functions - LangMods::install

Description This function installs a cPanel-supported language module. Warning: We...

 cPanel API 2 Functions - LangMods::langlist

Description This function lists the server's available scripting languages. Warning: We...

 cPanel API 2 Functions - LangMods::list_available

Description This function lists a language module system's available modules. Warning: We...

 cPanel API 2 Functions - LangMods::list_installed

Description This function lists a cPanel-supported scripting language's installed modules....

 cPanel API 2 Functions - LangMods::magic_status

Description This function checks whether a cPanel-supported scripting language has magic status...

 cPanel API 2 Functions - LangMods::pre_run

Description This function updates the indexes and actions for a cPanel-supported language....

 cPanel API 2 Functions - LangMods::search

Description This function lists a cPanel-supported scripting language's available modules....

 cPanel API 2 Functions - LangMods::setup

Description This function determines whether the account has the necessary requirements for the...

 cPanel API 2 Functions - LangMods::uninstall

Description This function uninstalls a cPanel-supported language module. Warning: We...

 cPanel API 2 Functions - LangMods::update

Description This function updates a specified cPanel-supported language module. Warning:...

 cPanel API 2 Functions - LeechProtect::setup

Description This function configures Leech Protection on a cPanel account.  Warning: We...

 cPanel API 2 Functions - Locale::get_encoding

Description This function retrieves a user's character set encoding. Warning: We strongly...

 cPanel API 2 Functions - Locale::get_html_dir_attr

Description This function retrieves a locale's text directionality. Warning: We strongly...

 cPanel API 2 Functions - Locale::get_locale_name

Description This function displays a locale's name in the user's language. Warning: We...

 cPanel API 2 Functions - Locale::get_user_locale

Description This function retrieves a user's locale ID tag. Warning: We strongly recommend...

 cPanel API 2 Functions - Locale::get_user_locale_name

Description This function retrieves a user's locale's name in that locale's language....

 cPanel API 2 Functions - Locale::numf

Description This function retrieves a locale's number formatting method. Warning: We...

 cPanel API 2 Functions - Logaholic::adduser

Description This function adds a user to the Logaholic statistics program. Warning: We...

 cPanel API 2 Functions - Logaholic::adduserprofile

Description This function adds a profile to a Logaholic user. Warning: We strongly...

 cPanel API 2 Functions - Logaholic::deleteuser

Description This function removes a user from the Logaholic statistics program. Warning:...

 cPanel API 2 Functions - Logaholic::deleteuserprofile

Description This function removes a profile from a Logaholic user. Warning: We strongly...

 cPanel API 2 Functions - Logaholic::edituser

Description This function edits a Logaholic user. Warning: We strongly recommend that you...

 cPanel API 2 Functions - Logaholic::fetchuser

Description This function retrieves information about a Logaholic user. Warning: We...

 cPanel API 2 Functions - Logaholic::listuserprofiles

Description This function lists a Logaholic user's profiles. Warning: We strongly...

 cPanel API 2 Functions - Logaholic::logaholiclink

Description This function generates a link to Logaholic.This link uses the cPanel account's...

 cPanel API 2 Functions - Logaholic::processstats

Description This function processes statistics for a Logaholic user's profile. Warning: We...

 cPanel API 2 Functions - Mime::list_hotlinks

Description This function lists redirects from the cPanel account's .htaccess files. Warning:...

 cPanel API 2 Functions - Mime::listhandlers

Description This function lists Apache's handlers. Warning: We strongly recommend that you...

 cPanel API 2 Functions - Mime::listmime

Description This function lists Apache MIME types. Warning: We strongly recommend that you...

 cPanel API 2 Functions - Mime::listredirects

Description This function lists the cPanel account's redirects. Warning: We strongly...

 cPanel API 2 Functions - Mime::redirectname

Description This function echoes the domain name or ** All Public Domains **. Warning: We...

 cPanel API 2 Functions - Mime::redirecturlname

Description This function echoes the URL or ** All Requests **. Warning: We strongly...

 cPanel API 2 Functions - MysqlFE::authorizehost

Description This function authorizes a host for remote access to the account's database....

 cPanel API 2 Functions - MysqlFE::changedbuserpassword

Description This function changes a database user's password. Warning: We strongly...

 cPanel API 2 Functions - MysqlFE::createdb

Description This function creates a database. Warning: We strongly recommend that you use...

 cPanel API 2 Functions - MysqlFE::createdbuser

Description This function creates a database user. Warning: We strongly recommend that you...

 cPanel API 2 Functions - MysqlFE::dbuserexists

Description This function checks whether a database user exists. Warning: We strongly...

 cPanel API 2 Functions - MysqlFE::deauthorizehost

Description This function removes a remote host's authorization. Warning: We strongly...

 cPanel API 2 Functions - MysqlFE::deletedb

Description This function deletes a database. Warning: We strongly recommend that you use...

 cPanel API 2 Functions - MysqlFE::deletedbuser

Description This function deletes a database user. We strongly recommend that you use the...

 cPanel API 2 Functions - MysqlFE::getalldbsinfo

Description This function retrieves information about all of an account's databases. Warning:...

 cPanel API 2 Functions - MysqlFE::getalldbusersanddbs

Description This function lists the databases for which a user has authorization. Warning:...

 cPanel API 2 Functions - MysqlFE::getdbuserprivileges

Description This function lists a database user's privileges on a database. Warning: We...

 cPanel API 2 Functions - MysqlFE::getdbusers

Description This function lists MySQL® database users. It can list all users, or only users who...

 cPanel API 2 Functions - MysqlFE::gethosts

Description This function lists authorized remote hosts for the account's databases. Warning:...

 cPanel API 2 Functions - MysqlFE::getmysqlprivileges

Description This function lists the account's MySQL® privileges. Warning: We strongly...

 cPanel API 2 Functions - MysqlFE::getmysqlserverprivileges

Description This function lists the MySQL® server's available privileges. Warning: We...

 cPanel API 2 Functions - MysqlFE::has_mycnf_for_cpuser

Description This function checks whether a valid .my.cnf file exists in the account's home...

 cPanel API 2 Functions - MysqlFE::listdbs

Description This function lists the account's dabatases. Warning: We strongly recommend...

 cPanel API 2 Functions - MysqlFE::listdbsbackup

Description This function lists the account's database backups. Warning: We strongly...

 cPanel API 2 Functions - MysqlFE::listhosts

Description This function lists remote MySQL® connection hosts. Warning: We strongly...

 cPanel API 2 Functions - MysqlFE::listusers

Description This function lists an account's MySQL® database users.  Warning: We strongly...

 cPanel API 2 Functions - MysqlFE::listusersindb

Description This function lists MySQL® database users that are authorized to use a database....

 cPanel API 2 Functions - MysqlFE::revokedbuserprivileges

Description This function revokes a user's privileges from a database. Warning: We...

 cPanel API 2 Functions - MysqlFE::setdbuserprivileges

Description This function grants privileges to a user on a database. Warning: We strongly...

 cPanel API 2 Functions - MysqlFE::userdbprivs

Description This function lists a user's privileges on a MySQL® database. Warning: This...

 cPanel API 2 Functions - MysqlOptimizer::fetch_slow_queries

Description This function slow MySQL processes on the account. Warning: This function is...

 cPanel API 2 Functions - NVData::get

Description This function retrieves data from a non-volatile datastore. Files are located in the...

 cPanel API 2 Functions - NVData::set

Description This function creates a non-volatile datastore. The system creates the datastore in...

 cPanel API 2 Functions - NVData::setall

Description This function creates a non-volatile datastore. The system creates the datastore in...

 cPanel API 2 Functions - Net::dnszone

Description This function performs an A record DNS query for the account's hostname....

 cPanel API 2 Functions - Net::traceroute

Description This function uses traceroute to retrieve the local IP address. Warning: We...

 cPanel API 2 Functions - News::does_news_exist

Description This function checks whether news is available on the server. Warning: We...

 cPanel API 2 Functions - News::get_news

Description This function retrieves the news of a specified type.  Warning: We strongly...

 cPanel API 2 Functions - PHPINI::getalloptions

Description This function retrieves a PHP configuration file's list of options. Warning:...

 cPanel API 2 Functions - PHPINI::getoptions

Description This function retrieves PHP directive configuration information. Warning: We...

 cPanel API 2 Functions - Park::listaddondomains

Description This function lists the cPanel account's addon domains. Warning: We strongly...

 cPanel API 2 Functions - Park::listparkeddomains

Description This function lists the cPanel account's parked domains. Warning: We strongly...

 cPanel API 2 Functions - Park::park

Description This function parks a domain on another domain. Warning: We strongly recommend...

 cPanel API 2 Functions - Park::unpark

Description This function removes a parked domain.  Warning: We strongly recommend that...

 cPanel API 2 Functions - Passwd::change_password

Description This function changes an account's password. Warning: We strongly recommend...

 cPanel API 2 Functions - Passwd::set_digest_auth

Description This function manages Digest Authentication on an account. Windows Vista®, Windows®...

 cPanel API 2 Functions - PasswdStrength::appstrengths

Description This function lists every application's minimum password strength. Warning: We...

 cPanel API 2 Functions - PasswdStrength::get_password_strength

Description This function checks a password's strength. Warning: We strongly recommend...

 cPanel API 2 Functions - PasswdStrength::get_required_strength

Description The application's required minimum password strength Warning: We strongly...

 cPanel API 2 Functions - Postgres::listdbs

Description This function lists a cPanel account's PostgreSQL® databases. Warning: We...

 cPanel API 2 Functions - Postgres::listusers

Description This function lists an account's PostgreSQL® database users. Warning: We...

 cPanel API 2 Functions - Postgres::listusersindb

Description This function lists the users with access to a PostgreSQL® database. Warning:...

 cPanel API 2 Functions - Postgres::userexists

Description This function checks whether a PostgreSQL® database user exists. Warning: We...

 cPanel API 2 Functions - Rand::getranddata

Description This function generates a random text string. Warning: We strongly recommend...

 cPanel API 2 Functions - Resellers::get_sub_accounts

Description This function lists all of a reseller's cPanel accounts. Warning: We strongly...

 cPanel API 2 Functions - RoR::addapp

Description This function adds a Ruby application. Warning: We strongly recommend that you...

 cPanel API 2 Functions - RoR::changeapp

Description This function changes a Ruby application's details. Warning: We strongly...

 cPanel API 2 Functions - RoR::importrails

Description This function searches the home directory for Ruby applications to import into...

 cPanel API 2 Functions - RoR::listapps

Description This function lists all of the cPanel account's Ruby on Rails applications....

 cPanel API 2 Functions - RoR::listrewrites

Description This function lists all of the mod_rewrite changes for the account's Ruby on Rails...

 cPanel API 2 Functions - RoR::needsimport

Description This function checks whether the server configured Ruby for the authenticated cPanel...

 cPanel API 2 Functions - RoR::removeapp

Description This function removes a Ruby application. Warning: We strongly recommend that...

 cPanel API 2 Functions - RoR::removerewrite

Description This function removes a rewrite from a Ruby application. Warning: We strongly...

 cPanel API 2 Functions - RoR::restartapp

Description This function restarts a Ruby application. Warning: We strongly recommend that...

 cPanel API 2 Functions - RoR::setuprewrite

Description This function adds a rewrite for a Ruby application. Warning: We strongly...

 cPanel API 2 Functions - RoR::softrestartapp

Description This function soft restarts a Ruby application. Warning: We strongly recommend...

 cPanel API 2 Functions - RoR::startapp

Description This function starts a Ruby application. Warning: We strongly recommend that...

 cPanel API 2 Functions - RoR::stopapp

Description This function stops a Ruby application. Warning: We strongly recommend that...

 cPanel API 2 Functions - SPFUI::available

Description This function checks SPF's availability for the account. Warning: We strongly...

 cPanel API 2 Functions - SPFUI::count_settings

Description This function returns the number of hosts that can send mail to an account....

 cPanel API 2 Functions - SPFUI::entries_complete

Description This function returns the number of complete SPF entries for an account. Warning:...

 cPanel API 2 Functions - SPFUI::get_raw_record

Description This function returns an account's raw SPF record. Warning: We strongly...

 cPanel API 2 Functions - SPFUI::getmainserverip

Description This function retrieves a server's main IP address. Warning: We strongly...

 cPanel API 2 Functions - SPFUI::install

Description This function installs Sender Policy Framework (SPF). Warning: We strongly...

 cPanel API 2 Functions - SPFUI::installed

Description This function checks the installation status of Sender Policy Framework (SPF)....

 cPanel API 2 Functions - SPFUI::list_settings

Description This function lists the account's SPF settings. Warning: We strongly recommend...

 cPanel API 2 Functions - SPFUI::load_current_values

Description This function returns the number of complete domain records and raw SPF records....

 cPanel API 2 Functions - SPFUI::uninstall

Description This function disables SPF. Warning: We strongly recommend that you use UAPI...

 cPanel API 2 Functions - SSH::authkey

Description This function authorizes an SSH key. Warning: We strongly recommend that you...

 cPanel API 2 Functions - SSH::converttoppk

Description This function converts an SSH key to PuTTY's PPK file format. This function returns...

 cPanel API 2 Functions - SSH::delkey

Description This function deletes an SSH key. Warning: We strongly recommend that you use...

 cPanel API 2 Functions - SSH::fetchkey

Description This function retrieves an SSH key. Warning: We strongly recommend that you...

 cPanel API 2 Functions - SSH::genkey

Description This function generates an SSH key. The new SSH key will appear in the user's .ssh...

 cPanel API 2 Functions - SSH::genkey_legacy

Description This function generates an SSH key. The new SSH key will appear in the user's .ssh...

 cPanel API 2 Functions - SSH::importkey

Description This function imports an SSH key. This function will overwrite an existing key with...

 cPanel API 2 Functions - SSH::listkeys

Description This function lists SSH keys. Warning: We strongly recommend that you use UAPI...

 cPanel API 2 Functions - SSL::fetchcabundle

Description This function retrieves a certificate's Certificate Authority (CA) bundle....

 cPanel API 2 Functions - SSL::gencrt

Description This function generates a self-signed certificate. Warning: We strongly...

 cPanel API 2 Functions - SSL::gencsr

Description This function generates a Certificate Signing Request (CSR). The system saves the...

 cPanel API 2 Functions - SSL::genkey

Description This function generates an SSL key. Warning: We strongly recommend that you...

 cPanel API 2 Functions - SSL::getcnname

Description This function lists SSL certificate information for a cPanel service. Warning:...

 cPanel API 2 Functions - SSL::installssl

Description This function installs an SSL certificate. Warning: We strongly recommend that...

 cPanel API 2 Functions - SSL::listcrts

Description This function lists the account's SSL certificates. Warning: We strongly...

 cPanel API 2 Functions - SSL::listcsrs

Description This function lists the host domains for the account's Certificate Signing Requests...

 cPanel API 2 Functions - SSL::listkeys

Description This function lists the account's SSL keys. Warning: We strongly recommend...

 cPanel API 2 Functions - SSL::listsslitems

Description This function lists the types of the account's installed SSL items. Warning:...

 cPanel API 2 Functions - SSL::uploadcrt

Description This function uploads an SSL certificate. When you call this function, the system...

 cPanel API 2 Functions - SSL::uploadkey

Description This function uploads an SSL key. When you call this function, the system copies the...

 cPanel API 2 Functions - SSLInfo::fetchinfo

Description This function retrieves an SSL certificate, private key, related CA bundle, and...

 cPanel API 2 Functions - SetLang::setlocale

Description This function sets the account's locale. Warning: We strongly recommend that...

 cPanel API 2 Functions - SourceIPCheck::addip

Description This function adds an IP address to the list of trusted IP addresses. Warning:...

 cPanel API 2 Functions - SourceIPCheck::delip

Description This function removes an IP address from the list of trusted IP addresses....

 cPanel API 2 Functions - SourceIPCheck::getaccount

Description This function retrieves the account to which the system will apply security...

 cPanel API 2 Functions - SourceIPCheck::listips

Description This function lists the account's trusted IP addresses. Warning: We strongly...

 cPanel API 2 Functions - SourceIPCheck::loadsecquestions

Description This function retrieves a specified set of security questions and answers....

 cPanel API 2 Functions - SourceIPCheck::resetsecquestions

Description This function removes security questions and answers for a specific cPanel or...

 cPanel API 2 Functions - SourceIPCheck::samplequestions

Description This function retrieves a list of sample security questions. Warning: We...

 cPanel API 2 Functions - SourceIPCheck::savesecquestions

Description This function saves a set of security questions and answers. The system uses these...

 cPanel API 2 Functions - StatCache::clearcache

Description This function clears the statistics programs' caches. Warning: We strongly...

 cPanel API 2 Functions - Stats::getmonthlybandwidth

Description This function displays a domain's monthly bandwidth statistics. Warning: We...

 cPanel API 2 Functions - Stats::getmonthlydomainbandwidth

Description This function displays a domain's bandwidth usage data by month. Warning: We...

 cPanel API 2 Functions - Stats::getthismonthsbwusage

Description This function displays a domain's bandwidth usage for the current month. Warning:...

 cPanel API 2 Functions - Stats::lastapachehits

Description This function retrieves the Apache log file's most recent hits to a domain....

 cPanel API 2 Functions - Stats::lastvisitors

Description This function retrieves a domain's last visitors. Warning: We strongly...

 cPanel API 2 Functions - Stats::listanalog

Description This function displays the domains that have Analog available. Warning: We...

 cPanel API 2 Functions - Stats::listawstats

Description This function displays domains that have AWStats web statistics available....

 cPanel API 2 Functions - Stats::listlastvisitors

Description This function displays the domains that have that have last visitors information...

 cPanel API 2 Functions - Stats::listrawlogs

Description This function displays the domains that have raw log downloads available....

 cPanel API 2 Functions - Stats::listurchin

Description This function displays the domains that have Urchin web statistics available....

 cPanel API 2 Functions - Stats::listwebalizer

Description This function displays domains that have Webalizer statistics available....

 cPanel API 2 Functions - StatsBar::getrowcounter

Description This function is for internal use only. Warning: We strongly recommend that...

 cPanel API 2 Functions - StatsBar::rowcounter

Description This function is for internal use only. Warning: We strongly recommend that...

 cPanel API 2 Functions - StatsBar::setrowcounter

Description This function is for internal use only. Warning: We strongly recommend that...

 cPanel API 2 Functions - StatsBar::stat

Description This function retrieves an account's statistics. Warning: We strongly...

 cPanel API 2 Functions - SubDomain::addsubdomain

Description This function creates a subdomain. Warning: We strongly recommend that you use...

 cPanel API 2 Functions - SubDomain::changedocroot

Description This function changes a subdomain's document root. Warning: We strongly...

 cPanel API 2 Functions - SubDomain::delsubdomain

Description This function deletes a subdomain. Warning: We strongly recommend that you use...

 cPanel API 2 Functions - SubDomain::getreservedsubdomains

Description This function returns a list of reserved subdomains. Warning: We strongly...

 cPanel API 2 Functions - SubDomain::listsubdomains

Description This function lists the cPanel account's subdomains. Warning: We strongly...

 cPanel API 2 Functions - SubDomain::validregex

Description This function returns a regular expression to use to validate a subdomain....

 cPanel API 2 Functions - Themes::apply_new_theme

Description This function is deprecated and does not return useful output. Warnings: We...

 cPanel API 2 Functions - Themes::does_cpanel_theme_exist

Description This function is deprecated and does not return useful output. Warning: We...

 cPanel API 2 Functions - Themes::get_available_themes

Description This function lists available themes. Warning: We strongly recommend that you...

 cPanel API 2 Functions - Themes::get_themes_list

Description This function is deprecated and does not return useful output. Warning: We...

 cPanel API 2 Functions - Themes::restore_saved_theme

Description This function is deprecated and does not return useful output. Warning: We...

 cPanel API 2 Functions - UI::dynamicincludelist

Description This function is deprecated and does not return useful output. Warning: We...

 cPanel API 2 Functions - UI::includelist

Description This function is deprecated and does not return useful output. Warning: We...

 cPanel API 2 Functions - UI::listform

Description This function is deprecated and does not return useful output. Warning: We...

 cPanel API 2 Functions - UI::paginate

Description This function is deprecated and does not return useful output. Warning: We...

 cPanel API 2 Functions - UI::paginate_list

Description This function is deprecated and does not return useful output. Warning: We...

 cPanel API 2 Functions - UserHttpUtils::getdirindices

Description This function retrieves a prioritized list of index files. The first file in the...

 cPanel API 2 Functions - WebDisk::addwebdisk

Description This function creates a Web Disk account. Warning: We strongly recommend that...

 cPanel API 2 Functions - WebDisk::delwebdisk

Description This function deletes a Web Disk account. Warning: We strongly recommend that...

 cPanel API 2 Functions - WebDisk::hasdigest

Description This function checks the account's Digest Authentication status. Warning: We...

 cPanel API 2 Functions - WebDisk::listwebdisks

Description This function lists a cPanel account's Web Disk accounts. Warning: We strongly...

 cPanel API 2 Functions - WebDisk::passwdwebdisk

Description This function changes a Web Disk account's password Warning: We strongly...

 cPanel API 2 Functions - WebDisk::set_digest_auth

Description This function manages a Web Disk account's Digest Authentication status. Warning:...

 cPanel API 2 Functions - WebDisk::set_homedir

Description This function manages a Web Disk account's home directory. Warning: We...

 cPanel API 2 Functions - WebDisk::set_perms

Description This function manages a Web Disk account's permissions. Warning: We strongly...

 cPanel API 2 Functions - WebDisk::setstatus

Description This function changes a Web Disk account's permissions. Warning: We strongly...

 cPanel API 2 Functions - WebmailApps::listwebmailapps

Description This function retrieves information about an account's Webmail applications....

 cPanel API 2 Functions - ZoneEdit::add_zone_record

Description This function adds a new zone record. Warning: We strongly recommend that you...

 cPanel API 2 Functions - ZoneEdit::edit_zone_record

Description This function edits a zone record. Warning: We strongly recommend that you use...

 cPanel API 2 Functions - ZoneEdit::fetch_cpanel_generated_domains

Description This function fetches zone files that cPanel generated for the account. Warning:...

 cPanel API 2 Functions - ZoneEdit::fetchzone

Description This function retrieves a zone file. Warning: We strongly recommend that you...

 cPanel API 2 Functions - ZoneEdit::fetchzone_records

Description This function retrieves the domain's zone record modifications. Warning: We...

 cPanel API 2 Functions - ZoneEdit::fetchzones

Description This function fetches all of the account's zone files. Warning: We strongly...

 cPanel API 2 Functions - ZoneEdit::get_zone_record

Description This function retrieves the domain's zone record.  Warnings: This function...

 cPanel API 2 Functions - ZoneEdit::remove_zone_record

Description This function removes a zone record. Warning: We strongly recommend that you...

 cPanel API 2 Functions - ZoneEdit::resetzone

Description This function resets a zone file to its original state. Warning: We strongly...