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 disables SNI mail services on the specified domains.
Note:
Mail SNI is always enabled.
- After you change the SNI status, you must run UAPI's
rebuild_mail_sni_configfunction. - 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/disable_mail_sni
- A server running cPanel.
https://cpanel-server.tld:2083/execute/SSL/disable_mail_sni
- 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/disable_mail_sni?domains=example.com%2Cexample1.com%2Cexample2.com'Response
application/json
{ "apiversion": 3, "func": "disable_mail_sni", "module": "SSL", "result": { "data": { … }, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }
Request
This function enables SNI mail services on the specified domains.
Warning:
Mail SNI is always enabled.
- Mail SNI is not compatible with Webmail and will not function for any Webmail connection. Webmail connections use the cPanel service SSL certificate.
- 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.
Important:
When you disable the Calendars and Contacts, Mail Receive, 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/enable_mail_sni
- A server running cPanel.
https://cpanel-server.tld:2083/execute/SSL/enable_mail_sni
- 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/enable_mail_sni?domains=example.com%2Cexample1.com%2Cexample2.com'Response
application/json
{ "apiversion": 3, "func": "enable_mail_sni", "module": "SSL", "result": { "data": { … }, "errors": null, "messages": [ … ], "metadata": {}, "status": 1, "warnings": null } }
Request
This function checks whether the sslinstall feature is enabled.
Warning:
Mail SNI is always enabled.
- Mail SNI is not compatible with Webmail and will not function for any Webmail connection. Webmail connections use the cPanel service SSL certificate.
- Functions that enable Mail SNI succeed with a warning that Mail SNI is always enabled.
- 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/is_mail_sni_supported
- A server running cPanel.
https://cpanel-server.tld:2083/execute/SSL/is_mail_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_mail_sni_supportedResponse
application/json
{ "apiversion": 3, "func": "is_mail_sni_supported", "module": "SSL", "result": { "data": 1, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }