cPanel API 2 Functions - Logaholic::edituser - Knowledgebase

Description

This function edits a Logaholic user.

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=edituser&username=example&fullname=President%20Skroob&email=user%40example.com&password=12345luggage

 LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// Edit Logaholic user "example"
$edit_logaholicuser = $cpanel->api2(
    'Logaholic', 'edituser',
    array(
        'username'       => 'example',
        'fullname'       => 'President Skroob',
        'email'          => 'user@example.com',
        'password'       => '12345luggage',
    )
);

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Edit Logaholic user "example"
my $edit_logaholicuser = $cpliveapi->api2(
    'Logaholic', 'edituser',
    {
        'username'       => 'example',
        'fullname'       => 'President Skroob',
        'email'          => 'user@example.com',
        'password'       => '12345luggage',
    }
);

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": "edituser",
    "data": [
      {
        "reason": "The Logaholic user "example" was successfully edited.",
        "result": 1
      }
    ],
    "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
fullname	string	The Logaholic user's full name.	A valid string.	President Skroob
email	string	The Logaholic user's email address.	A valid email address.	user@example.com
password	string	The Logaholic user's password.	A secure password.	12345luggage

Returns

Return	Type	Description	Possible values	Example
reason	string	The status message from the function.	The Logaholic user "example" was successfully edited. “example” does not own the user “user”.	The Logaholic user "example" was successfully edited.
result	boolean	Whether the function succeeded.	1 — The function succeeded. 0 — The function failed.	1
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