WHM API.
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/
https://{host}:{port}/json-api/
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/get_autossl_problems_for_user
- A server running WHM.
https://whm-server.tld:2087/json-api/get_autossl_problems_for_user
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://api.docs.cpanel.net/_mock/specifications/whm.openapi/get_autossl_problems_for_user?username=username'{ "data": { "problems_by_domain": [ … ] }, "metadata": { "command": "get_autossl_problems_for_user", "reason": "OK", "result": 1, "version": 1 } }
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/get_best_ssldomain_for_service
- A server running WHM.
https://whm-server.tld:2087/json-api/get_best_ssldomain_for_service
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://api.docs.cpanel.net/_mock/specifications/whm.openapi/get_best_ssldomain_for_service?service=whostmgr'{ "data": { "cert_match_method": "none", "cert_valid_not_after": 1457452989, "is_currently_valid": 0, "is_self_signed": 1, "is_wild_card": 0, "ssldomain": "hostname.example.com", "ssldomain_matches_cert": 0 }, "metadata": { "command": "get_best_ssldomain_for_service", "reason": "OK", "result": 1, "version": 1 } }
The certificate to install.
Note:
You must URI-encode this value.
The certificate's key.
Note:
You must URI-encode this value.
The service on which to install the SSL certificate.
ftpeximdovecotcpanel
Important:
You must restart the selected service after you install a new SSL certificate.
The certificate's Certificate Authority (CA) bundle.
Note:
You must URI-encode this value.
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/install_service_ssl_certificate
- A server running WHM.
https://whm-server.tld:2087/json-api/install_service_ssl_certificate
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://api.docs.cpanel.net/_mock/specifications/whm.openapi/install_service_ssl_certificate?crt=-----BEGIN+CERTIFICATE-----%0AMIIE3f4g5h7j73f235gy54hvcNAQELBQAwgYYxEDAOBgNVBAcMB2hvd097342boi0w389w0BCQEWEmMubGFycnl8293rhqurpg9qfgm5ldDEOMAwGA1UECAwFdGV4YXMxCzAJBgNVBAYTAlVTMSEwHwYDVQQDDBhiaW5hcnlhZ2Fpbi5jcGFuZWwubmluamExDzANBgNVBAoMBmNwYW5lbDAeFw0yMDA1MTgxODQ3NTFaFw0yMTA1MTgxODQ3NTFaMIGGMRAwDgYDVQQHDAdob3VzdG9uMSEwHwYJKoZIhvcNAQkBFhJjLmxhcnJ5QGNwYW5lbC5uZXQxDjAMBgNVBAgMBXRleGFzMQswCQYDVQQGEwJVUzEhMB8GA1UEAwwYYmluYXJ5YWdhaW4uY3BhbmVsLm5pbmphMQ8wDQYDVQQKDAZjcGFuZWwwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC3i1fOlIUoURJf4BkMgoVvCeq5GZjzuCl6WXzz5WsADYUl84UzgXJIWtwBoTc2l32zyeWkIAkM%2FeNR12YMb0kXbgihbZtEsH0XimqcXmtiicoM3tjBi6u0cDEFr8TMdI396oArnnTc0CASfdXUGGtReZ6vOwxXOPPK5nYCvyFqBl1n0pQ2AV%2FCo9%2FWwhOCvV%2FBm9aTzueZrbYB%2F9uW31LOpjs%2B0s1QNGHv6PTvH8HZFW%2F7Z9M3gSwUxfOOOQHEiiHRWfb%2FUqcTZZxjZhfY%2FIN6%2FSOsc3Z2t2KmQ5XI6ijCrjjJeaZSQYsge8LpHskr8G3WeTV9M9%2B1YnI7GRqs3%2BGdAgMBAAGjggEsMIIBKDAdBgNVHQ4EFgQUYWWThQj2tRL5PNkdPhUJdqEIcrswCQYDVR0TBAIwADCBtwYDVR0jBIGvMIGsgBRhZZOFCPa1Evk82R0%2BFQl2oQhyu6GBjKSBiTCBhjEQMA4GA1UEBwwHaG91c3RvbjEhMB8GCSqGSIb3DQEJARYSYy5sYXJyeUBjcGFuZWwubmV0MQ4wDAYDVQQIDAV0ZXhhczELMAkGA1UEBhMCVVMxITAfBgNVBAMMGGJpbmFyeWFnYWluLmNwYW5lbC5uaW5qYTEPMA0GA1UECgwGY3BhbmVsggUCGG94JTAdBgNVHSUEFjAUBggrBgEFBQcDAQYIKwYBBQUHAwIwIwYDVR0RBBwwGoIYYmluYXJ5YWdhaW4uY3BhbmVsLm5pbmphMA0GCSqGSIb3DQEBCwUAA4IBAQBhKmds%2BXDTycHc2bsSH%2BzDkWIw58%2BJ26Re9Q9VnUcrSKtV3mmtW88r8FuEHEZdAOzFPTJ3Tdd1fha15wuS5dzOV%2BbCRrDTvJmD4vRPkQ5TSdyJgpIjpjwiOP1%2BZwaF7xZ%2BFLMTcEl8SXM%2BlkoKEUQpHFKyQ0zGIaLCVt0QyXx16lesPMgPeb%2FKRXJPy7ZrUtyF0z0LgvOSDGNsGt4rD8FVgtdHRlMJf%2FXIoFeV5Zk%2BrHNoCXIQXh4nBzM8X2r3IrQ1Qh0Z3njN2Ld8ZUlxsWctlLzvzmjARzIzvbglO3wod5XoRLS%2BfU6oVyQ9yuQLGG6r6Y7iBYSHfAO8e0pLkp7G%0A-----END+CERTIFICATE-----&key=-----BEGIN+RSA+PRIVATE+KEY-----%0AMIIEpQIBAAKCAQEA4FIdZcIKVK5%2BPtdzVm4CN45BXG5wX7KZ1%2FdP84MGIwtwxkkX%0AhBqw7BawbHlexYXuarSnrHA8hm6RRxv%2FfRy%2BzOeg7y8v5CWG52m91GK7qSLxpruY%0AgCJGJEK8fj6spbbLjxNd5XAmDwT80uMsq%2F3E9rGmg%2FELY9X9vn5WlErRfi2Qjsiq%0Ax7AYUvcIkBHPOlRWzZgx2KjMjBU2U0w2RCUjgKgww%2F6xx2ccnTvn7HGvVjQMkh%2B1%0AUYCdGvT8fR2qJBKHZ5Cjdfc9N304qZCqYMhcrHX2gJqc%2B9zLtLk7PoEYXu17l6nU%0AO3C%2FIdzBXYWu%2BUoMzpZ5tc5jKRA3%2BI7ggKjJlwIDAQABAoIBAQDR4GI648qQolXh%0A6%2Biws%2BqFGibTGU0wbET%2BSBjYx%2F0E6t5P1vEWm3Zu3WehhgkCm6WO1omOj9BBIs%2Fw%0ADSUEZNGrmwf64VZYijfm6gs%2B3EWiINyhWCF9uRORN5NuNquHvDhGHCOc2EnzgYIe%0AuYgBP0R6X4phJjS26u8mvMO6qSnKd4wRrOf9ZU73L1VTmhMItshVxH2tuhKurkMV%0AjWDAjWeJfycWe4JVgYxM4GA6g5kKi5nrkhpVEsklh1FJZn65U0aWXUpHAm2ihhKf%0AFq9FgC%2B8Xz8UAtf8JYbAW3D1E%2F0lRZuLt%2B5cosK8b2%2B9CIUNRjYMtyXlbI0RGwl9%0AFO%2F9sv05AoGBAP0jfp8qUqf4u4pkE1W2SzzbQ6oYKYHTMiORVHi2qysgrxAZFKGj%0AfW7c7UTpxlCaqqDBRQA%2BlZH16xVD3idwYvmw%2F9AKxSozxe3wKbQFRM%2BXYHc7la%2B2%0ATiQiJgjflEadSa57FNgBB7SpeEzaIfmGBYWJXkM%2B6wuaGUz5qZs%2FSFJNAoGBAOLb%0AOuh7CWTk5oISVBfqxnwFEpaMHT5vpzNBwUWUVMhrxNZP3OVSN%2B%2BqKxpJhCF%2FM2no%0AOdxX7CYkrGvHFTvV9WKpa0kYQGms%2BybyoMOYxJax8rV%2BZq9gg2QKwaakoJljaAlX%0A5yUuy32YhLxWodQhE7mlhAUyXIuNLVuYee0Y2ZVzAoGAaV6tBnQHlAPljOW7ZqJL%0ADzn2IIeOP4w6ArQsBVOETJ9%2BP6UxAVecjtlHqrfk5Qh8ng3VOxTSDb%2Ff6yok%2FyW5%0ADVawJVlWWQrUCQc%2FVMActIy%2BiuMym8G3JTNRwb%2FPaNVwJkD1nDRRkNI6UUM7gTJY%0Aeg2EP1mhXWL3xSLnhsgAwsECgYEAqnm2xfeXsqM0%2BbAOU77RE2e4dTuryjybeDBE%0AriXupIIf9DElvYrQkCDfrSxrx8RP%2FZlOyd%2BkjXFnxMJhmYqKkW7hOZeo6ADe54DT%0AAMmvidMFog%2Fv2ID9m9NdfP4f1cTW7JaLE%2B0bbDGOJf4wNDn7GbphAIq88v3PhRKL%0AJXpUIDMCgYEA2P7D%2FoZu%2BdEPW8JhUsDDXY238ZDbQzWBi6n1uUnMJCnUABd%2FmvuV%0AILR%2FiSBHmt9UdH2YECwry58xFjhXwfTvPc155PiJddjENGFUqohjl0wh0VzLEyfF%0AVb6iVMIdrycD%2FO4U26I3Qco2lQYPoPgrBkAGJ5%2FGCjkTiL0JssoMXa4%3D%0A-----END+RSA+PRIVATE+KEY-----&service=cpanel&cabundle=-----BEGIN+CERTIFICATE-----%0AMIIE3f4g5h7j73f235gy54hvcNAQELBQAwgYYxEDAOBgNVBAcMB2hvd097342boi0w389w0BCQEWEmMubGFycnl8293rhqurpg9qfgm5ldDEOMAwGA1UECAwFdGV4YXMxCzAJBgNVBAYTAlVTMSEwHwYDVQQDDBhiaW5hcnlhZ2Fpbi5jcGFuZWwubmluamExDzANBgNVBAoMBmNwYW5lbDAeFw0yMDA1MTgxODQ3NTFaFw0yMTA1MTgxODQ3NTFaMIGGMRAwDgYDVQQHDAdob3VzdG9uMSEwHwYJKoZIhvcNAQkBFhJjLmxhcnJ5QGNwYW5lbC5uZXQxDjAMBgNVBAgMBXRleGFzMQswCQYDVQQGEwJVUzEhMB8GA1UEAwwYYmluYXJ5YWdhaW4uY3BhbmVsLm5pbmphMQ8wDQYDVQQKDAZjcGFuZWwwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC3i1fOlIUoURJf4BkMgoVvCeq5GZjzuCl6WXzz5WsADYUl84UzgXJIWtwBoTc2l32zyeWkIAkM%2FeNR12YMb0kXbgihbZtEsH0XimqcXmtiicoM3tjBi6u0cDEFr8TMdI396oArnnTc0CASfdXUGGtReZ6vOwxXOPPK5nYCvyFqBl1n0pQ2AV%2FCo9%2FWwhOCvV%2FBm9aTzueZrbYB%2F9uW31LOpjs%2B0s1QNGHv6PTvH8HZFW%2F7Z9M3gSwUxfOOOQHEiiHRWfb%2FUqcTZZxjZhfY%2FIN6%2FSOsc3Z2t2KmQ5XI6ijCrjjJeaZSQYsge8LpHskr8G3WeTV9M9%2B1YnI7GRqs3%2BGdAgMBAAGjggEsMIIBKDAdBgNVHQ4EFgQUYWWThQj2tRL5PNkdPhUJdqEIcrswCQYDVR0TBAIwADCBtwYDVR0jBIGvMIGsgBRhZZOFCPa1Evk82R0%2BFQl2oQhyu6GBjKSBiTCBhjEQMA4GA1UEBwwHaG91c3RvbjEhMB8GCSqGSIb3DQEJARYSYy5sYXJyeUBjcGFuZWwubmV0MQ4wDAYDVQQIDAV0ZXhhczELMAkGA1UEBhMCVVMxITAfBgNVBAMMGGJpbmFyeWFnYWluLmNwYW5lbC5uaW5qYTEPMA0GA1UECgwGY3BhbmVsggUCGG94JTAdBgNVHSUEFjAUBggrBgEFBQcDAQYIKwYBBQUHAwIwIwYDVR0RBBwwGoIYYmluYXJ5YWdhaW4uY3BhbmVsLm5pbmphMA0GCSqGSIb3DQEBCwUAA4IBAQBhKmds%2BXDTycHc2bsSH%2BzDkWIw58%2BJ26Re9Q9VnUcrSKtV3mmtW88r8FuEHEZdAOzFPTJ3Tdd1fha15wuS5dzOV%2BbCRrDTvJmD4vRPkQ5TSdyJgpIjpjwiOP1%2BZwaF7xZ%2BFLMTcEl8SXM%2BlkoKEUQpHFKyQ0zGIaLCVt0QyXx16lesPMgPeb%2FKRXJPy7ZrUtyF0z0LgvOSDGNsGt4rD8FVgtdHRlMJf%2FXIoFeV5Zk%2BrHNoCXIQXh4nBzM8X2r3IrQ1Qh0Z3njN2Ld8ZUlxsWctlLzvzmjARzIzvbglO3wod5XoRLS%2BfU6oVyQ9yuQLGG6r6Y7iBYSHfAO8e0pLkp7G%0A-----END+CERTIFICATE-----'{ "data": { "certificate": "-----BEGIN CERTIFICATE-----\nMIIE3f4g5h7j73f235gy54hvcNAQELBQAwgYYxEDAOBgNVBAcM\nB2hvd097342boi0w389w0BCQEWEmMubGFycnl8293rhqurpg9qfgm5ldDEOMAwG\nA1UECAwFdGV4YXMxCzAJBgNVBAYTAlVTMSEwHwYDVQQDDBhiaW5hcnlhZ2Fpbi5j\ncGFuZWwubmluamExDzANBgNVBAoMBmNwYW5lbDAeFw0yMDA1MTgxODQ3NTFaFw0y\nMTA1MTgxODQ3NTFaMIGGMRAwDgYDVQQHDAdob3VzdG9uMSEwHwYJKoZIhvcNAQkB\nFhJjLmxhcnJ5QGNwYW5lbC5uZXQxDjAMBgNVBAgMBXRleGFzMQswCQYDVQQGEwJV\nUzEhMB8GA1UEAwwYYmluYXJ5YWdhaW4uY3BhbmVsLm5pbmphMQ8wDQYDVQQKDAZj\ncGFuZWwwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC3i1fOlIUoURJf\n4BkMgoVvCeq5GZjzuCl6WXzz5WsADYUl84UzgXJIWtwBoTc2l32zyeWkIAkM/eNR\n12YMb0kXbgihbZtEsH0XimqcXmtiicoM3tjBi6u0cDEFr8TMdI396oArnnTc0CAS\nfdXUGGtReZ6vOwxXOPPK5nYCvyFqBl1n0pQ2AV/Co9/WwhOCvV/Bm9aTzueZrbYB\n/9uW31LOpjs+0s1QNGHv6PTvH8HZFW/7Z9M3gSwUxfOOOQHEiiHRWfb/UqcTZZxj\nZhfY/IN6/SOsc3Z2t2KmQ5XI6ijCrjjJeaZSQYsge8LpHskr8G3WeTV9M9+1YnI7\nGRqs3+GdAgMBAAGjggEsMIIBKDAdBgNVHQ4EFgQUYWWThQj2tRL5PNkdPhUJdqEI\ncrswCQYDVR0TBAIwADCBtwYDVR0jBIGvMIGsgBRhZZOFCPa1Evk82R0+FQl2oQhy\nu6GBjKSBiTCBhjEQMA4GA1UEBwwHaG91c3RvbjEhMB8GCSqGSIb3DQEJARYSYy5s\nYXJyeUBjcGFuZWwubmV0MQ4wDAYDVQQIDAV0ZXhhczELMAkGA1UEBhMCVVMxITAf\nBgNVBAMMGGJpbmFyeWFnYWluLmNwYW5lbC5uaW5qYTEPMA0GA1UECgwGY3BhbmVs\nggUCGG94JTAdBgNVHSUEFjAUBggrBgEFBQcDAQYIKwYBBQUHAwIwIwYDVR0RBBww\nGoIYYmluYXJ5YWdhaW4uY3BhbmVsLm5pbmphMA0GCSqGSIb3DQEBCwUAA4IBAQBh\nKmds+XDTycHc2bsSH+zDkWIw58+J26Re9Q9VnUcrSKtV3mmtW88r8FuEHEZdAOzF\nPTJ3Tdd1fha15wuS5dzOV+bCRrDTvJmD4vRPkQ5TSdyJgpIjpjwiOP1+ZwaF7xZ+\nFLMTcEl8SXM+lkoKEUQpHFKyQ0zGIaLCVt0QyXx16lesPMgPeb/KRXJPy7ZrUtyF\n0z0LgvOSDGNsGt4rD8FVgtdHRlMJf/XIoFeV5Zk+rHNoCXIQXh4nBzM8X2r3IrQ1\nQh0Z3njN2Ld8ZUlxsWctlLzvzmjARzIzvbglO3wod5XoRLS+fU6oVyQ9yuQLGG6r\n6Y7iBYSHfAO8e0pLkp7G\n-----END CERTIFICATE-----", "certificate_info": { … }, "service": "cpanel", "service_description": "Calendar, cPanel, WebDisk, Webmail, and WHM Services" }, "metadata": { "command": "install_service_ssl_certificate", "reason": "OK", "result": 1, "version": 1 } }