# cPanel Account SSL Management

SSL Certificates / cPanel Account SSL Management

## Return whether domains can redirect to secure URL

 - [GET /SSL/can_ssl_redirect](https://api.docs.cpanel.net/specifications/cpanel.openapi/cpanel-account-ssl-management/can_ssl_redirect.md): This function determines whether the system can automatically redirect domains on a cPanel account to use SSL.

## Remove SSL for domain

 - [GET /SSL/delete_ssl](https://api.docs.cpanel.net/specifications/cpanel.openapi/cpanel-account-ssl-management/delete_ssl.md): 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.

## Request best SSL certificate

 - [GET /SSL/fetch_best_for_domain](https://api.docs.cpanel.net/specifications/cpanel.openapi/cpanel-account-ssl-management/fetch_best_for_domain.md): 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.

## Return SSL certificate information

 - [GET /SSL/fetch_cert_info](https://api.docs.cpanel.net/specifications/cpanel.openapi/cpanel-account-ssl-management/fetch_cert_info.md): 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.

## Return SSL certificate information for all FQDN

 - [GET /SSL/fetch_certificates_for_fqdns](https://api.docs.cpanel.net/specifications/cpanel.openapi/cpanel-account-ssl-management/fetch_certificates_for_fqdns.md): This function retrieves the certificate information for all fully qualified domain names (FQDNs) that the account owns.

## Return private key and CA bundle

 - [POST /SSL/fetch_key_and_cabundle_for_certificate](https://api.docs.cpanel.net/specifications/cpanel.openapi/cpanel-account-ssl-management/fetch_key_and_cabundle_for_certificate.md): 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.

## Return SSL certificate for private key

 - [GET /SSL/find_certificates_for_key](https://api.docs.cpanel.net/specifications/cpanel.openapi/cpanel-account-ssl-management/find_certificates_for_key.md): 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.

## Return private key's certificate signing requests

 - [GET /SSL/find_csrs_for_key](https://api.docs.cpanel.net/specifications/cpanel.openapi/cpanel-account-ssl-management/find_csrs_for_key.md): 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.

## Return certificate's CA bundle and hostname

 - [GET /SSL/get_cabundle](https://api.docs.cpanel.net/specifications/cpanel.openapi/cpanel-account-ssl-management/get_cabundle.md): 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.

## Request best SSL domain for service

 - [GET /SSL/get_cn_name](https://api.docs.cpanel.net/specifications/cpanel.openapi/cpanel-account-ssl-management/get_cn_name.md): This function retrieves the most secure domain for a service.

## Return SSL certificate's info for dedicated IP

 - [GET /SSL/installed_host](https://api.docs.cpanel.net/specifications/cpanel.openapi/cpanel-account-ssl-management/installed_host.md): 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.

## Return domains with SSL certificate information

 - [GET /SSL/installed_hosts](https://api.docs.cpanel.net/specifications/cpanel.openapi/cpanel-account-ssl-management/installed_hosts.md): 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.

## Return all SSL certificates

 - [GET /SSL/list_certs](https://api.docs.cpanel.net/specifications/cpanel.openapi/cpanel-account-ssl-management/list_certs.md): 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.

## Return all certificate signing requests

 - [GET /SSL/list_csrs](https://api.docs.cpanel.net/specifications/cpanel.openapi/cpanel-account-ssl-management/list_csrs.md): 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.

## Return all private keys

 - [GET /SSL/list_keys](https://api.docs.cpanel.net/specifications/cpanel.openapi/cpanel-account-ssl-management/list_keys.md): 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.

## Return SSL-related items

 - [GET /SSL/list_ssl_items](https://api.docs.cpanel.net/specifications/cpanel.openapi/cpanel-account-ssl-management/list_ssl_items.md): 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.

## Start SSL database rebuild

 - [GET /SSL/rebuildssldb](https://api.docs.cpanel.net/specifications/cpanel.openapi/cpanel-account-ssl-management/rebuildssldb.md): This function rebuilds the account's SSL database.

## Update SSL TLS key type

 - [GET /SSL/set_default_key_type](https://api.docs.cpanel.net/specifications/cpanel.openapi/cpanel-account-ssl-management/ssl::set_default_key_type.md): This function sets a user’s preferred SSL/TLS key type.

## Enable or disable secure redirects

 - [GET /SSL/toggle_ssl_redirect_for_domains](https://api.docs.cpanel.net/specifications/cpanel.openapi/cpanel-account-ssl-management/toggle_ssl_redirect_for_domains.md): 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.

## Return whether shared SSL certificate exists (deprecated)

 - [GET /SSL/check_shared_cert](https://api.docs.cpanel.net/specifications/cpanel.openapi/cpanel-account-ssl-management/check_shared_cert.md): This function checks whether a shared SSL certificate is associated with the account.