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 changes a key's friendly name.
Important:
- You must call either the
friendly_nameoridparameter. - 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/set_key_friendly_name
- A server running cPanel.
https://cpanel-server.tld:2083/execute/SSL/set_key_friendly_name
- CLI
- URL
- curl
- JavaScript
- Node.js
- Python
- Java
- Java8+Apache
- C#
- C#+Newtonsoft
- PHP
- Go
- Ruby
- R
uapi --output=jsonpretty \
--user=username \
SSL \
set_key_friendly_name \
friendly_name='TestKey' \
id='a9b72_63971_2cb6d8897b362cfb1548e047d8428b8d' \
new_friendly_name='TestKey2'Response
application/json
{ "apiversion": 3, "func": "set_key_friendly_name", "module": "SSL", "result": { "data": null, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }
Request
This function sets a new primary SSL website for a dedicated IP address.
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/set_primary_ssl
- A server running cPanel.
https://cpanel-server.tld:2083/execute/SSL/set_primary_ssl
- CLI
- URL
- curl
- JavaScript
- Node.js
- Python
- Java
- Java8+Apache
- C#
- C#+Newtonsoft
- PHP
- Go
- Ruby
- R
uapi --output=jsonpretty \
--user=username \
SSL \
set_primary_ssl \
servername='hostname.example.com'Response
application/json
{ "apiversion": 3, "func": "set_primary_ssl", "module": "SSL", "result": { "data": null, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }
Request
This function retrieves a certificate.
Note:
When you call this parameter, you must include either the id or the friendly_name parameter.
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/show_cert
- A server running cPanel.
https://cpanel-server.tld:2083/execute/SSL/show_cert
- CLI
- URL
- curl
- JavaScript
- Node.js
- Python
- Java
- Java8+Apache
- C#
- C#+Newtonsoft
- PHP
- Go
- Ruby
- R
uapi --output=jsonpretty \
--user=username \
SSL \
show_certResponse
application/json
{ "apiversion": 3, "func": "show_cert", "module": "SSL", "result": { "data": { … }, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }