Title: Guide to cPanel API 1  
Author: Documentation Feb 14, 2018
Last Changed by: Documentation Oct 18, 2018
Tiny Link: (useful for email) https://documentation.cpanel.net/x/swS
Export As: Word · PDF  
Incoming Links
cPanel Knowledge Base (1)
    Page: How to Use cPanel API Tokens
Version 80 Documentation (2)
    Page: Manage API Tokens in cPanel
    Page: Edit Reseller Nameservers and Privileges
Version 78 Documentation (1)
    Page: Edit Reseller Nameservers and Privileges
Version 74 Documentation (1)
    Page: Edit Reseller Nameservers and Privileges
Version 72 Documentation (1)
    Page: Edit Reseller Nameservers and Privileges
Version 76 Documentation (1)
    Page: Edit Reseller Nameservers and Privileges
Include Library (7)
    Page: _XMLDeprecated
    Page: _APICHART2 v2
    Page: _APICHART2
    Page: _cPanelAPI1Menu
    Page: _TTSide
    Page: _LiveAPIGuideMenu
    Page: _cPanelAPI1CLINote
Developer Documentation (289)
    Page: cPanel API 1 Functions - BoxTrapper::showmessage
    Page: cPanel API 1 Functions - Gpg::deletekey
    Page: cPanel API 1 Functions - Email::listmaildomainsopt
    Page: cPanel API 1 Functions - Fileman::restoredb
    Page: cPanel API 1 Functions - Fileman::htmleditor
    Page: cPanel API 1 Functions - SSL::showkey
    Page: cPanel API 1 Functions - Ftp::set_welcomemsg
    Page: cPanel API 1 Functions - Mysql::adddb
    Page: cPanel API 1 Functions - ProxyUtils::proxyaddress
    Page: cPanel API 1 Functions - Htaccess::htdirls
    Page: cPanel API 1 Functions - SSL::install
    Page: cPanel API 1 Functions - Ftp::ftpservername
    Page: cPanel API 1 Functions - SubDomain::disablesubrd
    Page: cPanel API 1 Functions - BoxTrapper::status
    Page: cPanel API 1 Functions - Email::editquota
    Page: cPanel API 1 Functions - Fileman::fmsavefile
    Page: cPanel API 1 Functions - Mysql::listdbsopt
    Page: WHM API 1 Functions - setacls
    Page: cPanel API 1 Functions - Email::addfilter
    Page: cPanel API 1 Functions - SSL::uploadcrt
    Page: cPanel API 1 Functions - Branding::tempsetbrandingpkg
    Page: cPanel API 1 Functions - Mysql::routines
    Page: cPanel API 1 Functions - Mysql::delhost
    Page: cPanel API 1 Functions - Postgres::listdbsopt
    Page: cPanel API 1 Functions - Fileman::delfile
    Page: cPanel API 1 Functions - Park::getredirecturl
    Page: cPanel API 1 Functions - Branding::setmyacctspkg
    Page: cPanel API 1 Functions - Ftp::set_anonftpin
    Page: cPanel API 1 Functions - Htaccess::number_of_users
    Page: cPanel API 1 Functions - Fileman::emptytrash
    Page: cPanel API 1 Functions - ImageManager::scale
    Page: cPanel API 1 Functions - SetLang::setlang
    Page: cPanel API 1 Functions - Mysql::listusersopt
    Page: cPanel API 1 Functions - ImageManager::dimensions
    Page: cPanel API 1 Functions - Htaccess::set_pass
    Page: cPanel API 1 Functions - StatManager::updateUserConfig
    Page: cPanel API 1 Functions - Email::enable_spam_autodelete
    Page: cPanel API 1 Functions - LeechProtect::status
    Page: cPanel API 1 Functions - Cgi::phpmyadminlink
    Page: cPanel API 1 Functions - Htaccess::del_user
    Page: cPanel API 1 Functions - SubDomain::listsubdomainsop
    Page: cPanel API 1 Functions - Htaccess::setphpreference
    Page: Guide to Testing Custom Code - cPanel API and UAPI Calls
    Page: cPanel API 1 Functions - BoxTrapper::cleancfgfilelist
    Page: cPanel API 1 Functions - Htaccess::setindex
    Page: cPanel API 1 Functions - Ftp::get_anonftp
    Page: cPanel API 1 Functions - Mime::linkurls
    Page: cPanel API 1 Functions - Resellers::accountlistopt
    Page: cPanel API 1 Functions - SSL::deletecrt
    Page: cPanel API 1 Functions - SSL::gencsr
    Page: cPanel API 1 Functions - SSH::getport
    Page: cPanel API 1 Functions - Mime::linkenable
    Page: Guide to Standardized Hooks - Function Hooks
    Page: cPanel API 1 Functions - Htaccess::showusers
    Page: cPanel API 1 Functions - Email::adddforward
    Page: cPanel API 1 Functions - Fileman::changeperm
    Page: cPanel API 1 Functions - Htaccess::getindex
    Page: cPanel API 1 Functions - BoxTrapper::showqueuesearch
    Page: cPanel API 1 Functions - BoxTrapper::logcontrols
    Page: cPanel API 1 Functions - DenyIp::adddenyip
    Page: cPanel API 1 Functions - UI::confirm
    Page: cPanel API 1 Functions - Email::tracefilter
    Page: cPanel API 1 Functions - Gpg::genkey
    Page: cPanel API 1 Functions - Mime::linkrurl
    Page: cPanel API 1 Functions - Postgres::adddb
    Page: cPanel API 1 Functions - Bandwidth::displaymainbwheader
    Page: cPanel API 1 Functions - DenyIp::listdenyips
    Page: cPanel API 1 Functions - Email::listmaildomains
    Page: cPanel API 1 Functions - Email::passwdpop
    Page: cPanel API 1 Functions - SubDomain::cplistsubdomains
    Page: cPanel API 1 Functions - SSL::gencrt
    Page: cPanel API 1 Functions - LastLogin::lastlogin
    Page: cPanel API 1 Functions - Email::delfilter
    Page: cPanel API 1 Functions - BoxTrapper::editmsg
    Page: cPanel API 1 Functions - Park::setredirecturl
    Page: cPanel API 1 Functions - LogManager::listdownloads
    Page: cPanel API 1 Functions - Mime::add_redirect
    Page: cPanel API 1 Functions - Fileman::fmsavehtmlfile
    Page: cPanel API 1 Functions - Gpg::exportkey
    Page: cPanel API 1 Functions - Email::getarssubject
    Page: cPanel API 1 Functions - SpamAssassin::saveconfig
    Page: cPanel API 1 Functions - UI::showresult
    Page: cPanel API 1 Functions - BoxTrapper::getboxconfdir
    Page: cPanel API 1 Functions - Cgi::backuplink
    Page: cPanel API 1 Functions - Gpg::importkeys
    Page: cPanel API 1 Functions - BoxTrapper::showfromname
    Page: cPanel API 1 Functions - Mysql::deluserdb
    Page: cPanel API 1 Functions - BoxTrapper::showqueue
    Page: cPanel API 1 Functions - Fileman::killdir
    Page: cPanel API 1 Functions - Email::spamboxstatus
    Page: cPanel API 1 Functions - Stats::lastvisitors
    Page: cPanel API 1 Functions - Cgi::displayurchin
    Page: cPanel API 1 Functions - Email::addspamfilter
    Page: cPanel API 1 Functions - Mime::add_mime
    Page: cPanel API 1 Functions - Ftp::addftp
    Page: cPanel API 1 Functions - Fileman::getfile
    Page: cPanel API 1 Functions - SSL::listkeysopt
    Page: cPanel API 1 Functions - Bandwidth::displayday
    Home page: Developer Documentation Home
    Page: cPanel API 1 Functions - Chkservd::geteximport_ssl
    Page: cPanel API 1 Functions - Fileman::restorefile
    Page: cPanel API 1 Functions - Email::addpop
    Page: cPanel API 1 Functions - Branding::setupdirs
    Page: cPanel API 1 Functions - Email::getarscharset
    Page: cPanel API 1 Functions - Email::getarshtml
    Page: cPanel API 1 Functions - SubDomain::setsuburl
    Page: cPanel API 1 Functions - Fileman::fmmkdir
    Page: cPanel API 1 Functions - BoxTrapper::listmsgs
    Page: cPanel API 1 Functions - Cron::crontab_perms
    Page: cPanel API 1 Functions - Email::getarsstop
    Page: cPanel API 1 Functions - Ftp::getftpquota
    Page: cPanel API 1 Functions - Gpg::exportsecretkey
    Page: cPanel API 1 Functions - Net::dnslookup
    Page: cPanel API 1 Functions - Mime::add_handler
    Page: cPanel API 1 Functions - Mysql::adduser
    Page: cPanel API 1 Functions - Email::delspam
    Page: cPanel API 1 Functions - Fileman::listfiles
    Page: cPanel API 1 Functions - Mysql::checkdb
    Page: cPanel API 1 Functions - Mysql::gethost
    Page: cPanel API 1 Functions - LeechProtect::setup
    Page: cPanel API 1 Functions - Bandwidth::displaybw
    Page: cPanel API 1 Functions - BoxTrapper::messageaction
    Page: cPanel API 1 Functions - Resellers::themelistopt
    Page: cPanel API 1 Functions - SubDomain::addsubdomain
    Page: cPanel API 1 Functions - SSL::deletecsr
    Page: cPanel API 1 Functions - Fileman::restoreaf
    Page: cPanel API 1 Functions - Park::park
    Page: cPanel API 1 Functions - FrontPage::fpstatus
    Page: cPanel API 1 Functions - Email::getaging
    Page: cPanel API 1 Functions - Email::changemx
    Page: cPanel API 1 Functions - ImageManager::wdimension
    Page: Guide to Testing Custom Code - API Authentication
    Page: cPanel API 1 Functions - Mime::linkexts
    Page: Guide to the LiveAPI System - The api() Method
    Page: Guide to Template Toolkit - API Calls from Template Toolkit
    Page: WHM API 0 Functions - saveacllist
    Page: cPanel API 1 Functions - Fileman::fmmkfile
    Page: cPanel API 1 Functions - Email::getarsstart
    Page: cPanel API 1 Functions - ImageManager::hdimension
    Page: cPanel API 1 Functions - Email::has_spam_autodelete
    Page: cPanel API 1 Functions - BoxTrapper::savecfgfile
    Page: cPanel API 1 Functions - OptimizeWS::loadoptimizesettings - bytes
    Page: cPanel API 1 Functions - SetLang::listlangsopt
    Page: cPanel API 1 Functions - BoxTrapper::showemails
    Page: cPanel API 1 Functions - Email::delmx
    Page: cPanel API 1 Functions - Postgres::deldb
    Page: cPanel API 1 Functions - Stats::errlog
    Page: cPanel API 1 Functions - Postgres::deluser
    Page: cPanel API 1 Functions - Ftp::get_anonftpin
    Page: WHM API 1 Functions - saveacllist
    Page: cPanel API 1 Functions - Email::passwdlist
    Page: cPanel API 1 Functions - Mime::del_redirect
    Page: cPanel API 1 Functions - Email::dellist
    Page: cPanel API 1 Functions - Email::getarsfrom
    Page: cPanel API 1 Functions - Fileman::dofileop
    Page: Guide to Testing Custom Code
    Page: cPanel API 1 Functions - Bandwidth::displaybwheader
    Page: cPanel API 1 Functions - ClamScanner::bars
    Page: cPanel API 1 Functions - Htaccess::phpselectable
    Page: cPanel API 1 Functions - Mime::linkallownull
    Page: cPanel API 1 Functions - NVData::set
    Page: cPanel API 1 Functions - BoxTrapper::fetchcfgfile
    Page: cPanel API 1 Functions - BoxTrapper::multimessageaction
    Page: cPanel API 1 Functions - LeechProtect::enable
    Page: cPanel API 1 Functions - Mime::add_hotlink
    Page: cPanel API 1 Functions - Htaccess::set_protect
    Page: cPanel API 1 Functions - LogManager::showsettings
    Page: cPanel API 1 Functions - SSL::showcrt
    Page: cPanel API 1 Functions - SSL::showcsr
    Page: cPanel API 1 Functions - Mysql::number_of_users
    Page: Guide to Standardized Hooks - Cpanel Functions
    Page: cPanel API 1 Functions - Email::addlist
    Page: cPanel API 1 Functions - FrontPage::delfp
    Page: cPanel API 1 Functions - StatManager::doForm
    Page: cPanel API 1 Functions - Email::getarsinterval
    Page: cPanel API 1 Functions - Stats::bwbar
    Page: cPanel API 1 Functions - OptimizeWS::optimizews
    Page: cPanel API 1 Functions - Mime::del_hotlink
    Page: cPanel API 1 Functions - Branding::killimg
    Page: cPanel API 1 Functions - Htaccess::checkprotected
    Page: cPanel API 1 Functions - SSL::delete
    Page: cPanel API 1 Functions - Email::delspambox
    Page: cPanel API 1 Functions - Email::mainacctdiskused
    Page: cPanel API 1 Functions - Postgres::deluserdb
    Page: cPanel API 1 Functions - Fileman::restorefiles
    Page: cPanel API 1 Functions - Email::disable_spam_autodelete
    Page: cPanel API 1 Functions - Postgres::adduser
    Page: cPanel API 1 Functions - SSL::getcabundle
    Page: WHM API 1 Functions - listacls
    Page: cPanel API 1 Functions - Postgres::initcache
    Page: cPanel API 1 Functions - SSL::deletekey
    Page: cPanel API 1 Functions - UI::redirect
    Page: cPanel API 1 Functions - FrontPage::addfp
    Page: cPanel API 1 Functions - Net::dnszone
    Page: cPanel API 1 Functions - Stats::showbandwidth
    Page: cPanel API 1 Functions - Fileman::savehtmlfile
    Page: cPanel API 1 Functions - SSL::getcnname
    Page: Guide to the LiveAPI System - The exec() Method
    Page: cPanel API 1 Functions - DiskUsage::showmanager
    Page: cPanel API 1 Functions - Fileman::fmpushfile
    Page: cPanel API 1 Functions - Email::addspam
    Page: cPanel API 1 Functions - Email::has_spam_as_acl
    Page: cPanel API 1 Functions - Stats::webalizer
    Page: cPanel API 1 Functions - BoxTrapper::showqueuetime
    Page: cPanel API 1 Functions - Email::delpop
    Page: cPanel API 1 Functions - LogManager::savesettings
    Page: cPanel API 1 Functions - Email::listmaildomainsoptndef
    Page: WHM API 0 Functions - listacls
    Page: cPanel API 1 Functions - Stats::webalizerftp
    Page: cPanel API 1 Functions - Email::checkpipefwd
    Page: cPanel API 1 Functions - Stats::analoglist
    Page: cPanel API 1 Functions - MagicRevision::uri
    Page: cPanel API 1 Functions - Email::getarsbody
    Page: cPanel API 1 Functions - Fileman::listfullbackups
    Page: cPanel API 1 Functions - Mysql::repairdb
    Page: cPanel API 1 Functions - News::displaynews
    Page: cPanel API 1 Functions - OptimizeWS::loadoptimizesettings
    Page: cPanel API 1 Functions - Mysql::initcache
    Page: cPanel API 1 Functions - Park::unpark
    Page: cPanel API 1 Functions - BoxTrapper::statusbutton
    Page: cPanel API 1 Functions - Email::getmailserver
    Page: cPanel API 1 Functions - Mime::del_handler
    Page: cPanel API 1 Functions - Mysql::deldb
    Page: cPanel API 1 Functions - Fileman::extractfile
    Page: cPanel API 1 Functions - Ftp::kill_ftp_session
    Page: cPanel API 1 Functions - Ftp::passwdftp
    Page: cPanel API 1 Functions - Email::setmxaccept
    Page: cPanel API 1 Functions - Ftp::set_anonftp
    Page: cPanel API 1 Functions - Email::getmailserveruser
    Page: cPanel API 1 Functions - Ftp::ftpstatslogin
    Page: cPanel API 1 Functions - Mysql::addhost
    Page: cPanel API 1 Functions - SSL::genkey
    Page: cPanel API 1 Functions - Mysql::deluser
    Page: cPanel API 1 Functions - Branding::file
    Page: cPanel API 1 Functions - Stats::awstats
    Page: cPanel API 1 Functions - BoxTrapper::changestatus
    Page: cPanel API 1 Functions - CustInfo::getemail
    Page: cPanel API 1 Functions - BoxTrapper::showautowhitelist
    Page: cPanel API 1 Functions - ImageManager::convert
    Page: cPanel API 1 Functions - Ftp::get_welcomemsg
    Page: cPanel API 1 Functions - Fileman::showperm
    Page: cPanel API 1 Functions - Fileman::fmrename
    Page: cPanel API 1 Functions - Mysql::listusers
    Page: cPanel API 1 Functions - Htaccess::resname
    Page: cPanel API 1 Functions - LeechProtect::disable
    Page: cPanel API 1 Functions - Ftp::delftp
    Page: cPanel API 1 Functions - Fileman::listtemplates
    Page: cPanel API 1 Functions - Chkservd::geteximport
    Page: cPanel API 1 Functions - Ftp::ftpquota
    Page: cPanel API 1 Functions - SSL::sslsharedstatus
    Page: cPanel API 1 Functions - Fileman::uploadfiles
    Page: cPanel API 1 Functions - Mysql::updateprivs
    Page: cPanel API 1 Functions - Mime::del_mime
    Page: cPanel API 1 Functions - Fileman::viewfile
    Page: WHM API 0 Functions - setacls
    Page: cPanel API 1 Functions - Postgres::number_of_users
    Page: cPanel API 1 Functions - cPAddons::mainpg
    Page: cPanel API 1 Functions - Mysql::number_of_dbs
    Page: cPanel API 1 Functions - Postgres::listusersopt
    Page: cPanel API 1 Functions - Email::addautoresponder
    Page: cPanel API 1 Functions - Email::delautoresponder
    Page: cPanel API 1 Functions - Ftp::listftpstatsurl
    Page: cPanel API 1 Functions - ImageManager::thumbnail
    Page: cPanel API 1 Functions - Fileman::fullbackup
    Page: cPanel API 1 Functions - Postgres::adduserdb
    Page: cPanel API 1 Functions - Branding::image
    Page: cPanel API 1 Functions - Branding::setbrandingpkg
    Page: cPanel API 1 Functions - Email::spamstatus
    Page: cPanel API 1 Functions - SpamAssassin::config
    Page: cPanel API 1 Functions - SSL::installedhost
    Page: cPanel API 1 Functions - Fileman::fileimg
    Page: cPanel API 1 Functions - Mysql::adduserdb
    Page: cPanel API 1 Functions - LeechProtect::showpasswdfile
    Page: cPanel API 1 Functions - Email::addmx
    Page: cPanel API 1 Functions - Mysql::listdbs
    Page: cPanel API 1 Functions - Postgres::number_of_dbs
    Page: cPanel API 1 Functions - BoxTrapper::saveconf
    Page: cPanel API 1 Functions - Email::checkfastmail
    Page: cPanel API 1 Functions - DenyIp::deldenyip
    Page: cPanel API 1 Functions - Email::deldforward
    Page: cPanel API 1 Functions - BoxTrapper::showlog
    Page: cPanel API 1 Functions - Serverinfo::servicestatus
    Page: cPanel API 1 Functions - SSL::uploadkey
    Page: Guide to the LiveAPI System - LiveAPI Methods
    Page: cPanel API 1 Functions - Park::disableredirect
    Page: cPanel API 1 Functions - Email::getpopquota
    Page: cPanel API 1 Functions - BoxTrapper::resetmsg
    Page: cPanel API 1 Functions - Net::sethastraceroute
    Page: Quickstart Development Guide - cPanel
Version 70 Documentation (1)
    Page: Edit Reseller Nameservers and Privileges
Version 68 Documentation (1)
    Page: Edit Reseller Nameservers and Privileges
Hierarchy
Parent Page
    Home page: Developer Documentation Home
Children (43)
    Page: cPanel API 1 - Deprecated cPanel Tag Usage
    Page: cPanel API 1 Modules - Bandwidth
    Page: cPanel API 1 Modules - BoxTrapper
    Page: cPanel API 1 Modules - Branding
    Page: cPanel API 1 Modules - Cgi
    Page: cPanel API 1 Modules - Chkservd
    Page: cPanel API 1 Modules - ClamScanner
    Page: cPanel API 1 Modules - cPAddons
    Page: cPanel API 1 Modules - Cron
    Page: cPanel API 1 Modules - CustInfo
Labels
Global Labels (2)
Outgoing Links
External Links (2)
    https://en.wikipedia.org/wiki/Escape_character
    https://en.wikipedia.org/wiki/Percent-encoding
Include Library (11)     Page: _PageURLWarning
    Page: _ServerProfilesDisabledAPI
    Page: _cPanelAPI1Menu
    Page: _XMLDeprecated
    Page: _cPanelAPI1Deprecated
    Page: _LiveAPIPHPLink
    Page: _TTLink
    Page: _cPanelAPI1Basics
    Page: _BooleanNote
    Page: _cPanelTagsWarning
    Page: _LiveAPIPerlLink
Developer Documentation (4)     Page: Guide to Testing Custom Code
    Page: Guide to Standardized Hooks
    Page: Use WHM API to Call cPanel API and UAPI
    Page: Guide to cPanel API 1