Guide to cPanel API 2

Return Data

Filter and Sort Output

Paginate Output

Output Columns

Calls from the WHM API

cPanel Tags
(deprecated) 

AddonDomain:: addaddondomain

AddonDomain:: deladdondomain

AddonDomain:: listaddondomains


Backups:: listfullbackups


Bandwidth:: addhttpbandwidth

Bandwidth:: getbwdata

Bandwidth:: gethourlyaveragebwoveryear


BoxTrapper:: accountmanagelist


Branding:: addbrandingobj

Branding:: applist

Branding:: brandingeditor

Branding:: createpkg

Branding:: cssmerge

Branding:: delbrandingobj

Branding:: delpkg

Branding:: gensprites

Branding:: getbrandingpkg

Branding:: getbrandingpkgstatus

Branding:: getdefaultbrandingpkg

Branding:: installbrandingpkgs

Branding:: installimages

Branding:: killimgs

Branding:: listimgtypes

Branding:: listobjecttypes

Branding:: preloadconf

Branding:: resetall

Branding:: resetcss

Branding:: resethtml

Branding:: resolve_file

Branding:: resolvelocalcss

Branding:: savelocalcss

Branding:: setbrandingpkgstatus

Branding:: showpkgs

Branding:: spritelist


CSVImport:: columnchoices

CSVImport:: configimport

CSVImport:: data

CSVImport:: fetchimportdata

CSVImport:: isenabled

CSVImport:: loaddata

CSVImport:: processdata

CSVImport:: sendcontact

CSVImport:: uploadimport


Contactus:: isenabled

Contactus:: sendcontact


Cron:: add_line

Cron:: edit_line

Cron:: fetchcron

Cron:: get_email

Cron:: listcron

Cron:: remove_line

Cron:: set_email


CustInfo:: contactemails

CustInfo:: contactprefs

CustInfo:: displaycontactinfo

CustInfo:: savecontactinfo


DBmap:: status

DBmap:: version


DKIMUI:: available

DKIMUI:: getrecords

DKIMUI:: install

DKIMUI:: installed

DKIMUI:: uninstall


DenyIp:: listdenyips


DiskCounter:: disk_counter


DiskUsage:: buildcache

DiskUsage:: clearcache

DiskUsage:: fetch_raw_disk_usage

DiskUsage:: fetchdiskusage

DiskUsage:: fetchdiskusagewithextras


DnsLookup:: name2ip


DomainLookup:: countbaseddomains

DomainLookup:: getbasedomains

DomainLookup:: getdocroot

DomainLookup:: getdocroots

DomainLookup:: getmaindomain


Email:: accountname

Email:: adddomainforward

Email:: addforward

Email:: addmx

Email:: addpop

Email:: browseboxes

Email:: changemx

Email:: checkmaindiscard

Email:: clearpopcache

Email:: deletefilter

Email:: delforward

Email:: delmx

Email:: delpop

Email:: disablefilter

Email:: editquota

Email:: enablefilter

Email:: fetchautoresponder

Email:: fetchcharmaps

Email:: filteractions

Email:: filterlist

Email:: filtername

Email:: filterrules

Email:: get_archiving_configuration

Email:: get_archiving_default_configuration

Email:: get_archiving_types

Email:: get_default_email_quota

Email:: get_email_signing

Email:: get_max_email_quota

Email:: getabsbrowsedir

Email:: getalwaysaccept

Email:: getdiskusage

Email:: getmxcheck

Email:: has_delegated_mailman_lists

Email:: list_system_filter_info

Email:: listaliasbackups

Email:: listautoresponders

Email:: listdefaultaddresses

Email:: listdomainforwards

Email:: listfilterbackups

Email:: listfilters

Email:: listforwards

Email:: listlists

Email:: listmaildomains

Email:: listmx

Email:: listmxs

Email:: listpops

Email:: listpopssingle

Email:: listpopswithdisk

Email:: listpopswithimage

Email:: loadfilter

Email:: passwdpop

Email:: reorderfilters

Email:: set_archiving_configuration

Email:: set_archiving_default_configuration

Email:: set_email_signing

Email:: setalwaysaccept

Email:: setdefaultaddress

Email:: setmxcheck

Email:: storefilter

Email:: tracefilter


EmailTrack:: search

EmailTrack:: stats

EmailTrack:: trace


Encoding:: get_encodings

Encoding:: guess_file

Encoding:: guess_file_opts


FSTest:: dirisempty


Fileman:: autocompletedir

Fileman:: fileop

Fileman:: getabsdir

Fileman:: getdir

Fileman:: getdiractions

Fileman:: getdiskinfo

Fileman:: getedittype

Fileman:: getfileactions

Fileman:: getpath

Fileman:: listfiles

Fileman:: mkdir

Fileman:: mkfile

Fileman:: savefile

Fileman:: search

Fileman:: statfiles

Fileman:: uploadfiles

Fileman:: viewfile


ForcePassword:: get_force_password_flags

ForcePassword:: update_force_password_flags


Frontpage:: fpenabled

Frontpage:: list


Ftp:: addftp

Ftp:: delftp

Ftp:: listftp

Ftp:: listftpsessions

Ftp:: listftpwithdisk

Ftp:: passwd

Ftp:: setquota


Gpg:: listgpgkeys

Gpg:: listsecretgpgkeys

Gpg:: number_of_private_keys

Gpg:: number_of_public_keys


Htaccess:: listuser

Htaccess:: listusers


HttpUtils:: getdirindices


ImageManager:: thumbnail


LVEInfo:: getUsage


LangMods:: getarchname

LangMods:: getkey

LangMods:: getprefix

LangMods:: install

LangMods:: langlist

LangMods:: list_available

LangMods:: list_installed

LangMods:: magic_status

LangMods:: pre_run

LangMods:: search

LangMods:: setup

LangMods:: uninstall

LangMods:: update


LeechProtect:: setup


Locale:: get_encoding

Locale:: get_html_dir_attr

Locale:: get_locale_name

Locale:: get_user_locale

Locale:: get_user_locale_name

Locale:: numf


Logaholic:: adduser

Logaholic:: adduserprofile

Logaholic:: deleteuser

Logaholic:: deleteuserprofile

Logaholic:: edituser

Logaholic:: fetchuser

Logaholic:: listuserprofiles

Logaholic:: logaholiclink

Logaholic:: processstats


Mime:: list_hotlinks

Mime:: listhandlers

Mime:: listmime

Mime:: listredirects

Mime:: redirectname

Mime:: redirecturlname


MysqlFE:: authorizehost

MysqlFE:: changedbuserpassword

MysqlFE:: createdb

MysqlFE:: createdbuser

MysqlFE:: dbuserexists

MysqlFE:: deauthorizehost

MysqlFE:: deletedb

MysqlFE:: deletedbuser

MysqlFE:: getalldbsinfo

MysqlFE:: getalldbusersanddbs

MysqlFE:: getdbuserprivileges

MysqlFE:: getdbusers

MysqlFE:: gethosts

MysqlFE:: getmysqlprivileges

MysqlFE:: getmysqlserverprivileges

MysqlFE:: has_mycnf_for_cpuser

MysqlFE:: listdbs

MysqlFE:: listdbsbackup

MysqlFE:: listhosts

MysqlFE:: listusers

MysqlFE:: listusersindb

MysqlFE:: revokedbuserprivileges

MysqlFE:: setdbuserprivileges

MysqlFE:: userdbprivs


MysqlOptimizer:: fetch_slow_queries


NVData:: get

NVData:: set

NVData:: setall


Net:: dnszone

Net:: traceroute


News:: does_news_exist

News:: does_news_type_exist

News:: get_news


PHPINI:: getalloptions

PHPINI:: getoptions


Park:: listaddondomains

Park:: listparkeddomains

Park:: park

Park:: unpark


Passwd:: change_password

Passwd:: set_digest_auth


PasswdStrength:: appstrengths

PasswdStrength:: get_password_strength

PasswdStrength:: get_required_strength


Postgres:: listdbs

Postgres:: listusers

Postgres:: listusersindb

Postgres:: userexists


Rand:: getranddata


Resellers:: get_sub_accounts


RoR:: addapp

RoR:: changeapp

RoR:: importrails

RoR:: listapps

RoR:: listrewrites

RoR:: needsimport

RoR:: removeapp

RoR:: removerewrite

RoR:: restartapp

RoR:: setuprewrite

RoR:: softrestartapp

RoR:: startapp

RoR:: stopapp


SetLang:: setlocale


SourceIPCheck:: addip

SourceIPCheck:: delip

SourceIPCheck:: getaccount

SourceIPCheck:: listips

SourceIPCheck:: loadsecquestions

SourceIPCheck:: resetsecquestions

SourceIPCheck:: samplequestions

SourceIPCheck:: savesecquestions


SPFUI:: available

SPFUI:: count_settings

SPFUI:: entries_complete

SPFUI:: get_raw_record

SPFUI:: getmainserverip

SPFUI:: install

SPFUI:: installed

SPFUI:: list_settings

SPFUI:: load_current_values

SPFUI:: uninstall


SSH:: authkey

SSH:: converttoppk

SSH:: delkey

SSH:: fetchkey

SSH:: genkey

SSH:: genkey_legacy

SSH:: importkey

SSH:: listkeys


SSL:: fetchcabundle

SSL:: fetchinfo

SSL:: gencrt

SSL:: gencsr

SSL:: genkey

SSL:: getcnname

SSL:: installssl

SSL:: listcrts

SSL:: listcsrs

SSL:: listkeys

SSL:: listsslitems

SSL:: uploadcrt

SSL:: uploadkey


SSLInfo:: fetchinfo



StatCache:: clearcache


Stats:: getmonthlybandwidth

Stats:: getmonthlydomainbandwidth

Stats:: getthismonthsbwusage

Stats:: lastapachehits

Stats:: lastvisitors

Stats:: listanalog

Stats:: listawstats

Stats:: listlastvisitors

Stats:: listrawlogs

Stats:: listurchin

Stats:: listwebalizer


StatsBar:: getrowcounter

StatsBar:: rowcounter

StatsBar:: setrowcounter

StatsBar:: stat


SubDomain:: addsubdomain

SubDomain:: changedocroot

SubDomain:: delsubdomain

SubDomain:: getreservedsubdomains

SubDomain:: listsubdomains

SubDomain:: validregex


Themes:: apply_new_theme

Themes:: does_cpanel_theme_exist

Themes:: get_available_themes

Themes:: get_themes_list

Themes:: restore_saved_theme


UI:: dynamicincludelist

UI:: includelist

UI:: listform

UI:: paginate

UI:: paginate_list


UserHttpUtils:: getdirindices


WebDisk:: addwebdisk

WebDisk:: delwebdisk

WebDisk:: hasdigest

WebDisk:: listwebdisks

WebDisk:: passwdwebdisk

WebDisk:: set_digest_auth

WebDisk:: set_homedir

WebDisk:: set_perms

WebDisk:: setstatus


WebmailApps:: listwebmailapps


ZoneEdit:: add_zone_record

ZoneEdit:: edit_zone_record

ZoneEdit:: fetch_cpanel_generated_domains

ZoneEdit:: fetchzone

ZoneEdit:: fetchzone_records

ZoneEdit:: fetchzones

ZoneEdit:: get_zone_record

ZoneEdit:: remove_zone_record

ZoneEdit:: resetzone