Page tree
Skip to end of metadata
Go to start of metadata

 

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

Note:

This example calls the UAPI function via a cPanel session. For more information, read our Guide to UAPI documentation. 

 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// List reseller accounts on example.com
$list_reseller_acounts = $cpanel->uapi(
    'Resellers', 'list_accounts'
);

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.
 
# List reseller accounts on example.com
my $list_reseller_accounts = $cpliveapi->uapi(
    'Resellers', 'list_accounts',
);

Note:

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

 

 cPanel Template Toolkit
<!-- Get a hash of all the data, then display the domain values. -->
[% data = execute( 'Reseller', 'list_accounts' ); %]
[% FOREACH q = data.domain %]
     <p>
         [% q %]
     </p>
[% END %]
   
<!-- Get only the domain value. -->
[% execute('Reseller', 'list_accounts').data.domain %]

Note:

For more information, read our Guide to Template Toolkit documentation. 

 

 Command Line
uapi --user=username Resellers list_accounts

Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to UAPI documentation or run the uapi --help command. 
  • We introduced this functionality in cPanel & WHM version 56.

 Output (JSON)
{
  "messages": null,
  "errors": null,
  "status": 1,
  "data": [
    {
      "domain": "example.com",
      "user": "exampleuser",
      "select": "1"
    }
  ],
  "metadata": {
    "transformed": 1
  }
}

Note:

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

   

Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample
domainstringThe account's domain.A valid domain on the server.example.com
userstringThe account's username.A valid username on the server.exampleuser
selectBoolean

Whether the account's user is currently logged in.

  • 1 — Logged in.

  • 0Not logged in.

1