UAPI accesses the cPanel interface's features. Use this API to access and modify cPanel account data and settings.
Download OpenAPI description
Overview
URL
WebPros International, LLC
License
Languages
Servers
Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/
A server running cPanel.
https://{host}:{port}/execute/
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/SSL/find_certificates_for_key
- A server running cPanel.
https://cpanel-server.tld:2083/execute/SSL/find_certificates_for_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/find_certificates_for_key?friendly_name=TestKey&id=example_com_cb497_a394d_1397249671_d1272da8f13a1fd837493a5ad1f0a0f3'Response
application/json
{ "apiversion": 3, "func": "find_certificates_for_key", "module": "SSL", "result": { "data": [ … ], "errors": null, "messages": null, "metadata": { … }, "status": 1, "warnings": null } }
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/SSL/find_csrs_for_key
- A server running cPanel.
https://cpanel-server.tld:2083/execute/SSL/find_csrs_for_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/find_csrs_for_key?friendly_name=TestKey&id=example_com_cb497_a394d_1397249671_d1272da8f13a1fd837493a5ad1f0a0f3'Response
application/json
{ "apiversion": 3, "func": "find_csrs_for_key", "module": "SSL", "result": { "data": [ … ], "errors": null, "messages": null, "metadata": { … }, "status": 1, "warnings": null } }
Request
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.
Security
BasicAuth
Query
The certificate's text.
Example: cert=-----BEGIN CERTIFICATE-----\r\nMIIDcTCCAlmgAwIBAgIFAU+BNVgwDQYJKoZIhvcNAQEFBQAwUTESMBAGA1UEAwwJ\r\nc2lza28udGxkMQswCQYDVQQGEwJVUzEPMA0GA1UECgwGY1BhbmVsMQswCQYDVQQI\r\nDAJUWDEQMA4GA1UEBwwHSG91c3RvbjAeFw0xNDEwMDYyMjI2MTlaFw0xNTEwMDYy\r\nMjI2MTlaMFExEjAQBgNVBAMMCXNpc2tvLnRsZDELMAkGA1UEBhMCVVMxDzANBgNV\r\nBAoMBmNQYW5lbDELMAkGA1UECAwCVFgxEDAOBgNVBAcMB0hvdXN0b24wggEiMA0G\r\nCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC9zx6zGiHdmWA0dKtoXmJiWXpZ9E3P\r\nXx3YHsjFEWW7e5pH0vZ+jVMzDmm5nsJ7RXrAkZO1IvpIpVLvoQfiJOWVvkD+o9fW\r\nvoK1tWJS72FSgPju+58mA2ieBuc87A790Pzuv1P3NR3zFLAjUR99zkHR1fpri/da\r\nM3PBWO8ET48FWkyU1kOeZaUlF67/+wrEiNgg+t1qhKOCAB61PdNVkLaSGHimksuC\r\n+Czk8Kq9nuS0E0TCnDtjjEyJ455FUcaCfczlTb8xkB/F9ORe74yTzD+vlk0tFMG6\r\nPLj/ajIwWqwO0qmQ8wX3NRxkWgGz5kVO1wrVJarKQ5EYQ3/mgvit0v6dAgMBAAGj\r\nUDBOMB0GA1UdDgQWBBRw+wKBo34+bgexjAa3EMDsgSCd7zAfBgNVHSMEGDAWgBRw\r\n+wKBo34+bgexjAa3EMDsgSCd7zAMBgNVHRMEBTADAQH/MA0GCSqGSIb3DQEBBQUA\r\nA4IBAQCHRXIs53opzKM2rM8Qe8lcw524WK6hqy2EWrZHp78N7rU7/6DQ/I3hv3Wh\r\ncDDIO04I2/Xhe88MLBaLoM367Ya+vy7CaLr14aLi/SfQszMA0ALBvMao+Fis0iVw\r\nFYq/NLgSXw+fgnpFskt8v8iQZ+4Kaal8U8e9sVgu8m0RgO7rzym1eRiIKpsKd1rh\r\n/SD7LbSN7M7TRL3QqF7ltw9sQhAAsQcRaBBF21pdWrqhiGZ+Eioo3hhgwNavH2ag\r\nqz78ddHwrFpHFwrEeUk1OfpPb76MYIce7xIy/4oQNdg6fOq4l/FrajBv+WkzDVPa\r\nKm6r7YmwfLN/YMZBHXSR58oOGP9W\r\n-----END CERTIFICATE-----
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/SSL/get_cabundle
- A server running cPanel.
https://cpanel-server.tld:2083/execute/SSL/get_cabundle
- 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/get_cabundle?cert=-----BEGIN+CERTIFICATE-----%5Cr%5CnMIIDcTCCAlmgAwIBAgIFAU%2BBNVgwDQYJKoZIhvcNAQEFBQAwUTESMBAGA1UEAwwJ%5Cr%5Cnc2lza28udGxkMQswCQYDVQQGEwJVUzEPMA0GA1UECgwGY1BhbmVsMQswCQYDVQQI%5Cr%5CnDAJUWDEQMA4GA1UEBwwHSG91c3RvbjAeFw0xNDEwMDYyMjI2MTlaFw0xNTEwMDYy%5Cr%5CnMjI2MTlaMFExEjAQBgNVBAMMCXNpc2tvLnRsZDELMAkGA1UEBhMCVVMxDzANBgNV%5Cr%5CnBAoMBmNQYW5lbDELMAkGA1UECAwCVFgxEDAOBgNVBAcMB0hvdXN0b24wggEiMA0G%5Cr%5CnCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC9zx6zGiHdmWA0dKtoXmJiWXpZ9E3P%5Cr%5CnXx3YHsjFEWW7e5pH0vZ%2BjVMzDmm5nsJ7RXrAkZO1IvpIpVLvoQfiJOWVvkD%2Bo9fW%5Cr%5CnvoK1tWJS72FSgPju%2B58mA2ieBuc87A790Pzuv1P3NR3zFLAjUR99zkHR1fpri%2Fda%5Cr%5CnM3PBWO8ET48FWkyU1kOeZaUlF67%2F%2BwrEiNgg%2Bt1qhKOCAB61PdNVkLaSGHimksuC%5Cr%5Cn%2BCzk8Kq9nuS0E0TCnDtjjEyJ455FUcaCfczlTb8xkB%2FF9ORe74yTzD%2Bvlk0tFMG6%5Cr%5CnPLj%2FajIwWqwO0qmQ8wX3NRxkWgGz5kVO1wrVJarKQ5EYQ3%2Fmgvit0v6dAgMBAAGj%5Cr%5CnUDBOMB0GA1UdDgQWBBRw%2BwKBo34%2BbgexjAa3EMDsgSCd7zAfBgNVHSMEGDAWgBRw%5Cr%5Cn%2BwKBo34%2BbgexjAa3EMDsgSCd7zAMBgNVHRMEBTADAQH%2FMA0GCSqGSIb3DQEBBQUA%5Cr%5CnA4IBAQCHRXIs53opzKM2rM8Qe8lcw524WK6hqy2EWrZHp78N7rU7%2F6DQ%2FI3hv3Wh%5Cr%5CncDDIO04I2%2FXhe88MLBaLoM367Ya%2Bvy7CaLr14aLi%2FSfQszMA0ALBvMao%2BFis0iVw%5Cr%5CnFYq%2FNLgSXw%2BfgnpFskt8v8iQZ%2B4Kaal8U8e9sVgu8m0RgO7rzym1eRiIKpsKd1rh%5Cr%5Cn%2FSD7LbSN7M7TRL3QqF7ltw9sQhAAsQcRaBBF21pdWrqhiGZ%2BEioo3hhgwNavH2ag%5Cr%5Cnqz78ddHwrFpHFwrEeUk1OfpPb76MYIce7xIy%2F4oQNdg6fOq4l%2FFrajBv%2BWkzDVPa%5Cr%5CnKm6r7YmwfLN%2FYMZBHXSR58oOGP9W%5Cr%5Cn-----END+CERTIFICATE-----'Response
application/json
{ "apiversion": 3, "func": "get_cabundle", "module": "SSL", "result": { "data": { … }, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }