Description
This function lists all of a reseller's cPanel accounts.
Examples
cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Resellers/list_accounts
LiveAPI PHP Class
$cpanel = new CPANEL();
$list_reseller_acounts = $cpanel->uapi(
'Resellers', 'list_accounts'
);
LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new();
my $list_reseller_accounts = $cpliveapi->uapi(
'Resellers', 'list_accounts',
);
cPanel Template Toolkit
[% data = execute( 'Reseller', 'list_accounts' ); %]
[% FOREACH q = data.domain %]
<p>
[% q %]
</p>
[% END %]
[% execute('Reseller', 'list_accounts').data.domain %]
Command Line
uapi --user=username Resellers list_accounts
|
Output (JSON)
{
"messages": null,
"errors": null,
"status": 1,
"data": [
{
"domain": "example.com",
"user": "exampleuser",
"select": "1"
}
],
"metadata": {
"transformed": 1
}
}
Parameters
This function does not accept parameters.
Returns
|
Return
|
Type
|
Description
|
Possible values
|
Example
|
|
domain
|
string
|
The account's domain.
|
A valid domain on the server.
|
example.com
|
|
user
|
string
|
The account's username.
|
A valid username on the server.
|
exampleuser
|
|
select
|
Boolean
|
Whether the account's user is currently logged in.
|
- 1 — Logged in.
- 0 — Not logged in.
|
1
|
