Development Guides Home >> Guide to the LiveAPI System >> LiveAPI Methods
Guide to the LiveAPI System - The debuglogjson() Method
The debug_log_json()
method writes JSON data to the debugging log file.
-
By default, LiveAPI environments log debugging data to the
/home/user/.cpanel/LiveAPI.log.rand
file, whereuser
is the cPanel account's username, andrand
is a random string that cPanel & WHM generates.
Example
LiveAPI PHP Class
// Log a JSON error to the LiveAPI error log.
$cpanel->debug_log_json("{whatami:'JSON',message:'Hello'}");
LiveAPI Perl Module
# Log a JSON error to the LiveAPI error log.
$cpliveapi->debug_log_json("{whatami:'JSON',message:'Hello'}");
Parameters
Parameter | Type | Description | Possible values | Example |
---|---|---|---|---|
message |
string | The error message to log. | A valid JSON string. | {whatami:'JSON',message:'Hello'} |
Returns
This method returns a Boolean value that indicates success or failure:
-
1
– Success. -
0
– Failure.