cPanel API 2 Functions - Resellers::get_sub_accounts - Knowledgebase

Description

This function lists all of a reseller's cPanel accounts.

Warning:

We strongly recommend that you use the following UAPI function instead of this function:

Resellers::list_accounts — This function lists all of a reseller's cPanel accounts.

Examples

WHM API (JSON)

https://hostname.example.com:2087/cpsess###########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=resellers&cpanel_jsonapi_func=get_sub_accounts

LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.

// List sub accounts owned by 'reseller'

$get_sub_accounts = $cpanel->api2(

'Resellers', 'get_sub_accounts'

)

);

LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.

# List sub accounts owned by 'reseller'

my $get_sub_accounts = $cpliveapi->api2(

'Resellers', 'get_sub_accounts',

);

cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that you only use theLiveAPI system to call the cPanel APIs.

cPanel API 2 calls that use cPanel tags vary widely in code syntax and in their output. For more information, read ourDeprecated cPanel Tag Usage documentation. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.

Command Line

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that you only use theLiveAPI system to call the cPanel APIs.

Output (JSON)

{

"cpanelresult":{

"apiversion":2,

"func":"resellers",

"data":[

{

"domain":"example.com",

"user":"example",

"select":"1"

},

{

"domain":"example1.com",

"user":"example1",

"select":""

}

],

"event":{

"result":1

},

"module":"Reseller"

}

Note:

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

Parameters

This function does not accept parameters.

Returns

Return	Type	Description	Possible values	Example
	array of hashes	An array of hashes that contains information about the domains that the currently-authenticated user owns.	This array of hashes includes thedomain, user, and select returns.
domain	string	The domain that the account owns. The function returns this value in the unnamed hash.	One or more valid domains on the server.	example.com
user	string	The cPanel account's username. The function returns this value in the unnamed hash.	One or more valid usernames.	example
select	Boolean	Whether the specified account is the currently-authenticated user. The function returns this value in the unnamed hash.	1 — Authenticated. 0 — Not authenticated.	1
reason	string	A reason for failure. Note: This function only returns a reason value if there was an error.	A string that describes the error.	This is an error message.
result	Boolean	Whether the function succeeded.	1 — The function succeeded. 0 — The function failed.	1

Knowledgebase

Categories

Categories