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
  • WHM API 1 Functions - add_autossl_user_excluded_domains
Skip to end of metadata
Go to start of metadata

Description

This function disables AutoSSL for an account's specified domains.

Examples


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/add_autossl_user_excluded_domains?api.version=1&username=example&domain=cpcalendars.example.com&domain=webdisk.example.com
 Command Line
whmapi1 add_autossl_user_excluded_domains username=example domain=cpcalendars.example.com domain=webdisk.example.com


Notes:

  • Unless otherwise noted, you must URI-encode values.
  • For more information and additional output options, read our Guide to WHM API 1 documentation or run the whmapi1 --help command.
  • If you run CloudLinux™, you must use the full path of the whmapi1 command:

    /usr/local/cpanel/bin/whmapi1

 Output (JSON)
{
   "metadata":{
      "reason":"OK",
      "command":"add_autossl_user_excluded_domains",
      "version":1,
      "result":1
   }
}


Note:

Use WHM's API Shell interface (WHM >> Home >> Development >> API Shell) to directly test WHM API calls.

Parameters

ParameterTypeDescriptionPossible valuesExample
usernamestring

Required

The cPanel user's account.

A valid cPanel username.

example
domainstring

Required

Disable AutoSSL for this domain.

A valid domain that the account owns.

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 domaindomain-1, and domain-2 parameters.
cpcalendars.example.com

Returns

This function only returns metadata.