Self Help Documentation
< All Topics

accounts/wwwacct

PostedFebruary 15, 2022
UpdatedJuly 8, 2025

Description

Creates a new SPanel account.

Parameters

Additional parameters:

FieldTypeRequiredDescription
tokenstringYesAuthorizing API token – check API Basics for more information.
actionstringYesThe category and function being executed.
domainstringNoMain domain for the account. If left empty, a temporary subdomain within our infrastructure will be created. It can be changed later.
usernamestringNoAccount username. between 1 and 30 alphanumeric symbols. If left empty, a random username will be generated. It can be changed later.
passwordstringYesThe password for the account, should be at least 8 or more symbols.
packagestringNoName of the package to use. Note that if a package is selected, the fields below become optional.
quotaintNoDefault: unlimited. If set, quota limit in MB Minimum limit is 100.
inodesintNoDefault: unlimited. If set, inodes limit in number of inodes Minimum limit is 10000.
domainsintNoDefault: unlimited. If set, number of additional domains the user can add. Set 0 to disable additional domains.
emailsintNoDefault: unlimited. If set, number of email accounts the user can create. Set 0 to disable email accounts creation.
databasesintNoDefault: unlimited. If set, number of databases the user can create. Set 0 to disable databases creation.
permissionsstring|arrayNoDefault: all (full access to account features)
Permissions 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 [ 'domain' => [ 'domains', 'redirects' ] ], the newly created user will access only the pages specified.
Check the full API call example below for further clarification.
scriptstringNoDefault: none/empty.
If provided, a script can be installed automatically.

Possible configurations:
  • none/empty – default installation – empty account;
  • ‘wordpress’ – installs a clean WordPress;
  • ‘spectra/store’ – installs a preset bundle with theme and plugins for an online store;
  • ‘spectra/business’ – installs a preset bundle with theme and plugins for a business website;
  • ‘spectra/blog’ – installs a preset bundle with theme and plugins for a blog.

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
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
$endpointUrl = 'https://123.123.123.123/spanel/api.php';
$postData = [
  'token' => 'provided_auth_token', // Check API Basics for more information
  'action' => 'accounts/wwwacct',
  'domain' => 'spanel.io',
  'username' => 'spanelio',
  'password' => '1diBtslaBCSs3xy',
  // Optional options
  // 'package' => 'packagename' // Optional package field
  'quota' => 10240, // 10GB disk space limit
  'inodes' => 10000, // 10000 inodes limit
  // 'domains' => false, // Unlimited addon domains
  'emails' => 0, // No email accounts allowed
  'databases' => false, // Unlimited databases
  //'permissions' => 'all' //Set all permissions
  'permissions' => [
    'email' => 'all', //access every email page
    'domain' => [ 'domains', 'redirects' ] //access only the 'domains' and 'redirects' 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

PHP
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
{
    "result": "success",
    "msg": "Account Created Successfully",
    "data": {
        "domain": "spanel.io",
        "ftpuser": "spanelio",
        "ftppassword": "1diBtslaBCSs3xy",
        "diskquota": "Unlimited",
        "maxinodes": "Unlimited",
        "maxdomains": "Unlimited",
        "maxemails": "Unlimited",
        "maxdatabases": "Unlimited",
        "docroot": "/home/spanelio/public_html",
        "ip": "123.124.125.126",
        "ns1": "ns1.spanel.io",
        "ns2": "ns2.spanel.io",
        "smtppop3ftp": "client.spanel.io",
    }
}
Table of Contents