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/get_autossl_excluded_domains
- A server running cPanel.
https://cpanel-server.tld:2083/execute/SSL/get_autossl_excluded_domains
- 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_autossl_excluded_domainsResponse
application/json
{ "apiversion": 3, "func": "get_autossl_excluded_domains", "module": "SSL", "result": { "data": [ … ], "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }
Request
This function retrieves a list of domains that possess AutoSSL problems.
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/get_autossl_problems
- A server running cPanel.
https://cpanel-server.tld:2083/execute/SSL/get_autossl_problems
- 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_autossl_problemsResponse
application/json
{ "apiversion": 3, "func": "get_autossl_problems", "module": "SSL", "result": { "data": [ … ], "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }
Request
This function verifies whether the autossl_check task is in progress for the current user.
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/is_autossl_check_in_progress
- A server running cPanel.
https://cpanel-server.tld:2083/execute/SSL/is_autossl_check_in_progress
- 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/is_autossl_check_in_progressResponse
application/json
{ "apiversion": 3, "func": "is_autossl_check_in_progress", "module": "SSL", "result": { "data": 1, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }