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

 

Description

This function disables AutoSSL for every domain that you specify.

Warning:

This function replaces the list of any domains that you previously excluded. To add domains to the list of excluded domains, use the UAPI function SSL::add_autossl_excluded_domains.

Examples


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/SSL/set_autossl_excluded_domains?example.com%2Cexample2.com

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.
 
// Enable AutoSSL for every domain on the cPanel account.
$SSL_set_autossl_excluded_domains = $cpanel->uapi(
    'SSL', 'set_autossl_excluded_domains'
    array(
         'domains'  =>   'example.com,example2.com'
         )
);

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.
 
#  Enable AutoSSL for every domain on the cPanel account.
my $SSL_set_autossl_excluded_domains = $cpliveapi->uapi(
    'SSL', 'set_autossl_excluded_domains'
    {
        'domains'   =>   'example.com,example2.com'
    }
);

Note:

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

 cPanel Template Toolkit
<!-- Enable AutoSSL for every domain on the cPanel account. -->
[% execute( 'SSL', 'set_autossl_excluded_domains',  { 'domains' => 'example.com,example2.com' }); %]

Note:

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

 Command Line
uapi --user=username SSL set_autossl_excluded_domains domains=example.com,example2.com

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": null
}

Note:

Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

ParameterTypeDescriptionPossible valuesExample
domainsstring

Disable AutoSSL for this domain.

Note:

If you do not include this parameter, the function will enable AutoSSL for every domain on the account.

A valid domain name that the account owns.

Notes:

  • Separate multiple domains with the pipe character (,).
  • For browser-based calls, use a URI encoded comma (%2C).

example.com,example2.com

Returns

This function only returns metadata.

  • No labels