SSL

This function disables AutoSSL for the domains that you specify.

Important:

When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system disables this function.

This function determines whether the system can automatically redirect domains on a cPanel account to use SSL.

This function checks whether a shared SSL certificate is associated with the account.

This function deletes an SSL certificate.

Note:

• When you call this function, you must include the id or the friendly_name

parameter.

• This function only deletes certificates from SSL storage. To end SSL

coverage for a domain, use the UAPI SSL::delete_ssl function instead.

Important:

When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system disables this function.

This function deletes a certificate signing request (CSR).

Note:

• When you call this function, you must include the id or the friendly_name

parameter.

• To delete a private key, use the UAPI SSL::delete_key function instead.

Important:

When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system disables this function.

This function deletes a private key.

Note:

• When you call this function, you must include the id or the friendly_name

parameter.

• To delete a certificate signing request (CSR), use the UAPI SSL::delete_csr

function instead.

Important:

When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system disables this function.

This function removes SSL from a domain.

Note:

This function removes domains from the current certificate to end SSL coverage for those domains. To delete certificates from SSL storage, use the UAPI function SSL::delete_cert instead.

Important:

When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system disables this function.

This function disables SNI mail services on the specified domains.

Note:

Mail SNI is always enabled.

• After you change the SNI status, you must run UAPI's rebuild_mail_sni_config function.
• Functions that enable Mail SNI succeed with a warning that Mail SNI is always enabled.
• Functions that disable Mail SNI fail and make no changes.

This function enables SNI mail services on the specified domains.

Warning:

Mail SNI is always enabled.

• Mail SNI is not compatible with Webmail and will not function for any Webmail connection. Webmail connections use the cPanel service SSL certificate.
• Functions that enable Mail SNI succeed with a warning that Mail SNI is always enabled.
• Functions that disable Mail SNI fail and make no changes.

Important:

When you disable the Calendars and Contacts, Mail Receive, Web Disk, Webmail, and Web Server roles, the system disables this function.

This function retrieves the best-available certificate for the domain. The function also retrieves the certificate's associated private key and CA bundle, if available.

Important:

When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system disables this function.

This function retrieves all of a certificate's available information.

Important:

• You must call either the friendly_name or id parameter.
• When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system disables this function.

This function retrieves the certificate information for all fully qualified domain names (FQDNs) that the account owns.

This function extracts the private key and CA bundle information from a certificate.

Note:

Due to the limited field length of HTTP GET method calls, you must use the HTTP POST method. For this reason, you cannot use a cPanel or Webmail session URL to call this function.

This function retrieves SSL certificates for a private key.

Note:

When you call this function, you must include either the id or the friendly_name parameter.

This function retrieves certificate signing requests (CSR) for a private key.

Note:

When you call this function, you must include either the id or the friendly_name parameter.

This function generates a self-signed SSL certificate.

Important:

When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system disables this function.

This function generates a certificate signing request (CSR).

Note:

This function requires a valid key in the account's ssl directory. You can generate a key with UAPI's SSL::generate_key function.

Important:

When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and WebServer roles, the system disables this function.

This function generates a private key.

Important:

• You cannot call both the keytype and keysize parameters in a single call.
• When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and

Web Server roles, the system disables this function.

This function lists the domains with AutoSSL disabled.

This function retrieves a list of domains that possess AutoSSL problems.

Important:

When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system disables this function.

This function returns the AutoSSL renewal status for a domain. It indicates whether AutoSSL is active, the domain is excluded, the domain has DCV problems, and whether the certificate will auto-renew.

This function retrieves a certificate's Certificate Authority (CA) bundle and hostname.

Important:

When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system disables this function.

This function retrieves the most secure domain for a service.

This function installs an SSL certificate.

Note:

Due to their inherent complexities, SSL-related functions often present problems for third-party developers. For the additional steps required to successfully call this function, read our Call UAPI's SSL::install_ssl Function in Custom Code documentation.

Important:

When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system disables this function.

This function retrieves information about a certificate that is installed on a domain's dedicated IP address.

Important:

• If you do not possess a dedicated IP address, this function will fail. For non-dedicated IP addresses, use the SSL::installed_hosts function.
• When you disable the _Calendars and Contacts_, _Receive Mail_, _Web Disk_ , _Webmail_ , and _Web Server_ roles, the system disables this function.

This function retrieves a list of the account's websites, their domains, and certificate information.

Important:

For a dedicated IP address, use the UAPI SSL::installed_host function.

Important:

When you disable the CalendarContact , MailReceive , WebDisk , Webmail , and WebServer roles, the system disables this function.

This function verifies whether the autossl_check task is in progress for the current user.

Important:

When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system disables this function.

This function checks whether the sslinstall feature is enabled.

Warning:

Mail SNI is always enabled.

• Mail SNI is not compatible with Webmail and will not function for any Webmail connection. Webmail connections use the cPanel service SSL certificate.
• Functions that enable Mail SNI succeed with a warning that Mail SNI is always enabled.
• Functions that disable Mail SNI will fail and make no changes.

Important:

When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system disables this function.

This function checks whether the Apache web server supports SNI.

Important:

When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system disables this function.

This function lists an account's certificates.

Important:

When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system disables this function.

This function lists an account's certificate signing requests (CSR).

Important:

When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system disables this function.

This function lists an account's private keys.

Important:

When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system disables this function.

This function lists SSL-related items on a domain.

Important:

When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system disables this function.

This function retrieves the status of the domain's SNI mail services.

Warning:

Mail SNI is not compatible with Webmail and will not function for any Webmail connection. Webmail connections use the cPanel service SSL certificate.

Note:

Mail SNI is always enabled.

• Functions that enable Mail SNI succeed with a warning that Mail SNI is always enabled.
• Functions that disable Mail SNI fail and make no changes.

This function rebuilds the SNI configuration files.

Note:

• You must run this function after you change the SNI status through the UAPI's enable_mail_sni or disable_mail_sni functions.
• Mail SNI is always enabled.
• Functions that enable Mail SNI succeed with a warning that Mail SNI is always enabled. Functions that disable Mail SNI fail and make no changes.
• Functions that disable Mail SNI will fail and make no changes.

Important:

When you disable the _Calendars and Contacts_, _Receive Mail_, _Web Disk_, _Webmail_, and _Web Server_ roles, the system disables this function.

This function rebuilds the account's SSL database.

This function enables AutoSSL for the domains that you specify.

Important:

When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system disables this function.

This function disables AutoSSL for every domain that you specify.

Warning:

This function replaces the list of any domains that you previously excluded. To add domains to the list of excluded domains, use the UAPI function SSL::add_autossl_excluded_domains.

Important:

When you disable the the Calendar and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system disables this function.

This function changes a certificate's friendly name.

Important:

When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system disables this function.

This function changes a certificate signing request's (CSR) friendly name.

Important:

• You must call either the friendly_name or id parameter.
• When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system disables this function.

This function sets a user’s preferred SSL/TLS key type.

This function changes a key's friendly name.

Important:

• You must call either the friendly_name or id parameter.
• When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system disables this function.

This function sets a new primary SSL website for a dedicated IP address.

Important:

When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system disables this function.

This function retrieves a certificate.

Note:

When you call this parameter, you must include either the id or the friendly_name parameter.

Important:

When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system disables this function.

This function retrieves a certificate signing request (CSR).

Important:

When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system disables this function.

Note:

When you call this function, you must include either the id or the friendly_name parameter.

This function retrieves a private key.

Important:

When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system disables this function.

This function initiates an AutoSSL check for the user.

Important:

When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system disables this function.

This function enables or disables secure redirects (HTTPS) for the cPanel account's domains that you specify.

Important:

To call this function, one of the following conditions must exist:

• AutoSSL must exist on the domains for which you enable secure redirects.
• A valid SSL certificate must exist for each domain for which you wish to enable secure redirects.
• You must own the domains for which you wish to enable secure redirects.

This function uploads a certificate.

Important:

• Due to the limited field length of HTTP GET method calls, you must use the HTTP

POST method. For this reason, you cannot use a cPanel or Webmail session URL to call this function.

• When you disable the Calendar and Contacts, Receive Mail, Web Disk, Webmail, and

Web Server roles, the system disables this function.

This function uploads a private key.

Note:

Due to the limited field length of HTTP GET method calls, you must use the HTTP POST method. For this reason, you cannot use a cPanel or Webmail session URL to call this function.

Important:

When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system disables this function.