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/
Request
This function retrieves information about a certificate that is installed on a domain's dedicated IP address.
Important:
- If you do not possess a dedicated IP address, this function will fail. For non-dedicated IP addresses, use the
SSL::installed_hostsfunction. - When you disable the Calendars and Contacts, Receive Mail, Web Disk , Webmail , and Web Server roles, the system disables this function.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/SSL/installed_host
- A server running cPanel.
https://cpanel-server.tld:2083/execute/SSL/installed_host
- 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/installed_host?domain=example.com&verify_certificate=1'Response
application/json
{ "apiversion": 3, "func": "installed_host", "module": "SSL", "result": { "data": { … }, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }
Request
This function retrieves a list of the account's websites, their domains, and certificate information.
Important:
For a dedicated IP address, use the UAPI SSL::installed_host function.
Important:
When you disable the CalendarContact , MailReceive , WebDisk , Webmail , and WebServer roles, the system disables this function.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/SSL/installed_hosts
- A server running cPanel.
https://cpanel-server.tld:2083/execute/SSL/installed_hosts
- 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/installed_hostsResponse
application/json
{ "apiversion": 3, "func": "installed_hosts", "module": "SSL", "result": { "data": [ … ], "errors": null, "messages": null, "metadata": { … }, "status": 1, "warnings": null } }
Request
This function lists an account's certificates.
Important:
When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system disables this function.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/SSL/list_certs
- A server running cPanel.
https://cpanel-server.tld:2083/execute/SSL/list_certs
- 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/list_certsResponse
application/json
{ "apiversion": 3, "func": "list_certs", "module": "SSL", "result": { "data": [ … ], "errors": null, "messages": null, "metadata": { … }, "status": 1, "warnings": null } }