cPanel API 2 Functions - Logaholic::listuserprofiles

Description

This function lists a Logaholic user's profiles.

Warning:

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

 

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.

 

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=listuserprofiles&username=example

 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',
    array(
        'username'       => 'example',
    )
);

 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',
    {
        'username'       => 'example',
    }
);

 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.

 

 Output (JSON)

{
  "cpanelresult": {
    "apiversion"2,
    "func""listuserprofiles",
    "data": [
      {
        "reason""The Logaholic user "example" has 1 profile.",
        "result"1,
        "profiles": {
          "profile": [
            "subdomain.example.com"
          ]
        }
      }
    ],
    "event": {
      "result"1
    },
    "module""Logaholic"
  }
}

Note:

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

 

Parameters

Return

 Type 

Description

 Possible values 

 Example 

 username 

 string 

 Required

 The Logaholic username. 

 A valid string.

 example

 

Returns

 Return 

Type

Description

Possible values

Example

 reason

 string

 The status message from the function.

  • The Logaholic user "example" has 1 profile.
  • “example” does not own the user “user”.

 The Logaholic user "example" exists. 

 result

 boolean 

 Whether the function succeeded.

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

 1

 profiles

 hash

 A hash that contains a list of Logaholic user profiles.

  

 This hash includes the profileparameter for each user profile. 

 

 profile

 string

 The name of the Logaholic user's profile.

 This function returns this parameter in the profiles hash. 

 A valid string.

 subdomain.example.com

 reason

 string

 A reason for failure.

 Note:

 This function only returns areason value 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

 

  • 0 Users Found This Useful
Was this answer helpful?

Related Articles

The cPanel Interface

For  cPanel  &  WHM  version  58 Overview The cPanel interface is...

User Preferences

For cPanel & WHM version 58 Overview This document outlines how to access your cPanel...

Manage External Authentications

For cPanel & WHM version 58 Overview Manage credentials Additional documentation...

What is cPanelID?

In This Article:  Overview ServicesHow to get a cPanelID cPanelID External...

Guide to cPanel Interface Customization - cPanel Style Development

Introduction You can develop custom styles that modify the appearance of the cPanel interface....