# cPanel SSL API

**Canonical:** https://apis.io/apis/cpanel/cpanel-ssl-api/  
**Provider:** cPanel — https://apis.io/providers/cpanel/  
**Base URL:** https://{host}:2083/execute  
**Documentation:** https://api.docs.cpanel.net/cpanel/introduction/

cPanel SSL API is one of 144 APIs that [cPanel](https://apis.io/providers/cpanel/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include SSL. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

The SSL module for UAPI.

## Operations (60 of 84)

| Method | Path | Summary |
|---|---|---|
| GET | `/SSL/add_autossl_excluded_domains` | Disable AutoSSL for domains |
| GET | `/SSL/can_ssl_redirect` | Return whether domains can redirect to secure URL |
| GET | `/SSL/check_shared_cert` | Return whether shared SSL certificate exists |
| GET | `/SSL/delete_cert` | Delete SSL certificate |
| GET | `/SSL/delete_csr` | Delete certificate signing request |
| GET | `/SSL/delete_key` | Delete private key |
| GET | `/SSL/delete_ssl` | Remove SSL for domain |
| GET | `/SSL/disable_mail_sni` | Disable SNI mail services for domain |
| GET | `/SSL/enable_mail_sni` | Enable SNI mail services for domain |
| GET | `/SSL/fetch_best_for_domain` | Request best SSL certificate |
| GET | `/SSL/fetch_cert_info` | Return SSL certificate information |
| GET | `/SSL/fetch_certificates_for_fqdns` | Return SSL certificate information for all FQDN |
| POST | `/SSL/fetch_key_and_cabundle_for_certificate` | Return private key and CA bundle |
| GET | `/SSL/find_certificates_for_key` | Return SSL certificate for private key |
| GET | `/SSL/find_csrs_for_key` | Return private key's certificate signing requests |
| GET | `/SSL/generate_cert` | Create self-signed SSL certificate |
| GET | `/SSL/generate_csr` | Create certificate signing request |
| GET | `/SSL/generate_key` | Create private key |
| GET | `/SSL/get_autossl_excluded_domains` | Return AutoSSL disabled domains |
| GET | `/SSL/get_autossl_problems` | Return domains with AutoSSL problems |
| GET | `/SSL/get_autossl_renewal_status` | Return AutoSSL renewal status for a domain |
| GET | `/SSL/get_cabundle` | Return certificate's CA bundle and hostname |
| GET | `/SSL/get_cn_name` | Request best SSL domain for service |
| GET | `/SSL/install_ssl` | Install SSL certificate |
| GET | `/SSL/installed_host` | Return SSL certificate's info for dedicated IP |
| GET | `/SSL/installed_hosts` | Return domains with SSL certificate information |
| GET | `/SSL/is_autossl_check_in_progress` | Return whether AutoSSL check in progress |
| GET | `/SSL/is_mail_sni_supported` | Return whether mail SNI is enabled |
| GET | `/SSL/is_sni_supported` | Return whether Apache web server supports mail SNI |
| GET | `/SSL/list_certs` | Return all SSL certificates |
| GET | `/SSL/list_csrs` | Return all certificate signing requests |
| GET | `/SSL/list_keys` | Return all private keys |
| GET | `/SSL/list_ssl_items` | Return SSL-related items |
| GET | `/SSL/mail_sni_status` | Return status of domain's SNI mail services |
| GET | `/SSL/rebuild_mail_sni_config` | Start SNI configuration files rebuild |
| GET | `/SSL/rebuildssldb` | Start SSL database rebuild |
| GET | `/SSL/remove_autossl_excluded_domains` | Enable AutoSSL for specifed domains |
| GET | `/SSL/set_autossl_excluded_domains` | Disable AutoSSL for specifed domains |
| GET | `/SSL/set_cert_friendly_name` | Update SSL certificate's friendly name |
| GET | `/SSL/set_csr_friendly_name` | Update certificate signing request's friendly name |
| GET | `/SSL/set_default_key_type` | Update SSL TLS key type |
| GET | `/SSL/set_key_friendly_name` | Update private key's friendly name |
| GET | `/SSL/set_primary_ssl` | Update SSL website for dedicated IP address |
| GET | `/SSL/show_cert` | Export SSL certificate |
| GET | `/SSL/show_csr` | Export certificate signing request |
| GET | `/SSL/show_key` | Export private key |
| GET | `/SSL/start_autossl_check` | Start AutoSSL for current user |
| GET | `/SSL/toggle_ssl_redirect_for_domains` | Enable or disable secure redirects |
| POST | `/SSL/upload_cert` | Import SSL certificate |
| POST | `/SSL/upload_key` | Import private key |
| GET | `/add_autossl_user_excluded_domains` | Disable AutoSSL for domain |
| GET | `/delete_ssl_vhost` | Delete SSL vhost |
| GET | `/disable_autossl` | Disable AutoSSL |
| GET | `/enqueue_deferred_ssl_installations` | Add SSL certificate to installation queue |
| GET | `/fetch_service_ssl_components` | Return system services and associated certificates |
| GET | `/fetch_ssl_certificates_for_fqdns` | Return cPanel account FQDN certificate information |
| GET | `/fetch_ssl_vhosts` | Return server vhosts and SSL certificates |
| GET | `/fetch_vhost_ssl_components` | Return all SSL certificate components on vhost |
| GET | `/fetchcrtinfo` | Return SSL certificate information |
| GET | `/fetchsslinfo` | Return cPanel account SSL certificate information |

…and 24 more operations. They are listed in full on the page.

## Machine-readable artifacts (7)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/cpanel/refs/heads/main/openapi/cpanel-ssl-api-openapi.yml
- **Documentation** — https://api.docs.cpanel.net/cpanel/introduction/
- **APIReference** — https://api.docs.cpanel.net/specifications/cpanel.openapi
- **Authentication** — https://api.docs.cpanel.net/cpanel/tokens/
- **Documentation** — https://api.docs.cpanel.net/whm/introduction/
- **APIReference** — https://api.docs.cpanel.net/specifications/whm.openapi
- **Authentication** — https://api.docs.cpanel.net/whm/tokens/

## Other cPanel APIs (12)

- [cPanel API 2 (Legacy)](https://apis.io/apis/cpanel/cpanel-api-2/)
- [Manage2 API](https://apis.io/apis/cpanel/manage2/)
- [cPanel 360 Monitoring API](https://apis.io/apis/cpanel/cpanel-360-monitoring-api/)
- [cPanel Account Creation API](https://apis.io/apis/cpanel/cpanel-account-creation-api/)
- [cPanel Account Enhancements API](https://apis.io/apis/cpanel/cpanel-account-enhancements-api/)
- [cPanel Account Management API](https://apis.io/apis/cpanel/cpanel-account-management-api/)
- [cPanel Account Restoration API](https://apis.io/apis/cpanel/cpanel-account-restoration-api/)
- [cPanel Accounts API](https://apis.io/apis/cpanel/cpanel-accounts-api/)
- [cPanel Addon Domain API](https://apis.io/apis/cpanel/cpanel-addondomain-api/)
- [cPanel API Execution API](https://apis.io/apis/cpanel/cpanel-api-execution-api/)
- [cPanel Applications API](https://apis.io/apis/cpanel/cpanel-applications-api/)
- [cPanel Authentication API](https://apis.io/apis/cpanel/cpanel-authentication-api/)

## Tags

SSL

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/cpanel/cpanel-ssl-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/cpanel/.
