Description

This function generates a link to Logaholic.

This link uses the cPanel account's locale setting.

Examples 


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

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// List profiles for Logaholic user "example"
$list_profiles = $cpanel->api2(
    'Logaholic', 'listuserprofiles'
);

 

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',
);

 

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

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

   

Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample
linkstringA link to the Logaholic site.A valid URL path, relative to the cPanel account's home page.
/cpsess1658535621/3rdparty/Logaholic/index.php
locale_namestringThe cPanel account's locale setting.A valid locale name. english
engine_disabledBooleanWhether Logaholic is enabled.
  • 1 — Logaholic is disabled.
  • 0 — Logaholic is enabled.
0
reasonstring

A reason for failure.

This function only returns a reason value if it failed.

A string that describes the error.

This is an error message.
resultBoolean

Whether the function succeeded.

  • 1 — The function succeeded.
  • 0 — The function failed.
1