Development Guides Home >> Guide to the LiveAPI System >> LiveAPI Methods

Guide to the LiveAPI System - The debug_log_json() Method

Copy

• Copy for LLM

  Copy page as Markdown for LLMs
• View as Markdown

  Open this page as Markdown
• Open in ChatGPT

  Get insights from ChatGPT
• Open in Claude

  Get insights from Claude

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

Returns

This method returns a Boolean value that indicates success or failure:

• 1 – Success.
• 0 – Failure.