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 - get_autossl_user_excluded_domains
Skip to end of metadata
Go to start of metadata

Description

This function lists an account's domains the system excludes from AutoSSL.

Examples


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


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":{
      "version":1,
      "reason":"OK",
      "command":"get_autossl_user_excluded_domains",
      "result":1
   },
   "data":{
      "payload":[
         {
            "excluded_domain":"cpcalendars.example.com"
         },
         {
            "excluded_domain":"webdisk.example.com"
         },
         {
            "excluded_domain":"cpcontacts.example.com"
         }
      ]
   }
}


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

Returns

ReturnTypeDescriptionPossible valuesExample
payloadarray of hashesAn array of hashes that contain a list of domains excluded from AutoSSL.

Each array of hashes contains the excluded_domain array.


excluded_domain

arrayA list of domains excluded from AutoSSL.A domain that the account owns.cpcalendars.example.com