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/fetch_certificates_for_fqdns
- A server running cPanel.
https://cpanel-server.tld:2083/execute/SSL/fetch_certificates_for_fqdns
- 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/fetch_certificates_for_fqdns?domains=string'Response
application/json
{ "apiversion": 3, "func": "fetch_certificates_for_fqdns", "module": "SSL", "result": { "data": [ … ], "errors": null, "messages": null, "metadata": { … }, "status": 1, "warnings": null } }
Query
Bodymultipart/form-dataAn SSL certificate.
Example: certificate=-----BEGIN CERTIFICATE-----MIIDcTCCAlmgAwIBAgIFAU+BNVgwDQYJKoZIhvcNAQEFBQAwUTESMBAGA1UEAwwJc2lza28udGxkMQswCQYDVQQGEwJVUzEPMA0GA1UECgwGY1BhbmVsMQswCQYDVQQIDAJUWDEQMA4GA1UEBwwHSG91c3RvbjAeFw0xNDEwMDYyMjI2MTlaFw0xNTEwMDYyMjI2MTlaMFExEjAQBgNVBAMMCXNpc2tvLnRsZDELMAkGA1UEBhMCVVMxDzANBgNVBAoMBmNQYW5lbDELMAkGA1UECAwCVFgxEDAOBgNVBAcMB0hvdXN0b24wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC9zx6zGiHdmWA0dKtoXmJiWXpZ9E3PXx3YHsjFEWW7e5pH0vZ+jVMzDmm5nsJ7RXrAkZO1IvpIpVLvoQfiJOWVvkD+o9fWvoK1tWJS72FSgPju+58mA2ieBuc87A790Pzuv1P3NR3zFLAjUR99zkHR1fpri/daM3PBWO8ET48FWkyU1kOeZaUlF67/+wrEiNgg+t1qhKOCAB61PdNVkLaSGHimksuC+Czk8Kq9nuS0E0TCnDtjjEyJ455FUcaCfczlTb8xkB/F9ORe74yTzD+vlk0tFMG6PLj/ajIwWqwO0qmQ8wX3NRxkWgGz5kVO1wrVJarKQ5EYQ3/mgvit0v6dAgMBAAGjUDBOMB0GA1UdDgQWBBRw+wKBo34+bgexjAa3EMDsgSCd7zAfBgNVHSMEGDAWgBRw+wKBo34+bgexjAa3EMDsgSCd7zAMBgNVHRMEBTADAQH/MA0GCSqGSIb3DQEBBQUAA4IBAQCHRXIs53opzKM2rM8Qe8lcw524WK6hqy2EWrZHp78N7rU7/6DQ/I3hv3WhcDDIO04I2/Xhe88MLBaLoM367Ya+vy7CaLr14aLi/SfQszMA0ALBvMao+Fis0iVwFYq/NLgSXw+fgnpFskt8v8iQZ+4Kaal8U8e9sVgu8m0RgO7rzym1eRiIKpsKd1rh/SD7LbSN7M7TRL3QqF7ltw9sQhAAsQcRaBBF21pdWrqhiGZ+Eioo3hhgwNavH2agqz78ddHwrFpHFwrEeUk1OfpPb76MYIce7xIy/4oQNdg6fOq4l/FrajBv+WkzDVPaKm6r7YmwfLN/YMZBHXSR58oOGP9W-----END CERTIFICATE-----
The certificate's contents.
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/SSL/fetch_key_and_cabundle_for_certificate
- A server running cPanel.
https://cpanel-server.tld:2083/execute/SSL/fetch_key_and_cabundle_for_certificate
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
-u <username>:<password> \
'https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/SSL/fetch_key_and_cabundle_for_certificate?certificate=-----BEGIN+CERTIFICATE-----MIIDcTCCAlmgAwIBAgIFAU%2BBNVgwDQYJKoZIhvcNAQEFBQAwUTESMBAGA1UEAwwJc2lza28udGxkMQswCQYDVQQGEwJVUzEPMA0GA1UECgwGY1BhbmVsMQswCQYDVQQIDAJUWDEQMA4GA1UEBwwHSG91c3RvbjAeFw0xNDEwMDYyMjI2MTlaFw0xNTEwMDYyMjI2MTlaMFExEjAQBgNVBAMMCXNpc2tvLnRsZDELMAkGA1UEBhMCVVMxDzANBgNVBAoMBmNQYW5lbDELMAkGA1UECAwCVFgxEDAOBgNVBAcMB0hvdXN0b24wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC9zx6zGiHdmWA0dKtoXmJiWXpZ9E3PXx3YHsjFEWW7e5pH0vZ%2BjVMzDmm5nsJ7RXrAkZO1IvpIpVLvoQfiJOWVvkD%2Bo9fWvoK1tWJS72FSgPju%2B58mA2ieBuc87A790Pzuv1P3NR3zFLAjUR99zkHR1fpri%2FdaM3PBWO8ET48FWkyU1kOeZaUlF67%2F%2BwrEiNgg%2Bt1qhKOCAB61PdNVkLaSGHimksuC%2BCzk8Kq9nuS0E0TCnDtjjEyJ455FUcaCfczlTb8xkB%2FF9ORe74yTzD%2Bvlk0tFMG6PLj%2FajIwWqwO0qmQ8wX3NRxkWgGz5kVO1wrVJarKQ5EYQ3%2Fmgvit0v6dAgMBAAGjUDBOMB0GA1UdDgQWBBRw%2BwKBo34%2BbgexjAa3EMDsgSCd7zAfBgNVHSMEGDAWgBRw%2BwKBo34%2BbgexjAa3EMDsgSCd7zAMBgNVHRMEBTADAQH%2FMA0GCSqGSIb3DQEBBQUAA4IBAQCHRXIs53opzKM2rM8Qe8lcw524WK6hqy2EWrZHp78N7rU7%2F6DQ%2FI3hv3WhcDDIO04I2%2FXhe88MLBaLoM367Ya%2Bvy7CaLr14aLi%2FSfQszMA0ALBvMao%2BFis0iVwFYq%2FNLgSXw%2BfgnpFskt8v8iQZ%2B4Kaal8U8e9sVgu8m0RgO7rzym1eRiIKpsKd1rh%2FSD7LbSN7M7TRL3QqF7ltw9sQhAAsQcRaBBF21pdWrqhiGZ%2BEioo3hhgwNavH2agqz78ddHwrFpHFwrEeUk1OfpPb76MYIce7xIy%2F4oQNdg6fOq4l%2FFrajBv%2BWkzDVPaKm6r7YmwfLN%2FYMZBHXSR58oOGP9W-----END+CERTIFICATE-----' \
-H 'Content-Type: multipart/form-data' \
-F certificate=stringResponse
application/json
{ "apiversion": 3, "func": "fetch_key_and_cabundle_for_certificate", "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_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 } }