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

 

Description

This function lists every domain for which you may purchase an SSL certificate. The possible domains for the Secure Sockets Layer (SSL) certificate include applicable proxy subdomains.

Examples


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/WebVhosts/list_ssl_capable_domains

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 every domain for which you may purchase an SSL certificate.
$list_vhosts = $cpanel->uapi(
    'WebVhosts', 'list_ssl_capable_domains'
);

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 every domain for which you may purchase an SSL certificate.
my $list_vhosts = $cpliveapi->uapi(
    'WebVhosts', 'list_ssl_capable_domains',
);

Note:

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

 

 cPanel Template Toolkit
<!-- List every domain for which you may purchase an SSL certificate. -->
[% execute('WebVhosts', 'list_ssl_capable_domains', {} ) %]

Note:

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

 

 Command Line
uapi --user=username WebVhosts list_ssl_capable_domains

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)
{  
   "data": [
      {  
         "domain":"example.com",
         "vhost_name":"hostname.example.com",
		 "is_proxy":0
      },
      {
         "domain":"another.example.com",
         "vhost_name":"hostname.example.com",
		 "is_proxy":0
      },
      {
         "domain":"cpanel.example.com",
         "vhost_name":"hostname.example.com",
		 "is_proxy":1
      },
      {
         "domain":"webmail.example.com",
         "vhost_name":"hostname.example.com",
		 "is_proxy":1
      },
      {
         "domain":"autodiscover.example.com",
         "vhost_name":"hostname.example.com",
		 "is_proxy":1
      },
      {
         "domain":"webdisk.example.com",
         "vhost_name":"hostname.example.com",
		 "is_proxy":1
      },
      {
         "domain":"another.example.com",
         "vhost_name":"hostname.example.com",
		 "is_proxy":1
      },
   ]
   "messages":null,
   "errors":null,
   "status":1,
   "metadata":{  
      "transformed":1
   },
}

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

ReturnTypeDescriptionPossible valuesExample
 hash

A hash of data for a domain.

This hash includes the domain, vhost_name, and is_proxy returns. 

domain

string

The domain name.

The function returns this value in the unnamed hash.

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

vhost_name

string

The name of the virtual host or website.

The function returns this value in the unnamed hash.

A valid domain name that the cPanel user owns and that exists on the virtual host.
hostname.example.com

is_proxy

Boolean

Whether the system automatically created the proxy subdomain or a user manually created the domain.

The function returns this value in the unnamed hash.

  • 1 — The system automatically created the proxy subdomain.
  • 0A user manually created the domain.

Note:

If a user manually creates a subdomain that matches a preassigned subdomain (for example, cpanel or whm) the function returns 0.

1
  • No labels