The LiveAPI system uses the following methods to interact with cPanel & WHM. Use these methods with either the LiveAPI PHP Class or the LiveAPI Perl Module.
- For more information about methods in PHP classes, read php.net's Classes and Objects documentation.
- For more information about methods in Perl, read perl.org's perlobj documentation.
The LiveAPI system includes the following methods to interact with cPanel & WHM:
api()method executes a cPanel API 1 or cPanel API 2 function.
api1()function executes a cPanel API 1 function. For use information and examples, read our Guide to cPanel API 1.
api2()function executes a cPanel API 2 function. For use information and examples, read our Guide to cPanel API 2.
cpanelfeature()method is a wrapper for the
featuretag, which checks whether the authenticated user has access to a feature.
cpanelif()method is a wrapper for the
cpaneliftag, which evaluates a cPanel variable or logic operator.
cpanellangprint()method is a wrapper for the deprecated lang system's
langprinttag. This method is deprecated.
cpanelprint()method returns a cPanel variable's value. We deprecated this method in cPanel & WHM version 88. For method alternatives, read our
debug_log()method writes data to the debugging log file.
debug_log_json()method writes JSON data to the debugging log file.
end()method deconstructs the
Cpanel::LiveAPIobject and closes the connection to cPanel & WHM.
exec()method executes a cPanel tag.
fetch()method is a wrapper to return a hash reference from the
cpanelprint()function, which retrieves a cPanel variable. We deprecated this method in cPanel & WHM version 88.
footer()method calls the cPanel interface's footer.
get_debug_level()method retrieves the current debug level.
get_debug_log()method retrieves the debug log file's absolute path and filename.
get_result()method fetches the most recent data result node for cPanel API 1 and cPanel API 2 functions. This method is for the LiveAPI PHP Class only.
header()method calls the cPanel interface's header.
new()method instantiates the
set_debug()method sets the amount of debug information to store in LiveAPI's debug log file.
uapi()function executes a UAPI function. For use information and examples, read our Guide to UAPI.