Child pages
  • cPanel API 2 Functions - Logaholic::adduserprofile
Skip to end of metadata
Go to start of metadata

Description

This function adds a profile to 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, Logaholic 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=adduserprofile&username=example&profile=newprofile


Note:

 For more information, read our Calls from the WHM API documentation.

 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Add profile "newprofile" to Logaholic user "example"
$add_logaholicuser = $cpanel->api2(
    'Logaholic', 'adduserprofile', 
    array(
        'username'       => 'example', 
        'profile'        => 'newprofile', 
    ) 
);


Note:

For more information, read our Guide to the LiveAPI System.

 

 LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Add profile "newprofile" to Logaholic user "example"
my $add_logaholicuser = $cpliveapi->api2(
    'Logaholic', 'adduserprofile',
    { 
        'username'      => 'example', 
        'profile'       => 'newprofile', 
    }
);


Note:

For more information, read our Guide to the LiveAPI System.

 

 cPanel Tag System (deprecated)


Warnings:

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

 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": "adduserprofile",
    "data": [
      {
        "reason": "1 profile was created for 1 site example.com.",
        "result": 1
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Logaholic"
  }
}


Note:

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

   

Parameters

ReturnTypeDescriptionPossible valuesExample
usernamestring

Required

The Logaholic username.

A valid string.example
profilestringRequired

The Logaholic profile's name.

A valid string.newprofile

Returns

ReturnTypeDescriptionPossible valuesExample
reason string

The status message from the function.

  • 1 profile was created for 1 site example.com.
  • An error message.
1 profile was created for 1 site example.com.
resultBooleanWhether the function succeeded.
  • 1 — The function succeeded.
  • 0 — The function failed.
 1
reasonstring

A reason for failure.

Note:

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