Child pages
  • cPanel API 2 Functions - Resellers::get_sub_accounts
Skip to end of metadata
Go to start of metadata

 

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:

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


Note:

 For more information, read our Calls from the WHM API documentation.

 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'
    ) 
 );


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 sub accounts owned by 'reseller'
my $get_sub_accounts = $cpliveapi->api2(
    'Resellers', 'get_sub_accounts',
 );


Note:

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

 cPanel Tag System (deprecated)


Warnings:

  • In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.
  • cPanel API 2 calls that use cPanel tags vary in code syntax and in their output.
  • For more information, read our Deprecated cPanel Tag Usage documentation.

 Command Line
cpapi2 --user=username Resellers get_sub_accounts


Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • You must run the --user=username command.
  • For more information and additional output options, read our Guide to cPanel API 2 documentation or run the cpapi2 --help command. 

 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 (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

This function does not accept parameters.

 

Returns

ReturnTypeDescriptionPossible valuesExample
 array of hashesAn array of hashes that contains information about the domains that the currently-authenticated user owns.This array of hashes includes the domain, 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
reasonstring

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.
resultBoolean

Whether the function succeeded.

  • 1 — The function succeeded.
  • 0 — The function failed.
1