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

Guide to the LiveAPI System - The get_debug_log() 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 get_debug_log() method retrieves the debug log file's absolute path and filename.

• 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.

This method does not return the debug log's contents.

Example

LiveAPI PHP Class

// Get the debug log's location.
$cpanel->get_debug_log();

LiveAPI Perl Module

# Get the debug log's location.
$cpliveapi->get_debug_log();

Parameters

This method does not accept parameters.

Returns

This method returns the absolute path and filename for the LiveAPI system's debug log file.