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 lists SSL-related items on a domain.
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_ssl_items
- A server running cPanel.
https://cpanel-server.tld:2083/execute/SSL/list_ssl_items
- 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_ssl_items?domains=string&item=key'Response
application/json
{ "apiversion": 3, "func": "list_ssl_items", "module": "SSL", "result": { "data": [ … ], "errors": null, "messages": null, "metadata": { … }, "status": 1, "warnings": null } }
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/SSL/rebuildssldb
- A server running cPanel.
https://cpanel-server.tld:2083/execute/SSL/rebuildssldb
- 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/rebuildssldbResponse
application/json
{ "apiversion": 3, "func": "rebuildssldb", "module": "SSL", "result": { "data": null, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }
Query
The key type to set.
system— Use the system’sssl_default_key_typevalue.rsa-2048— 2,048-bit RSA.rsa-4096— 4,096-bit RSA.ecdsa-prime256v1— ECDSA prime256v1 (“P-256”).ecdsa-secp384r1— ECDSA secp384r1 (“P-384”).
Enum"system""rsa-2048""rsa-4096""ecdsa-prime256v1""ecdsa-secp384r1"
Example: type=ecdsa-prime256v1
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/SSL/set_default_key_type
- A server running cPanel.
https://cpanel-server.tld:2083/execute/SSL/set_default_key_type
- 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/set_default_key_type?type=ecdsa-prime256v1'Response
application/json
{ "apiversion": 3, "func": "set_default_key_type", "module": "SSL", "result": { "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }