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 checks whether the Apache web server supports SNI.
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_sni_supported
- A server running cPanel.
https://cpanel-server.tld:2083/execute/SSL/is_sni_supported
- 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_sni_supportedResponse
application/json
{ "apiversion": 3, "func": "is_sni_supported", "module": "SSL", "result": { "data": 1, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }
Request
This function retrieves the status of the domain's SNI mail services.
Warning:
Mail SNI is not compatible with Webmail and will not function for any Webmail connection. Webmail connections use the cPanel service SSL certificate.
Note:
Mail SNI is always enabled.
- Functions that enable Mail SNI succeed with a warning that Mail SNI is always enabled.
- Functions that disable Mail SNI fail and make no changes.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/SSL/mail_sni_status
- A server running cPanel.
https://cpanel-server.tld:2083/execute/SSL/mail_sni_status
- 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/mail_sni_status?domain=example.com'Response
application/json
{ "apiversion": 3, "func": "mail_sni_status", "module": "SSL", "result": { "data": { … }, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }
Request
This function rebuilds the SNI configuration files.
Note:
- You must run this function after you change the SNI status through the UAPI's
enable_mail_sniordisable_mail_snifunctions. - Mail SNI is always enabled.
- Functions that enable Mail SNI succeed with a warning that Mail SNI is always enabled. Functions that disable Mail SNI fail and make no changes.
- Functions that disable Mail SNI will fail and make no changes.
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/rebuild_mail_sni_config
- A server running cPanel.
https://cpanel-server.tld:2083/execute/SSL/rebuild_mail_sni_config
- 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/rebuild_mail_sni_config?reload_dovecot=1'Response
application/json
{ "apiversion": 3, "func": "rebuild_mail_sni_config", "module": "SSL", "result": { "data": { … }, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }