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

 

Description

This function retrieves a list of domains that possess AutoSSL problems.

Examples 


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

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.
 
// Retrieve a list of domains that possess AutoSSL problems.
$SSL_get_autossl_problems = $cpanel->uapi(
    'SSL', 'get_autossl_problems', array()
);

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.
 
# Retrieve a list of domains that possess AutoSSL problems.
my $SSL_get_autossl_problems = $cpliveapi->uapi(
    'SSL', 'get_autossl_problems',
);

Note:

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

 cPanel Template Toolkit
<!-- Retrieve CA problem and hostname from certificate. -->
[% data = execute( 'SSL', 'get_autossl_problems', ); %]
[% FOREACH q = data %]
     <p>
         [% q %]
     </p>
[% END %]

Note:

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

 Command Line
uapi --user=username SSL get_autossl_problems

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)
{
  "messages": null,
  "errors": null,
  "status": 1,
  "data": {
    "domain":"example.com",
    "problem":""example.com" contains 400 domains, which 
exceeds the maximum number (200) of domains allowed for the 
"cPanel (powered by Comodo)" AutoSSL provider. This system will 
include those 200 domains on the certificate that appear to be 
the website's most important. To allow AutoSSL to secure each 
domain, divide the 400 domains among separate websites. (The websites 
can all serve the same content from the same document root.)",
    "time":"2018-06-07T05:30:09Z"
  }
}

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
domainstringThe certificate's hostname.A valid hostname.example.com
problemstringA text description of the problem.A valid string.
 Click to view ...

"example.com" contains 400 domains, which exceeds the maximum number (200) of domains allowed for the "cPanel (powered by Comodo)" AutoSSL provider. This system will include those 200 domains on the certificate that appear to be the website's most important. To allow AutoSSL to secure each domain, divide the 400 domains among separate websites. (The websites can all serve the same content from the same document root.)

timestringWhen the problem occurred.A time value, in ISO-8601 format.
2018-06-07T05:30:09Z