UAPI accesses the cPanel interface's features. Use this API to access and modify cPanel account data and settings.
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/
https://{host}:{port}/execute/
Request
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.
A comma-separated list of the domains for which to generate the certificate.
The key's ID.
The certificate's organization.
The certificate's state or locality name.
An email address to associate with the certificate.
A friendly name for the new certificate.
This parameter defaults to the domain name for which you generated the certificate.
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/SSL/generate_csr
- A server running cPanel.
https://cpanel-server.tld:2083/execute/SSL/generate_csr
- 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/cpanel.openapi/SSL/generate_csr?countryName=US&domains=string&key_id=example_com_cb497_a394d_1397249671_d1272da8f13a1fd837493a5ad1f0a0f3&localityName=Houston&organizationName=Organization&stateOrProvinceName=Texas&emailAddress=username%40example.com&friendly_name=TestCert&organizationalUnitName=Department'{ "apiversion": 3, "func": "generate_csr", "module": "SSL", "result": { "data": { … }, "errors": null, "messages": [ … ], "metadata": {}, "status": 1, "warnings": null } }
Request
This function generates a private key.
Important:
- You cannot call both the
keytypeandkeysizeparameters 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.
A friendly name for the new key.
This parameter defaults to the key's type, creation date, and creation time.
The key's type.
system— The system's default value.rsa-2048— 2,408-bit RSA.rsa-4096— 4,096-bit RSA.ecdsa-prime256v1— ECDSA prime256v1 ("P-256").ecdsa-secp384r1— ECDSA secp384r1 ("P-384").
This parameter defaults to the user's default SSL/TLS key type.
Note:
If you do not use this parameter, the system defaults to the keysize parameter's default value.
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/SSL/generate_key
- A server running cPanel.
https://cpanel-server.tld:2083/execute/SSL/generate_key
- 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/cpanel.openapi/SSL/generate_key?friendly_name=TestKey&keytype=rsa-2048&keysize=2048'{ "apiversion": 3, "func": "generate_key", "module": "SSL", "result": { "data": { … }, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }
Request
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.
The certificate to install.
Note:
You must URI-encode this value.
You can use a Perl command to URI-encode your SSL certificate for this parameter. For example, you can use the following string, where
CERT.FILEis the SSL certificate file:$(perl -MURI::Escape -ne 'print uri_escape($_);' CERT.FILE)
The certificate's key.
Note:
You must URI-encode this value.
You can use a Perl command to URI-encode your SSL certificate for this parameter. For example, you can use the following string, where
KEY.FILEis the SSL certificate file:$(perl -MURI::Escape -ne 'print uri_escape($_);' KEY.FILE)
The Certificate Authority (CA) bundle data, if the certificate requires it.
Note:
You must URI-encode this value.
You can use a Perl command to URI-encode your SSL certificate for this parameter. For example, you can use the following string, where
CABUNDLE.FILEis the SSL certificate file:$(perl -MURI::Escape -ne 'print uri_escape($_);' CABUNDLE.FILE)
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/SSL/install_ssl
- A server running cPanel.
https://cpanel-server.tld:2083/execute/SSL/install_ssl
- 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/cpanel.openapi/SSL/install_ssl?cert=-----BEGIN%2520CERTIFICATE-----%250AMIIEEzCCAvugAwIBAgIJALF%252FjFpw6p1bMA0GCSqGSIb3DQEBBQUAMIGfMRYwFAYD%250AVQQDEw10ZXN0c2ltb24uY29tMRYwFAYDVQQLEw1Eb2N1bWVudGF0aW9uMQswCQYD%250AVQQGEwJVUzEoMCYGCSqGSIb3DQEJARYZbGF1cmVuY2Uuc2ltb25AY3BhbmVsLm5l%250AdDEUMBIGA1UEChMLY1BhbmVsIEluYy4xDjAMBgNVBAgTBVRleGFzMRAwDgYDVQQH%250AEwdIb3VzdG9uMB4XDTEzMDUxNzE2MTMwN1oXDTE0MDUxNzE2MTMwN1owgZ8xFjAU%250ABgNVBAMTDXRlc3RzaW1vbi5jb20xFjAUBgNVBAsTDURvY3VtZW50YXRpb24xCzAJ%250ABgNVBAYTAlVTMSgwJgYJKoZIhvcNAQkBFhlsYXVyZW5jZS5zaW1vbkBjcGFuZWwu%250AbmV0MRQwEgYDVQQKEwtjUGFuZWwgSW5jLjEOMAwGA1UECBMFVGV4YXMxEDAOBgNV%250ABAcTB0hvdXN0b24wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDRO0AP%250AN5XtjDqkEyJ6ctfYqUtt9yUXyRuCETFjW6opNLSmZSHeF6L2aZka646lhj02CFyl%250AkzsNSxysN66tY%252BWZcTmvgPisJdQFpFvjroJZgDjYRV0QqokKdRy%252F5BU0%252BtHXoYpj%250A9JOQlbvEWxiGR3R80sL1ma4AfSE6Gv8M%252FPULTadan51eHaikXqjOXdPJQKuWP3g9%250AFnIuf38WRYwzGrre88qsZrpsMrADX5dotHWgqAf7Tap6xfA4CUAgQo9tldariuVi%250ABz%252BsRJ%252FSjgxnhw1HYWGttBuBZFhMpdHpPnTJ7DIFMd%252FFN5gG%252Ftah30SapWpo35Ux%250A3BpJcdUjtazy82K5AgMBAAGjUDBOMB0GA1UdDgQWBBQAlv7%252FtALOYb7zAXbYG2%252B9%250AAMI3xjAfBgNVHSMEGDAWgBQAlv7%252FtALOYb7zAXbYG2%252B9AMI3xjAMBgNVHRMEBTAD%250AAQH%252FMA0GCSqGSIb3DQEBBQUAA4IBAQCxzpe71Hc7Es0dqIN7bhIFYIIgcr6wxM6a%250Aa9d%252BQG%252BQPH0x0KAqV8EgUbZysvyxEF0bPxW3ZAr1Is1wk80PMuU3bToFFVbFFIIr%250AHRNfKLGvxiMXnZA1c6L4N0lowvXHgZxTTUXtDFLXyrcwrLsvUErEV7rbizuxqfPw%250AcaRtXn4uc%252Bt6HYuW7yWesBauCWnJNiKbjN%252FF%252BuCTurN3QMAeWf3ZJtsfkAgk8dyq%250AR%252F83a3kDtSPrpt%252BjX%252BqdjKEpRtQ5Qpm6XT2gCOQPgnfiUtOCH419pp922P%252FAAGc%252B%250AZUhYoWcRWKw%252Fy6gI7Ru%252B%252B9%252B8%252BwkadL9EbKMZxhVwD5qVm4ZlWK2a%255Cr%255Cn%250A-----END%2520CERTIFICATE-----&domain=example.com&key=-----BEGIN%2520RSA%2520PRIVATE%2520KEY-----%250AMIIEpAIBAAKCAQEA4AVM6J4Qg3DIFWr%252FeJ5GRmIATYsJIepKbrDy70sq%252BudcO8R8%250Axxak0oMZ%252F9mUdpjSNK%252FfLVTuCO0kxTfQ9VUWJllX7ThD6Zh9ZvlC%252Fnf%252FOEZLm3Zb%250ABgu8rbC8E9wuDOkKbJLnINgdhtowIydLK2MJ%252B%252Bq62bFV89jkHWTMcKyyqHENo3h%250Ac%252Blkpd9vnp8rZTinaVb7nX26uQqAFZYRo%252BWU0G%252FNPsq40QVSMoqPxyEz4qXo0hvu%250AIlCXmzFZq%252F6fCVPEKPLhQgMmpdBkMz4dVOazREfqXdjMD2%252BQXSNiA1AwWr8l0r4r%250AtzlxEYDJIR41yXp0xMl3KoolxMyvLBqZy32niQIDAQABAoIBAQCmbGmhWmPsMeoC%250At1WJFxQgD4goE0U6k%252BKt7vjbOt14Pk6v%252FB2yjaju1wSGpO59WLS4%252FXrwI2se6IXr%250Amba7u3VUEgWXLriNHoLy7%252FSMNTs%252BZEKhAMG36eNe3tVdT7busTag31r6sEMGGwCs%250AIwpU%252Bazosk0oylWLEX%252Fm%252FuHWEs1eaIEWWWtgHB%252BKZrrP7Rr9RYfVQ144DxmOxS3C%250Aa9%252BmST62WqAVPR6POWGEfZqnZl%252FePWZPcQYbFrhwnnefNoYBl%252FbnLZBo8rbNWxAq%250AOEOuKfkrBzglKG%252F39WKPw8rj4JIVzY0yOuFCW6xCDWRkOrhU8Ol%252F3FvwDa3uJpkp%250AmgPr4TgxAoGBAPGPLmxSuOYR97mDAXxrs037F2GCbqWvI6m7%252FezWe9yn%252BbMpjSIW%250Afsgtq4FsyqzPueEkDdQWi3xh6nu2WI%252F1Tl875opGAqEIJMqss%252Fu11tnva5wzu1cC%250AL6H85A5%252BHMOBvP3sm6CObKcVw92h7kxynVIUJJWhjfeZMN8gBFFpKIVFAoGBAO1p%250AtXBmXLC%252FYKKvtHI3M16%252FZopvM8ZqU2HcAHaw214Refw9JJ%252Fe3%252FxTNfSerVTyCAQO%250A1AdWTzJKBN8jmSYv1Mk1D3RpQPNR7wVzi46KR081AU41uMpqIGVOwHtyVnW%252FZfLr%250Ac1DLIK8Cx8aHfoxffwzoMO5SEQSooeZfOLhsfDN1AoGBAKQTUEINsj%252B75psgbAr6%250AELGgItJ9yPBLVRr%252BcUzEpx9LDWVvjMihpP4NX1gq8EOPWT%252BewLHVmmsjCyV6xw8J%250AXXF8e2xif3in0m3D%252FwCzE7u2T06rKM3B017hKnrZmGoHnrqPU2osM4sOUpshWX6d%250Av1Q4EF1%252BfbK3YCW%252BVpCBsB9NAoGAQo%252BuhNLODee56iKkzpjXWCsFTq6ar3hD5F3P%250A63buKdNwhd2GlSPhXFbf%252B7M5GWW6BZk6rMvv7EOAVice2uvyFm8%252F4%252F1WbmF8R%252BT7%250ALX1rPLO5p%252Fm701QpvP11TabiwqRkqtSEQhSRF0AKTojSW%252FyyHCZFAawUhV%252FZ9EKi%250AHmKb97kCgYAyzmFc2it0HqnsOnRybop603nqMtWGTQO4cxa93HUDpYajuK2K3Dfr%250AxUj6lG3z%252FoKJGGE2JqgZ6LBAhNJtJWJu2ox3pKGE63QjLJnVwb8y1NFYpe%252FcrbLe%250APuBwIR0L7drXxfv7O5btY7h6QI2d1%252FUIAQPAWbxLoTM%252BndQ%252FuPEdfA%253D%253D%250A-----END%2520RSA%2520PRIVATE%2520KEY-----&cabundle=-----BEGIN%2520CERTIFICATE-----%250AMIIB%252BjCCAWMCAgGjMA0GCSqGSIb3DQEBBAUAMEUxCzAJBgNVBAYTAlVTMRgwFgYD%250AVQQKEw9HVEUgQ29ycG9yYXRpb24xHDAaBgNVBAMTE0dURSBDeWJlclRydXN0IFJv%250Ab3QwHhcNOTYwMjIzMjMwMTAwWhcNMDYwMjIzMjM1OTAwWjBFMQswCQYDVQQGEwJV%250AUzEYMBYGA1UEChMPR1RFIENvcnBvcmF0aW9uMRwwGgYDVQQDExNHVEUgQ3liZXJU%250AcnVzdCBSb290MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC45k%252B625h8cXyv%250ARLfTD0bZZOWTwUKOx7pJjTUteueLveUFMVnGsS8KDPufpz%252BiCWaEVh43KRuH6X4M%250AypqfpX%252F1FZSj1aJGgthoTNE3FQZor734sLPwKfWVWgkWYXcKIiXUT0Wqx73llt%252F5%250A1KiOQswkwB6RJ0q1bQaAYznEol44AwIDAQABMA0GCSqGSIb3DQEBBAUAA4GBABKz%250AdcZfHeFhVYAA1IFLezEPI2PnPfMD%252BfQ2qLvZ46WXTeorKeDWanOB5sCJo9Px4KWl%250AIjeaY8JIILTbcuPI9tl8vrGvU9oUtCG41tWW4%252F5ODFlitppK%252BULdjG%252BBqXH%252F9Apy%250AbW1EDp3zdHSo1TRJ6V6e6bR64eVaH4QwnNOfpSXY%250A-----END%2520CERTIFICATE-----'{ "apiversion": 3, "func": "install_ssl", "module": "SSL", "result": { "data": { … }, "errors": null, "messages": null, "metadata": { … }, "status": 1, "warnings": null } }