Description

This function lists virtual host names for each domain.


Examples




https://hostname.example.com:2083/cpsess##########/execute/WebVhosts/list_domains



$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// List vhosts for each domain.
$list_vhosts = $cpanel->uapi(
    'WebVhosts', 'list_domains'
);

 



my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# List vhosts for each domain.
my $list_vhosts = $cpliveapi->uapi(
    'WebVhosts', 'list_domains',
);

 



<!-- List vhosts for each domain. -->
[% execute('WebVhosts', 'list_domains', {} ) %]

 



uapi --user=username WebVhosts list_domains



{  
   "messages":null,
   "errors":null,
   "status":1,
   "metadata":{  
      "transformed":1
   },
   "data": [
      {  
        "domain":"example.com",
		"vhost_is_ssl":1,
		"proxy_subodmains": [
		  "cpanel",
		  "webmail",
		  "autodiscover",
		  "whm",
		  "webdisk",
		],
		"vhost_name":"hostname.example.com"      
      },
      {
        "domain":"example2.com",
		"vhost_is_ssl":0,
		"vhost_name":"hostname.example.com"
      },
   ],
}



Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample
domainstring

The domain name.

The function returns this value in the unnamed hash.

A valid domain name on the virtual host.example.com
vhost_is_sslBoolean

Whether an SSL certificate secures the domain.

The function returns this value in the unnamed hash.

  • 1 — Secured.
  • 0Not secured.
1
proxy_subdomainsarray

An array of service subdomains (proxy subdomains) listed for the domain.

  • This only returns values when vhost_is_ssl is equal to 1.
  • We introduced this return in cPanel & WHM version 64.


The function returns this value in the unnamed hash.
  • null
  • An array of service subdomains (proxy subdomains).
cpanel, webmail, autodiscover, whm, webdisk

vhost_name

string

The name of the virtual host.

A valid host's name on the account.
hostname.example.com