cPanel API 2 Functions - Logaholic::logaholiclink - Knowledgebase

Description

This function generates a link to Logaholic.This link uses the cPanel account's locale setting.

Important:

As of cPanel & WHM version 11.48, the integrated Logaholic application is no longer available. We removed Logaholic's API functions, and they will not produce any results.

Warning:

We strongly recommend that you use UAPI instead of cPanel API 2. However, no equivalent UAPI function exists.

Examples

WHM API (JSON)

https://hostname.example.com:2087/cpsess##########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=Logaholic&cpanel_jsonapi_func=logaholiclink

LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.

// List profiles for Logaholic user "example"

$list_profiles = $cpanel->api2(

'Logaholic', 'listuserprofiles'

);

LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.

# List profiles for Logaholic user "example"

my $list_profiles = $cpliveapi->api2(

'Logaholic', 'listuserprofiles',

);

cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

cPanel API 2 calls that use cPanel tags vary widely in code syntax and in their output. For more information, read our Deprecated cPanel Tag Usage documentation. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.

Command Line

Important:

Because we removed this function before we introduced this functionality, you cannot call this function via the command line.

 Output (JSON)

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "logaholiclink",
    "data": [
      {
        "link": "/cpsess1658535621/3rdparty/Logaholic/index.php",
        "locale_name": "english",
        "engine_disabled": 0
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Logaholic"
  }
}

Note:

Use cPanel's API Shell interface (Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

This function does not accept parameters.

Returns

Return	Type	Description	Possible values	Example
link	string	A link to the Logaholic site.	A valid URL path, relative to the cPanel account's home page.	/cpsess1658535621/3rdparty/Logaholic/index.php
locale_name	string	The cPanel account's locale setting.	A valid locale name.	^english
engine_disabled	Boolean	Whether Logaholic is enabled.	1 — Logaholic is disabled. 0 — Logaholic is enabled.	0
reason	string	A reason for failure. Note: This function only returns areasonvalue if it failed.	A string that describes the error.	This is an error message.
result	Boolean	Whether the function succeeded.	1 — The function succeeded. 0 — The function failed.	1

Knowledgebase

Categories

Categories