Child pages
  • cPanel API 1 Functions - SubDomain::cplistsubdomains
Skip to end of metadata
Go to start of metadata

Description

This function lists an account's subdomains.

Warning:

cPanel API 1 is deprecated. Do not use this function. Instead, we strongly recommend that you use the following newer functions:

Examples


 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$list_subdomains = $cpanel->api1('SubDomain','cplistsubdomains') ); // Call the function.


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.
my $list_subdomains = $cpliveapi->api1('SubDomain','cplistsubdomains'); # Call the function.


Note:

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

 

 cPanel Tag System (deprecated)


Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We provide this example to help developers move from the old cPanel tag system to our LiveAPI system. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

<cpanel Module="SubDomain::cplistsubdomains()">
 Command Line
cpapi1 --user=username SubDomain cplistsubdomains


Notes:

  • You must URI-encode values.
  • For more information and additional output options, read our Guide to WHM API 1 documentation or run the whmapi1 --help command.
  • If you run CloudLinux™, you must use the full path of the whmapi1 command:

    /usr/local/cpanel/bin/whmapi1

 Output (HTML)
subdomain.example.com (public_html/ensim)<br>\nothersub.example.com (public_html/othersub)<br>\n

   

Parameters

This function does not accept parameters.

Returns

This function returns a list of an account's subdomains and their document roots, separated with line break tags.