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 deletes an SSL certificate.
Note:
- When you call this function, you must include the
idor thefriendly_nameparameter. - This function only deletes certificates from SSL storage. To end SSL coverage for a domain, use the UAPI
SSL::delete_sslfunction instead.
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/delete_cert
- A server running cPanel.
https://cpanel-server.tld:2083/execute/SSL/delete_cert
- 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/delete_cert?friendly_name=TestCert&id=example_com_cb497_a394d_1397249671_d1272da8f13a1fd837493a5ad1f0a0f3'Response
application/json
{ "apiversion": 3, "func": "delete_cert", "module": "SSL", "result": { "data": [ … ], "errors": null, "messages": null, "metadata": { … }, "status": 1, "warnings": null } }
Request
This function deletes a certificate signing request (CSR).
Note:
- When you call this function, you must include the
idor thefriendly_nameparameter. - To delete a private key, use the UAPI
SSL::delete_keyfunction instead.
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/delete_csr
- A server running cPanel.
https://cpanel-server.tld:2083/execute/SSL/delete_csr
- 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/delete_csr?friendly_name=TestCSR&id=example_com_e095f_0ab2f_ebcbe4a571276f48562241411556647f'Response
application/json
{ "apiversion": 3, "func": "delete_csr", "module": "SSL", "result": { "data": [ … ], "errors": null, "messages": null, "metadata": { … }, "status": 1, "warnings": null } }
Request
This function deletes a private key.
Note:
- When you call this function, you must include the
idor thefriendly_nameparameter. - To delete a certificate signing request (CSR), use the UAPI
SSL::delete_csrfunction instead.
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/delete_key
- A server running cPanel.
https://cpanel-server.tld:2083/execute/SSL/delete_key
- 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/delete_key?friendly_name=TestKey&id=example_com_e095f_0ab2f_ebcbe4a571276f48562241411556647f'Response
application/json
{ "apiversion": 3, "func": "delete_key", "module": "SSL", "result": { "data": [ … ], "errors": null, "messages": null, "metadata": { … }, "status": 1, "warnings": null } }