Disable AutoSSL for domain

This function disables AutoSSL for a specific domain on an account.

Warning:

This function replaces the list of any previously-excluded domains. To add a domain to the list of the user's excluded domains, use the add_autossl_user_excluded_domains function.

Authorizations:
query Parameters
username
required
string <username>

The cPanel user's account.

Example: username=example
domain
string <domain>

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

Note

To disable AutoSSL for multiple domains, duplicate or increment the parameter name. For example, to exclude three domains, you could:

  • Use the domain parameter multiple times.
  • Use the domain, domain-1, and domain-2 parameters.
Examples:
domain=domain=example.com&domain-1=example1.com&domain-2=example2.com
domain=domain=example.com&domain=example1.com&domain=example2.com
domain=example.com

Responses

Response Schema: application/json
object

Request samples

whmapi1 --output=jsonpretty \
  set_autossl_user_excluded_domains \
  username='example'

Response samples

Content type
application/json
{
  • "metadata": {
    • "command": "set_autossl_user_excluded_domains",
    • "reason": "OK",
    • "result": 1,
    • "version": 1
    }
}