Child pages
  • Guide to the LiveAPI System - The debug_log_json() Method
Skip to end of metadata
Go to start of metadata

 

Description

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, where user is the cPanel account's username, and rand 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

ParameterTypeDescriptionPossible valuesExample
messagestringThe 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.