We have a new documentation site for cPanel & WHM! You can find our new documentation site at docs.cpanel.net.

We will continue to maintain our API documentation on this server.

Child pages
  • UAPI Functions - SSL::remove_autossl_excluded_domains
Skip to end of metadata
Go to start of metadata

Description

This function enables AutoSSL for the domains that you specify.

Important:

In cPanel & WHM version 84 and later, when you disable the Calendars and Contacts, Receive Mail, Web DiskWebmail, and Web Server roles, the system disables this function.

Examples


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/SSL/remove_autossl_excluded_domains?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.
 
// Enables AutoSSL for the following domains.
$SSL_remove_autossl_excluded_domains = $cpanel->uapi(
    'SSL', 'remove_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.
 
#  Enables AutoSSL for the following domains.
my $SSL_remove_autossl_excluded_domains = $cpliveapi->uapi(
    'SSL', 'remove_autossl_excluded_domains'
	{
		'domains'	=>	'example.com,example2.com'
	}
);


Note:

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

 Command Line
uapi --user=username SSL remove_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. 
  • If you run CloudLinux™, you must use the full path of the uapi command:

    /usr/local/cpanel/bin/uapi


 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

Required

Enable AutoSSL for this domain.

A valid domain name that the account owns.

Notes:

  • Separate multiple domains with a comma (,).
  • For command line calls, use a URI encoded comma (%2C).

example.com,example2.com

Returns

This function only returns metadata.