Self Help Documentation
< All Topics

user/addsubuser

PostedMarch 2, 2022
UpdatedApril 25, 2023

Description

Creates a new SPanel user account.

Parameters

Additional parameters:

FieldTypeRequiredDescription
tokenstringYesAuthorizing API token – check API Basics for more information.
accountuserstringYesThe SPanel user account that is being managed or viewed.
actionstringYesThe category and function being executed.
usernamestringYesSPanel account username. Between 1 and 30 alphanumeric symbols.
passwordstringYesThe password for the account, should be at least 8 or more symbols.
permissionsstring|arrayYesPermissions array or ‘all’ string for full root permissions.

When using a permissions array, you can set the category sub-array to ‘all’ string to include every child page available or use an array with every page that you wish to include, for example:
  • If you use [ 'email' => 'all' ], all pages under server category will be included in the newly created user permissions list;
  • If you use [ 'domains' => [ 'domains', 'redirects' ] ], the newly created user will access only the pages specified.
Check the full API call example below for further clarification.

Info
The structure and an always up-to-date list of all available user permissions can be obtained by running the user/listuserpermissions API call. The list is pulled directly from SPanel’s system in real-time.

Example

PHP
PHP
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
$endpointUrl = 'https://123.123.123.123/spanel/api.php';
 
$postData = [
  'token' => 'provided_auth_token', // Check API Basics for more information
  'accountuser' => 'spanelio',
  'action' => 'user/addsubuser',
  'username' => 'spanelio_testuser',
  'password' => 'KExk80Ml5aG6M',
  //'permissions' => 'all' //Set all permissions
  'permissions' => [
                       'email' => 'all', //access every email page
                       'domain' => [ 'domains', 'redirects' ] //access only the 'domains' and 'redirect' pages
                   ]
];
 
$ch = curl_init();
curl_setopt( $ch, CURLOPT_URL, $endpointUrl);
curl_setopt( $ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt( $ch, CURLOPT_POST, true);
curl_setopt( $ch, CURLOPT_POSTFIELDS, http_build_query($postData));
curl_setopt( $ch, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt( $ch, CURLOPT_SSL_VERIFYHOST, false);
$jsonOutput = curl_exec( $ch );

Output

JSON
PHP
1
2
3
4
5
6
{
    "result": "success",
    "data": {
        "msg": "The new user spanelio_testuser created successfuly"
    }
}
Table of Contents