How can we improve WHMCS?

Share, discuss and vote for what you would like to see added to WHMCS

Add an API to obtain entries from System Module Debug Log



Similar to how GetActivityLog works, it would be useful to also have a GetModulesLog() API.

The input parameters for the GetModulesLog API might include filters such as date range, module name, action type, and pagination options.

interface GetModulesLogParameters {
limitstart?: number;
limitnum?: number;
module?: string;
action?: string;
date?: string;
}

Output Structure
The output structure for the GetModulesLog API would include the result information and an array of log entries. Each log entry would contain the date, module, action, request, and response.
interface GetModulesLogResponse extends ResponseResultInfo {
modulesLog: {
entry: {
date: string;
module: string;
action: string;
request: Array;
response: Array;
}[];
};
}

Here’s an example of how the input and output might be structured for endpoint users:

// Define the input parameters for the GetModulesLog API
export interface GetModulesLogParameters {
limitstart?: number;
limitnum?: number;
module?: string;
action?: string;
date?: string;
}

// Define the response structure for the GetModulesLog API
export interface GetModulesLogResponse extends ResponseResultInfo {
modulesLog: {
entry: {
date: string;
module: string;
action: string;
request: Array;
response: Array;
}[];
};
}

Post the first comment

Login to post a comment.