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

Description

This function lists the domains with AutoSSL disabled.

Examples


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/SSL/get_autossl_excluded_domains


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.
 
// List the domains with AutoSSL disabled.
$SSL_get_autossl_excluded_domains = $cpanel->uapi(
    'SSL', 'get_autossl_excluded_domains'
);


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.
 
#  List the domains with AutoSSL disabled.
my $SSL_get_autossl_excluded_domains = $cpliveapi->uapi(
    'SSL', 'get_autossl_excluded_domains'
);


Note:

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

 Command Line
uapi --user=username SSL get_autossl_excluded_domains


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":[  
    {  
       "excluded_domain":"example.com"
    },
    {  
       "excluded_domain":"example2.com"
    }
  ]
}


Note:

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

Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample
dataarray of hashesAn array of hashes that include domain's AutoSSL information.This array of hashes includes the excluded_domain parameter.

excluded_domain

string

A list of domains that have AutoSSL disabled.

The function returns this value in the data array of hashes.

A domain that the account owns.example.com

example2.com